AddPI (XmlDoc/XmlNode function): Difference between revisions
Jump to navigation
Jump to search
m (move footer template to actual end (otherwise subsequent intervening text gets omitted); edits, tags and links) |
|||
| (9 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:XmlDoc/XmlNode:AddPI subtitle}} | {{Template:XmlDoc/XmlNode:AddPI subtitle}} | ||
The <var>AddPI</var> callable function adds a PI (Processing Instruction) node as the last child of the <var>Root</var> node or <var>Element</var> node referenced by the method object. | The <var>AddPI</var> [[Notation conventions for methods#Callable functions|callable]] function adds a [[XmlDoc API#XmlDoc node types|PI (Processing Instruction) node]] as the last child of the <var>Root</var> node or <var>Element</var> node referenced by the method object. | ||
==Syntax== | ==Syntax== | ||
{{Template:XmlDoc/XmlNode:AddPI syntax}} | {{Template:XmlDoc/XmlNode:AddPI syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%nod</th> | <tr><th nowrap>%nod</th> | ||
<td>If specified, an <var>XmlNode</var> that is set to point to the PI node that is added.</td></tr> | <td>If specified, an <var>XmlNode</var> that is set to point to the <var>PI</var> node that is added.</td></tr> | ||
<tr><th>nr</th> | <tr><th>nr</th> | ||
<td>An <var>XmlDoc</var> or <var>XmlNode</var> that refers to the <var>Root</var> or <var>Element</var> node that is the parent of the added PI node.</td></tr> | <td>An <var>XmlDoc</var> or <var>XmlNode</var> that refers to the <var>Root</var> or <var>Element</var> node that is the parent of the added <var>PI</var> node.</td></tr> | ||
<tr><th>name</th> | <tr><th>name</th> | ||
<td>A <var>Unicode</var> string that is the target of the added PI node; this can be thought of as the "name" of the PI. It must conform to the XML syntax rules for a PI target; the maximum length of the name is 127 characters | <td>A <var>Unicode</var> string that is the target of the added <var>PI</var> node; this can be thought of as the "name" of the <var>PI</var>. It must conform to the XML syntax rules for a PI target; the maximum length of the name is 300 characters (127 characters prior to version 7.9, and 100 characters prior to version 7.7).</td></tr> | ||
<tr><th>value</th> | <tr><th>value</th> | ||
<td>A <var>Unicode</var> string that is the value of the added PI node; stored exactly as is, that is, without whitespace normalization.</td></tr> | <td>A <var>Unicode</var> string that is the value of the added <var>PI</var> node; stored exactly as is, that is, without whitespace normalization.</td></tr> | ||
</table> | </table> | ||
| Line 19: | Line 23: | ||
<ul> | <ul> | ||
<li>Since the return value of <var>AddPI</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods|Call]] it instead of saving its return value. | <li>Since the return value of <var>AddPI</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods|Call]] it instead of saving its return value. | ||
<li>Processing of an <var>XmlDoc</var> is likely to be more efficient if you add nodes in document order (that is, top-to-bottom, left-to-right). | <li>Processing of an <var>XmlDoc</var> is likely to be more efficient if you add nodes in document order (that is, top-to-bottom, left-to-right). </li> | ||
<li>To modify the value stored in | |||
<li>As of <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.3, the method arguments may include only non-null EBCDIC characters that translate to <var>Unicode</var>. As of <var class="product"> | <li>To modify the value stored in a <var>PI</var> node, change the <var>Value</var> property of an <var>XmlNode</var> that points to the <var>PI</var> node. </li> | ||
<li>As of <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.3, the method arguments may include only non-null EBCDIC characters that translate to <var>Unicode</var>. As of <var class="product">Sirius Mods</var> Version 7.6, these argument strings are <var>Unicode</var> or are converted to <var>Unicode</var>. 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"]]. </li> | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
In the following example, one PI node is added as the last child of element "b": | In the following example, one PI node is added as the last child of element "b": | ||
<p class="code">begin | <p class="code">begin | ||
| Line 46: | Line 51: | ||
</a> | </a> | ||
</top></nowiki> | </top></nowiki> | ||
</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">nr</var> object is neither the <var>Root</var> nor an <var>Element</var> node. | ||
<li> | <li>The <var class="term">name</var> argument violates the rules for an XML processing instruction target. | ||
<li> | <li>The <var class="term">value</var> argument violates the rules for an XML processing instruction value. | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
<ul> | <ul> | ||
<li>[[InsertPIBefore (XmlNode function)|InsertPIBefore]] also adds a PI node. <var>AddPI</var> adds a PI as the last child of the node pointed to by the method object; <var>InsertPIBefore</var> adds a PI as the immediately preceding sibling of the node pointed to by the method object. | <li><var>[[InsertPIBefore (XmlNode function)|InsertPIBefore]]</var> also adds a <var>PI</var> node. <var>AddPI</var> adds a <var>PI</var> as the last child of the node pointed to by the method object; <var>InsertPIBefore</var> adds a <var>PI</var> as the immediately preceding sibling of the node pointed to by the method object. | ||
</ul> | </ul> | ||
{{Template:XmlDoc/XmlNode:AddPI footer}} | {{Template:XmlDoc/XmlNode:AddPI footer}} | ||
Latest revision as of 21:01, 2 September 2015
Add Processing Instruction to XmlDoc Root or to Element XmlNode (XmlDoc and XmlNode classes)
[Requires Janus SOAP]
The AddPI callable function adds a PI (Processing Instruction) node as the last child of the Root node or Element node referenced by the method object.
Syntax
[%nod =] nr:AddPI( name, value)
Syntax terms
| %nod | If specified, an XmlNode that is set to point to the PI node that is added. |
|---|---|
| nr | An XmlDoc or XmlNode that refers to the Root or Element node that is the parent of the added PI node. |
| name | A Unicode string that is the target of the added PI node; this can be thought of as the "name" of the PI. It must conform to the XML syntax rules for a PI target; the maximum length of the name is 300 characters (127 characters prior to version 7.9, and 100 characters prior to version 7.7). |
| value | A Unicode string that is the value of the added PI node; stored exactly as is, that is, without whitespace normalization. |
Usage notes
- Since the return value of AddPI is frequently not needed, you may want to Call it instead of saving its return value.
- 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).
- To modify the value stored in a PI node, change the Value property of an XmlNode that points to the PI node.
- As of Sirius Mods Version 7.3, the method arguments may include only non-null EBCDIC characters that translate to Unicode. As of Sirius Mods Version 7.6, these argument strings are Unicode or are converted to Unicode. For more information about the effects of this Version 7.6 change, see "Strings and Unicode".
Examples
In the following example, one PI node is added as the last child of element "b":
begin %doc is object xmlDoc %doc = new %doc:loadXml('<top><a><b>05</b></a></top>') %n1 is object xmlNode %n1 = %doc:selectSingleNode('top/a/b') Call %n1:addPI('processing_app', 'ignore pre-2004') call %doc:print end
The example result, showing the serialized format of the processing instruction, follows:
<top> <a> <b> 05 <?processing_app ignore pre-2004?> </b> </a> </top>
Request-cancellation errors
This list is not exhaustive: it does not include all the errors that are request cancelling.
- The nr object is neither the Root nor an Element node.
- The name argument violates the rules for an XML processing instruction target.
- The value argument violates the rules for an XML processing instruction value.
See also
- InsertPIBefore also adds a PI node. AddPI adds a PI as the last child of the node pointed to by the method object; InsertPIBefore adds a PI as the immediately preceding sibling of the node pointed to by the method object.