ValueDefault (XmlDoc/XmlNode function)

From m204wiki
Jump to navigation Jump to search

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.


%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. Any other nodes in the nodelist are ignored.

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.

value A Unicode string expression to use as the result of ValueDefault if the result of xpath is an 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 result and string arguments 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.


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

This list is not exhaustive: it does not include all the errors that are request cancelling.

  • xpath expression 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.