View source for Length (XmlDoc/XmlNode function)

{{Template:XmlDoc/XmlNode:Length subtitle}}
<var>Length</var> returns the length of the string-value of a node including its <var>Text</var> descendants.

==Syntax==
{{Template:XmlDoc/XmlNode:Length syntax}}

===Syntax terms===
<table class="syntaxTable">
<tr><th nowrap>%number</th>
<td>A numeric variable to contain the returned value from <var>Length</var>.</td></tr>

<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> argument expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node.</td></tr>

<tr><th>xpath</th>
<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax|XPath expression]] that results in a nodelist. The head of the nodelist is the node to process. Any other nodes in the nodelist are ignored.
<p>
This is an optional argument, and its 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|Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>
</table>

==Examples==
The following example displays the value <code>13</code>:
<p class="code">begin
   %d object xmlDoc
   %d = new
   %d:[[LoadXml_(XmlDoc/XmlNode_function)|loadXml]]<nowiki>('<t><a>Hell</a>' with -
      '<b>o, world!</b></t>')</nowiki>
   print %d:length('/t')
end
</p>

==Request-cancellation errors==
This list is not exhaustive: it does <i>not</i> include all the errors that are request  cancelling.
<ul>
<li>The <var class="term">xpath</var> expression is invalid.
<li>Result of <var class="term">xpath</var> is empty.
<li>Insufficient free space exists in CCATEMP.
</ul>

==See also==
<ul>
<li><var>[[Value (XmlDoc/XmlNode property)|Value]]</var> discusses the '''string-value''' of various node types.</li>

<li>For more information about using XPath expressions, see [[XPath]].</li>
</ul>

{{Template:XmlDoc/XmlNode:Length footer}}