QName (XmlDoc/XmlNode function): Difference between revisions
Jump to navigation
Jump to search
m (xpath expression) |
mNo edit summary |
||
| Line 11: | Line 11: | ||
<td>A <var>Unicode</var> string variable for the returned name. </td></tr> | <td>A <var>Unicode</var> string variable for the returned name. </td></tr> | ||
<tr><th>nr</th> | <tr><th>nr</th> | ||
<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the Root node is the context node. </td></tr> | <td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node. </td></tr> | ||
<tr><th>xpath</th> | <tr><th>xpath</th> | ||
<td>An | <td>An [[XPath#XPath_syntax|XPath expression]] that results in a nodelist, the head of which is the node to process. An optional argument, its default is a period (<tt>.</tt>), that is, the node referenced by the method object (<var class="term">nr</var>).</td></tr> | ||
</table> | </table> | ||
| Line 22: | Line 22: | ||
<li>The element-type or attribute name prefix and colon, if there is one, followed | <li>The element-type or attribute name prefix and colon, if there is one, followed | ||
by the local name, | by the local name, | ||
if the node is an Element or Attribute, respectively. | if the node is an <var>Element</var> or <var>Attribute</var>, respectively. | ||
<li>The processing instruction's target, if the node is a PI. | <li>The processing instruction's target, if the node is a <var>PI</var>. | ||
<li>Other node types will return the null string. | <li>Other node types will return the null string. | ||
</ul> | </ul> | ||
<li>This function may be used with any value of the | <li>This function may be used with any value of the | ||
<var>XmlDoc</var>'s Namespace property. | <var>XmlDoc</var>'s <var>[[Namespace (XmlDoc property)|Namespace]]</var> property. | ||
<li>As of | <li>As of <var class="product">Sirius Mods</var> version 7.3, the <var>QName</var> method argument may | ||
include only non-null EBCDIC characters that translate to <var>Unicode</var>. | include only non-null EBCDIC characters that translate to <var>Unicode</var>. | ||
As of | As of <var class="product">Sirius Mods</var> version 7.6, all <var class="product">[[Janus SOAP]]</var> string arguments and results are <var>Unicode</var> | ||
or are converted to <var>Unicode</var>. | or are converted to <var>Unicode</var>. | ||
For more information about the effects of this version 7.6 | For more information about the effects of this version 7.6 | ||
change, see [[Strings and Unicode]]. | change, see [[XmlDoc API#Strings and Unicode with the XmlDoc API|"Strings and Unicode with the XmlDoc API"]]. | ||
</ul> | </ul> | ||
| Line 58: | Line 58: | ||
===Request-Cancellation Errors=== | ===Request-Cancellation Errors=== | ||
<ul> | <ul> | ||
<li>< | <li><var class="term">xpath</var> is invalid. | ||
<li>Result of (< | <li>Result of (<var class="term">xpath</var>) is empty. | ||
<li>Insufficient free space exists in CCATEMP. | <li>Insufficient free space exists in CCATEMP. | ||
</ul> | </ul> | ||
| Line 67: | Line 67: | ||
{{Template:XmlDoc/XmlNode:QName footer}} | {{Template:XmlDoc/XmlNode:QName footer}} | ||
<ul> | <ul> | ||
<li>For more information about using XPath expressions, see [[XPath]]. | <li>For more information about using XPath expressions, see [[XPath|"XPath"]]. | ||
<li>These methods also obtain information about the name of a node: | <li>These methods also obtain information about the name of a node: | ||
<ul> | <ul> | ||
<li>[[LocalName (XmlDoc/XmlNode function)|LocalName]] | <li><var>[[LocalName (XmlDoc/XmlNode function)|LocalName]]</var> | ||
<li>[[Prefix (XmlDoc/XmlNode function)|Prefix]] | <li><var>[[Prefix (XmlDoc/XmlNode function)|Prefix]]</var> | ||
<li>[[URI (XmlDoc/XmlNode function)|URI]] | <li><var>[[URI (XmlDoc/XmlNode function)|URI]]</var> | ||
</ul> | </ul> | ||
</ul> | </ul> | ||
Revision as of 00:13, 24 May 2011
Name (with prefix, if any) of selected node (XmlDoc and XmlNode classes)
This function gets the "fully qualified name" (that is, the
entire name as it was specified)
of the node that is the head of an XPath result.
Syntax
%unicode = nr:QName[( [xpath])] Throws XPathError
Syntax terms
| %unicode | A Unicode string variable for the returned name. |
|---|---|
| nr | An XmlDoc or XmlNode, used as the context node for the xpath expression. If an XmlDoc, the Root node is the context node. |
| xpath | An XPath expression that results in a nodelist, the head of which is the node to process. An optional argument, its default is a period (.), that is, the node referenced by the method object (nr). |
Usage notes
- The fully qualified name is defined to be:
- The element-type or attribute name prefix and colon, if there is one, followed by the local name, if the node is an Element or Attribute, respectively.
- The processing instruction's target, if the node is a PI.
- Other node types will return the null string.
- This function may be used with any value of the XmlDoc's Namespace property.
- As of Sirius Mods version 7.3, the QName method argument may include only non-null EBCDIC characters that translate to Unicode. As of Sirius Mods version 7.6, all Janus SOAP string arguments and results are Unicode or are converted to Unicode. For more information about the effects of this version 7.6 change, see "Strings and Unicode with the XmlDoc API".
Example
In the following example, the entire names of both elements are printed:
Begin %d Object XmlDoc %d = New %n1 Object XmlNode %n2 Object XmlNode %n1 = %d:AddElement('foo:bar', , 'ftp:here') Print %n1:QName %n1 = %n1:AddElement('junk') Print %n1:QName End
The example result follows:
foo:bar junk
Request-Cancellation Errors
- xpath is invalid.
- Result of (xpath) is empty.
- Insufficient free space exists in CCATEMP.