AddText (XmlNode function)

From m204wiki
Jump to navigation Jump to search

Add Text child to Element node (XmlNode class)

[Requires Janus SOAP]

The AddText callable function adds a Text node as the last child of the method Element node.


[%outNod =] nod:AddText( value)

Syntax terms

%outNod If specified, an XmlNode that is set to point to the Text node that is added.
nod An XmlNode that points to the Element node parent of the inserted Text node.
value The content of the Text node. This Unicode string value is stored without any normalization, entity substitution, etc. Prior to Sirius Mods Version 7.6, this is an EBCDIC string.

Usage notes

  • If value is the null string, a Text node is not inserted, and %outNod is set to Null.
  • A Text node may not be added adjacent to (that is, as a sibling of) another Text node, unless the AdjacentText property setting is Combine.
  • As of Sirius Mods Version 7.3, value may include only non-null EBCDIC characters that translate to Unicode. As of Sirius Mods Version 7.6, all Janus SOAP string arguments and results 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".
  • Since the return value of AddText is frequently not needed, you may want to Call it instead of saving its return value.
  • To modify the value stored in an Text node, change the Value property of an XmlNode that points to the Text node.
  • Processing of an XmlDoc is likely to be more efficient if you add nodes in document order (that is, top-to-bottom, left-to-right).


In the following example, a Text node is added as the last child (that is, located after element "b") of element "a":

begin %doc is object xmlDoc %doc = new %doc:loadXml('<top><a><b>05</b></a></top>') %n1 is object xmlNode %n2 is object xmlNode %ls is longstring %ls ='In general, use Longstring %variables where'- with ' you might use String Len 255 %variables.' %n1 = %doc:selectSingleNode('top/a') %n2 = %n1:addText(%ls) %doc:print('top') end

The example result follows. Note that this XML document structure (element "a" having "mixed content", both an Element and Text child) is common to document usage with XML. But it is unusual for data usage with XML (in fact, the SOAP standard disallows mixed content):

<top> <a> <b>05</b> In general, use Longstring %variables where you might use STRING LEN 255 %variables. </a> </top>

Request-cancellation errors

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

  • The nod argument does not point to an Element node.
  • nod points to an Element node whose last child is a Text node, and the AdjacentText property setting is Disallow.
  • The value argument violates the rules for XML Element content (that is, it contains an invalid character). Note that as of Sirius Mods Version 7.6, this check can no longer be bypassed using the InvalidChar property.
  • Insufficient free space exists in CCATEMP.

See also

  • InsertTextBefore also adds a Text node. AddText adds a Text as the last child of the node pointed to by the method object; InsertTextBefore adds a Text node as the immediately preceding sibling of the node pointed to by the method object.