SelectCount (XmlDoc/XmlNode function): Difference between revisions
Jump to navigation
Jump to search
m (xpath expression) |
m (edits, tags and links) |
||
Line 1: | Line 1: | ||
{{Template:XmlDoc/XmlNode:SelectCount subtitle}} | {{Template:XmlDoc/XmlNode:SelectCount subtitle}} | ||
<var>SelectCount</var> counts the number of nodes selected by an <var>[[XPath#XPath_syntax|Xpath expression]]</var>. | |||
==Syntax== | ==Syntax== | ||
{{Template:XmlDoc/XmlNode:SelectCount syntax}} | {{Template:XmlDoc/XmlNode:SelectCount syntax}} | ||
Line 7: | Line 7: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th> | <tr><th>%number</th> | ||
<td>A numeric variable | <td>A numeric variable that receives the count of nodes on the <var>XmlNodelist</var> selected by the <var class="term">xpath</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 <var>Root</var> 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>[[XPath#XPath_syntax|Xpath expression]]</var> that results in a nodelist. The count of nodes in this nodelist is returned. | <td>A <var>Unicode</var> string that is an <var>[[XPath#XPath_syntax|Xpath expression]]</var> that results in a <var>nodelist</var>. The count of nodes in this <var>nodelist</var> is returned. | ||
<p>Prior to <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr> | |||
Prior to | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If the result of the argument XPath expression (< | <li>If the result of the argument <var>XPath</var> expression (<var class="term">XPath</var>) is empty, numeric zero is returned. | ||
zero is returned. | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
< | <ol> | ||
<li>In the following example, <var>SelectCount</var> counts the "a" node | <li>In the following example, <var>SelectCount</var> counts the "a" node children of node "top," then the text node children of those "a" nodes: | ||
children of node "top," then the text node children of | <p class="code">begin | ||
those "a" nodes: | %doc is object XmlDoc | ||
<p class="code"> | %j is float | ||
%doc is | %k is float | ||
%j is | %doc = new | ||
%k is | %doc:[[LoadXml_(XmlDoc/XmlNode_function)|loadXml]]('<top> <a>a1</a> <a>a2</a> <a>a3</a> </top>') | ||
%doc = | [[Notation_conventions_for_methods#Callable_methods|Call]] %doc:print('/') | ||
%doc: | %j = %doc:selectCount('/top/a') | ||
Call %doc: | %k = %doc:selectCount('/top/a/text()') | ||
%j = %doc: | print %j ' and ' %k | ||
%k = %doc: | end | ||
</p> | </p> | ||
The example results follow: | The example results follow: | ||
<p class="code"><top> | <p class="code"><top> | ||
Line 49: | Line 43: | ||
3 and 3 | 3 and 3 | ||
</p> | </p> | ||
<li>The following | <li>The following statements count all the nodes and all the attributes in the document, respectively. | ||
statements count all the nodes | <p class="code">print 'Count of non-attribute nodes:' and %doc:countSelected('//node()') | ||
and all the attributes in the document, respectively. | print 'Count of attribute nodes:' and %doc:countSelected('//@*') | ||
<p class="code"> | |||
</p> | </p> | ||
</ | </ol> | ||
==Request-Cancellation Errors== | ==Request-Cancellation Errors== | ||
<ul> | <ul> | ||
<li>< | <li><var class="term">XPath</var> is invalid. | ||
<li>Insufficient free space exists in CCATEMP. | <li>Insufficient free space exists in CCATEMP. | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
<ul> | <ul> | ||
<li>[[ | <li><var>[[Count_(XmlNodelist_function)|count]]</var> counts the number of nodes on an <var>XmlNodelist</var>. | ||
<li>For more information about using XPath expressions, see [[XPath]]. | <li>For more information about using XPath expressions, see [[XPath]]. | ||
</ul> | </ul> | ||
{{Template:XmlDoc/XmlNode:SelectCount footer}} |
Revision as of 09:52, 22 May 2011
Number of selected nodes (XmlDoc and XmlNode classes)
SelectCount counts the number of nodes selected by an Xpath expression.
Syntax
%number = nr:SelectCount( xpath) Throws XPathError
Syntax terms
%number | A numeric variable that receives the count of nodes on the XmlNodelist selected by the xpath. |
---|---|
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 count of nodes in this nodelist is returned.
Prior to "Sirius Mods" Version 7.6, this is an EBCDIC string. |
Usage notes
- If the result of the argument XPath expression (XPath) is empty, numeric zero is returned.
Examples
- In the following example, SelectCount counts the "a" node children of node "top," then the text node children of those "a" nodes:
begin %doc is object XmlDoc %j is float %k is float %doc = new %doc:loadXml('<top> <a>a1</a> <a>a2</a> <a>a3</a> </top>') Call %doc:print('/') %j = %doc:selectCount('/top/a') %k = %doc:selectCount('/top/a/text()') print %j ' and ' %k end
The example results follow:
<top> <a>a1</a> <a>a2</a> <a>a3</a> </top> 3 and 3
- The following statements count all the nodes and all the attributes in the document, respectively.
print 'Count of non-attribute nodes:' and %doc:countSelected('//node()') print 'Count of attribute nodes:' and %doc:countSelected('//@*')
Request-Cancellation Errors
- XPath is invalid.
- Insufficient free space exists in CCATEMP.
See also
- count counts the number of nodes on an XmlNodelist.
- For more information about using XPath expressions, see XPath.