InsertTextBefore (XmlNode function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:XmlNode:InsertTextBefore subtitle}} | {{Template:XmlNode:InsertTextBefore subtitle}} | ||
<var>InsertTextBefore</var> inserts a | <var>InsertTextBefore</var> inserts a [[XmlDoc API#XmlDoc node types|Text node]] as the immediate sibling preceding the method <var>XmlNode</var>. | ||
==Syntax== | ==Syntax== | ||
{{Template:XmlNode:InsertTextBefore syntax}} | {{Template:XmlNode:InsertTextBefore syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%outNod</th> | <tr><th nowrap>%outNod</th> | ||
<td>If specified, an <var>XmlNode</var> that is set to point to the <var>Text</var> node that is inserted. </td></tr> | <td>If specified, an <var>XmlNode</var> that is set to point to the <var>Text</var> node that is inserted. </td></tr> | ||
<tr><th>nod</th> | <tr><th>nod</th> | ||
<td><var>XmlNode</var> that points to the node before which the <var>Text</var> node is inserted. The node may be any type except <var>Root</var> or <var>Text</var>.</td></tr> | <td><var>XmlNode</var> that points to the node before which the <var>Text</var> node is inserted. The node may be any type except <var>Root</var> or <var>Text</var>.</td></tr> | ||
<tr><th>value</th> | <tr><th>value</th> | ||
<td>The content of the <var>Text</var> node. This <var>Unicode</var> string value is stored without any normalization, entity substitution, etc.</td></tr> | <td>The content of the <var>Text</var> node. This <var>Unicode</var> string value is stored without any normalization, entity substitution, etc.</td></tr> | ||
| Line 16: | Line 19: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If <var class="term">value</var> is the null string, a <var>Text</var> node is not inserted, and <var class="term">% | <li>If <var class="term">value</var> is the null string, a <var>Text</var> node is not inserted, and <var class="term">%outNod</var> is set to <var>Null</var>. | ||
<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, <var class="term">value</var> may include only non-null EBCDIC characters that translate to | <li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, <var class="term">value</var> may include only non-null EBCDIC characters that translate to Unicode. As of <var class="product">Sirius Mods</var> Version 7.6, all <var class="product">[[Janus SOAP]]</var> string arguments and results are Unicode or are converted to Unicode. For more information about the effects of this version 7.6 change, see [[XmlDoc API#Strings and Unicode with the XmlDoc API|"Strings and Unicode with the XmlDoc API"]]. | ||
<li>Since the return value of <var>InsertTextBefore</var> is frequently not needed, you may want to <var>[[Notation_conventions_for_methods#Callable_methods|Call]]</var> it instead of saving its return value. | <li>Since the return value of <var>InsertTextBefore</var> is frequently not needed, you may want to <var>[[Notation_conventions_for_methods#Callable_methods|Call]]</var> it instead of saving its return value. | ||
<li>To modify the value stored in an <var>Text</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Text</var> node. | <li>To modify the value stored in an <var>Text</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Text</var> node. | ||
| Line 25: | Line 28: | ||
==Examples== | ==Examples== | ||
In the following example, a <var>Text</var> node is inserted before node "b" (that is, as its immediately preceding sibling): | In the following example, a <var>Text</var> node is inserted before node "b" (that is, as its immediately preceding sibling): | ||
<p class="code">begin | <p class="code">begin | ||
| Line 48: | Line 50: | ||
</a> | </a> | ||
</top> | </top> | ||
</p | </p> | ||
==Request- | ==Request-cancellation errors== | ||
This list is not exhaustive: it does <i>not</i> include all the errors that are request cancelling. | |||
<ul> | <ul> | ||
<li><var class="term"> | <li>The <var class="term">nod</var> object is the <var>Root</var> node. | ||
<li><var class="term"> | |||
<li><var class="term"> | <li><var class="term">nod</var> is a <var>Text</var> node, or the sibling following a <var>Text</var> node, and the <var>[[AdjacentText (XmlDoc property)|AdjacentText]]</var> property setting is <code>Disallow</code>. | ||
<li><var class="term"> | |||
<li><var class="term">nod</var> is a child of the <var>Root</var> node. | |||
<li>The <var class="term">value</var> argument violates the rules for XML Element content (that is, it contains an invalid character). Note that as of <var class="product">Sirius Mods</var> Version 7.6, this check can no longer be bypassed using the <var>InvalidChar</var> method — see the <var>InvalidChar</var> [[InvalidChar (XmlDoc property)#Usage notes|"Usage notes"]]. | |||
<li>Insufficient free space exists in CCATEMP. | <li>Insufficient free space exists in CCATEMP. | ||
</ul> | </ul> | ||
Latest revision as of 21:19, 2 September 2015
Insert Text node before this node (XmlNode class)
[Requires Janus SOAP]
InsertTextBefore inserts a Text node as the immediate sibling preceding the method XmlNode.
Syntax
[%outNod =] nod:InsertTextBefore( value)
Syntax terms
| %outNod | If specified, an XmlNode that is set to point to the Text node that is inserted. |
|---|---|
| nod | XmlNode that points to the node before which the Text node is inserted. The node may be any type except Root or Text. |
| value | The content of the Text node. This Unicode string value is stored without any normalization, entity substitution, etc. |
Usage notes
- If value is the null string, a Text node is not inserted, and %outNod is set to Null.
- 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 InsertTextBefore 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).
- A Text node may not be inserted adjacent to (that is, as a sibling of) another Text node, unless the AdjacentText property setting is
Combine.
Examples
In the following example, a Text node is inserted before node "b" (that is, as its immediately preceding sibling):
begin %doc is object xmlDoc %doc = new %doc:loadXml('<top><a><c/><b>05</b></a></top>') %n1 is object xmlNode %n2 is object xmlNode %ls is longstring %ls = 'Text node never contains the null string' %n1 = %doc:selectSingleNode('top/a/b') %n2 = %n1:InsertTextBefore(%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> <c/> Text node never contains the null string <b>05</b> </a> </top>
Request-cancellation errors
This list is not exhaustive: it does not include all the errors that are request cancelling.
- The nod object is the Root node.
- nod is a Text node, or the sibling following a Text node, and the AdjacentText property setting is
Disallow. - nod is a child of the Root node.
- 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 method — see the InvalidChar "Usage notes".
- Insufficient free space exists in CCATEMP.
See also
- AddText also adds a Text node. InsertTextBefore adds a Text as the immediately preceding sibling of the node pointed to by the method object. AddText adds a Text as the last child of the node pointed to by the method object.