Type (XmlDoc/XmlNode function): Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
m (→See also) |
||
Line 47: | Line 47: | ||
{{Template:XmlDoc/XmlNode:Type footer}} | {{Template:XmlDoc/XmlNode:Type footer}} | ||
<ul> | <ul> | ||
<li>For more information about using XPath expressions, see [[XPath]]. | <li>For more information about using XPath expressions, see [[XPath|"XPath"]]. | ||
</ul> | </ul> |
Revision as of 16:51, 3 March 2011
Type of selected node (XmlDoc and XmlNode classes)
This function gets the type of node of the head of the argument XPath result.
Syntax
%xmlNodeType = nr:Type[( [xpath])] Throws XPathError
Syntax terms
%xmlNodeType | A declared enumeration object of type XmlNodeType to contain the returned value of Type. These values are listed in "Usage Notes," below. |
---|---|
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 | A Unicode string that is an XPath expression that results in a nodelist. The head of the nodelist is the node to process. This is an optional argument whose default is a period (.), that is, the node referenced by the method object (nr). Prior to Sirius Mods version 7.6, this argument is an EBCDIC string. |
Usage notes
The Type function returns an XmlNodeType enumeration value, which may be one of the following. For more information about enumerations, see Enumerations.
- Attribute
- Comment
- Element
- PI (which stands for Processing Instruction)
- Root
- Text
Example
The following example displays
the string value of the type of the node pointed to by %nod
:
Print %nod:Type:ToString
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".