ValueDefault (XmlDoc/XmlNode function): Difference between revisions
mNo edit summary |
m (xpath expression) |
||
| Line 1: | Line 1: | ||
{{Template:XmlDoc/XmlNode:ValueDefault subtitle}} | {{Template:XmlDoc/XmlNode:ValueDefault subtitle}} | ||
<var>ValueDefault</var> obtains a substring of the string-value of a node, including its <var>Text</var> descendants. <var>ValueDefault</var> provides an optional argument to use as a return value if the <var>[[XPath]]</var> | <var>ValueDefault</var> obtains a substring of the string-value of a node, including its <var>Text</var> descendants. <var>ValueDefault</var> provides an optional argument to use as a return value if the <var>[[XPath#XPath_syntax|Xpath expression]]</var> that designates the node to process is empty. | ||
==Syntax== | ==Syntax== | ||
| Line 11: | Line 11: | ||
<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> | <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]]</var> | <td>A <var>Unicode</var> string that is an <var>[[XPath#XPath_syntax|Xpath expression]]</var> that results in a <var>nodelist</var>. The head of the <var>nodelist</var> is the <var>node</var> to process. | ||
<p>This is an optional argument whose default is a period (<code>.</code>), that is, the <var>node</var> 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 (<code>.</code>), that is, the <var>node</var> 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> | ||
<tr><th>value</th> | <tr><th>value</th> | ||
Revision as of 09:26, 22 May 2011
String-value of selected node (allow empty XPath) (XmlDoc and XmlNode classes)
ValueDefault obtains a substring of the string-value of a node, including its Text descendants. ValueDefault provides an optional argument to use as a return value if the Xpath expression that designates the node to process is empty.
Syntax
%unicode = nr:ValueDefault[( [xpath], [value])] Throws XPathError
Syntax terms
| %unicode | A Unicode string variable for the returned substring or for the default value. Prior to "Sirius Mods" Version 7.6, this is an EBCDIC string. |
|---|---|
| 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 ( |
| value | A Unicode string expression to use as the result of ValueDefault if the result of xpath is the empty nodelist. An optional argument, its default is the null string. Prior to "Sirius Mods" Version 7.6, this argument is an EBCDIC string. |
Usage notes
- As of "Sirius Mods" Version 7.3, the ValueDefault string arguments and result may include only non-null EBCDIC characters that translate to Unicode.
As of "Sirius Mods" Version 7.6, these strings are Unicode or are converted to Unicode. For more information about the effects of this Version 7.6 change, see "Strings and Unicode with the XmlDoc API".
Examples
- The following example displays the default string, a single underscore ( _ ) character:
begin %d object xmlDoc %d = new %d:loadXml('<t>Test</t>') print %d:valueDefault('/x', '_') end
Request-Cancellation Errors
- XPath is invalid.
- Insufficient free space exists in CCATEMP.
See also
- Value discusses the string-value of various node types.
- For more information about using XPath expressions, see XPath.