QName (XmlDoc/XmlNode function): Difference between revisions
Jump to navigation
Jump to search
m (move footer template to actual end; edits, tags and links) |
mNo edit summary |
||
| Line 11: | Line 11: | ||
<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> | <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 [[XPath#XPath_syntax|XPath expression]] that results in a | <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 27: | Line 27: | ||
==Example== | ==Example== | ||
In the following example, the entire names of both elements are printed: | |||
<p class="code">begin | <p class="code">begin | ||
%d object xmlDoc | %d object xmlDoc | ||
| Line 42: | Line 42: | ||
<p class="output">foo:bar | <p class="output">foo:bar | ||
junk | junk | ||
</p | </p> | ||
==Request- | ==Request-cancellation errors== | ||
<ul> | <ul> | ||
<li><var class="term">xpath</var> is invalid. | <li><var class="term">xpath</var> is invalid. | ||
Revision as of 15:32, 6 June 2011
Name (with prefix, if any) of selected node (XmlDoc and XmlNode classes)
QName returns 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:qQName 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.
See also
- For more information about using XPath expressions, see "XPath".
- These methods also obtain information about the name of a node: