QName (XmlDoc/XmlNode function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:XmlDoc/XmlNode:QName subtitle}} | |||
[[Category:XmlDoc methods|QName function]] | [[Category:XmlDoc methods|QName function]] | ||
[[Category:XmlNode methods|QName function]] | [[Category:XmlNode methods|QName function]] | ||
| Line 7: | Line 7: | ||
<!--DPL?? Category:XmlDoc API methods|QName (XmlDoc/XmlNode function): Name (with prefix, if any) of selected node--> | <!--DPL?? Category:XmlDoc API methods|QName (XmlDoc/XmlNode function): Name (with prefix, if any) of selected node--> | ||
<!--DPL?? Category:System methods|QName (XmlDoc/XmlNode function): Name (with prefix, if any) of selected node--> | <!--DPL?? Category:System methods|QName (XmlDoc/XmlNode function): Name (with prefix, if any) of selected node--> | ||
This function gets the | This function gets the "fully qualified name" (that is, the | ||
entire name as it was specified) | entire name as it was specified) | ||
of the node that is the head of an XPath result. | of the node that is the head of an XPath result. | ||
==Syntax== | |||
{{Template:XmlDoc/XmlNode:QName syntax}} | |||
===Syntax terms=== | |||
<dl> | <dl> | ||
<dt>%name | <dt>%name | ||
| Line 32: | Line 29: | ||
</dl> | </dl> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li>The fully qualified name is defined to be: | <li>The fully qualified name is defined to be: | ||
| Line 82: | Line 79: | ||
==See also== | |||
{{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]]. | ||
Revision as of 05:27, 25 January 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
- %name
- 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 which 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.
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.