Type (XmlDoc/XmlNode function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 8: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%xmlNodeType</th> | <tr><th>%xmlNodeType</th> | ||
<td>A declared enumeration object of type <var>XmlNodeType</var> to contain the returned value of <var>Type</var> | <td>A declared enumeration object of type <var>XmlNodeType</var> (see below) to contain the returned value of <var>Type</var>. </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 Root node is the context node. </td></tr> | ||
<tr><th>xpath</th> | <tr><th>xpath</th> | ||
<td>A <var>Unicode</var> string that is an <var class="term">xpath</var> expression that results in a <var class="term">modelist</var>. The head of the <var class="term">modelist</var> is the <var class="term">mode</var> to process. | <td>A <var>Unicode</var> string that is an <var class="term">xpath</var> expression that results in a <var class="term">modelist</var>. The head of the <var class="term">modelist</var> is the <var class="term">mode</var> to process. | ||
<p>This is an optional argument whose default is a period (.), that is, the node referenced by the method object (<var class="term">nr</var>). Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this argument is an EBCDIC string.</p></td></tr> | <p>This is an optional argument whose default is a period (<tt>.</tt>), that is, the node referenced by the method object (<var class="term">nr</var>). Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this argument is an EBCDIC string.</p></td></tr> | ||
</table> | </table> | ||
<h3>XmlNodeType enumeration</h3> | |||
< | <var>Type</var> returns an <var>XmlNodeType</var> [[Enumerations|enumeration]] value, which may be one of the following: | ||
<ul><li><var>Attribute</var> | <ul><li><var>Attribute</var> | ||
<li><var>Comment</var> | <li><var>Comment</var> | ||
| Line 25: | Line 25: | ||
<li><var>Text</var> | <li><var>Text</var> | ||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
| Line 34: | Line 33: | ||
==Request-Cancellation Errors== | ==Request-Cancellation Errors== | ||
<ul> | <ul> | ||
<li><var class="term"> | <li><var class="term">xpath</var> expression 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> | ||
Revision as of 16:37, 18 May 2011
Type of selected node (XmlDoc and XmlNode classes)
Type returns 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 (see below) to contain the returned value of Type. |
|---|---|
| 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 modelist. The head of the modelist is the mode 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. |
XmlNodeType enumeration
Type returns an XmlNodeType enumeration value, which may be one of the following:
- Attribute
- Comment
- Element
- PI (which stands for Processing Instruction)
- Root
- Text
Examples
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 expression is invalid.
- Result of xpath is empty.
- Insufficient free space exists in CCATEMP.
See also
- For more information about using XPath expressions, see "XPath".