AddPI (XmlDoc/XmlNode function) - Revision history

ELowell: /* Syntax terms */

2015-09-02T21:01:11Z

Syntax terms

← Older revision		Revision as of 21:01, 2 September 2015
Line 7:		Line 7:
	===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 <var>PI</var> 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>

JAL at 18:46, 22 October 2014

2014-10-22T18:46:34Z

← Older revision		Revision as of 18:46, 22 October 2014
Line 4:		Line 4:
	==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>%nod</th>
	<td>If specified, an <var>XmlNode</var> that is set to point to the <var>PI</var> 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 <var>PI</var> 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 <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>		<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 <var>PI</var> 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>
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 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>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>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>

JAL at 02:06, 1 March 2014

2014-03-01T02:06:23Z

← Older revision		Revision as of 02:06, 1 March 2014
Line 1:		Line 1:
	{{Template:XmlDoc/XmlNode:AddPI subtitle}}		{{Template:XmlDoc/XmlNode:AddPI subtitle}}
	The <var>AddPI</var> [[Notation conventions for methods#Callable functions\|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==
Line 48:		Line 48:

	==Request-cancellation errors==		==Request-cancellation errors==
			This list is not exhaustive: it does <i>not</i> include all the errors that are request cancelling.
	<ul>		<ul>
	<li>The <var class="term">nr</var> object is neither the <var>Root</var> nor an <var>Element</var> node.		<li>The <var class="term">nr</var> object is neither the <var>Root</var> nor an <var>Element</var> node.

JALWiccan: 1 revision

2011-07-14T19:40:18Z

1 revision

← Older revision	Revision as of 19:40, 14 July 2011
(No difference)

JAL2 at 19:40, 14 July 2011

2011-07-14T19:40:17Z

← Older revision		Revision as of 19:40, 14 July 2011
Line 1:		Line 1:
	{{Template:XmlDoc/XmlNode:AddPI subtitle}}		{{Template:XmlDoc/XmlNode:AddPI subtitle}}
	The <var>AddPI</var> [[Notation conventions for methods#Callable ~~methods~~\|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 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==

JAL2 at 20:17, 27 May 2011

2011-05-27T20:17:31Z

← Older revision		Revision as of 20:17, 27 May 2011
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 methods\|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.

	==Syntax==		==Syntax==
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%nod</th>		<tr><th>%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 300 characters (127 characters prior to version 7.9, and 100 characters prior to version 7.7).</td></tr>		<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 20:		Line 20:
	<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>To modify the value stored in an PI node, change the <var>Value</var> property of an <var>XmlNode</var> that points to the PI node.		<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>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>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"]].
	</ul>		</ul>

	==Examples==		==Examples==
	~~<OL><li>~~
	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 45:
	</a>		</a>
	</top></nowiki>		</top></nowiki>
	</p~~></ol~~>		</p>

	==Request-~~Cancellation Errors~~==		==Request-cancellation errors==
	<ul>		<ul>
	<li><var class="term">Nr</var> is neither the <var>Root</var> nor an <var>Element</var> node.		<li>The <var class="term">nr</var> object is neither the <var>Root</var> nor an <var>Element</var> node.
	<li>~~Argument~~ <var class="term">name</var> violates the rules for an XML processing instruction target.		<li>The <var class="term">name</var> argument violates the rules for an XML processing instruction target.
	<li>~~Argument~~ <var class="term">value</var> violates the rules for an XML processing instruction value.		<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}}

JALWiccan: 1 revision

2011-05-24T21:09:56Z

1 revision

← Older revision	Revision as of 21:09, 24 May 2011
(No difference)

Dme: /* Syntax terms */

2011-05-24T21:09:55Z

Syntax terms

← Older revision		Revision as of 21:09, 24 May 2011
Line 21:		Line 21:
	<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>To modify the value stored in an PI node, change the <var>Value</var> property of an <var>XmlNode</var> that points to the PI node.		<li>To modify the value stored in an PI node, change the <var>Value</var> property of an <var>XmlNode</var> that points to the PI node.
	<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>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"]].
	</ul>		</ul>

Dme: /* Syntax terms */

2011-05-22T20:49:59Z

Syntax terms

← Older revision		Revision as of 20:49, 22 May 2011
Line 11:		Line 11:
	<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 PI 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 (100 characters prior to ~~Version~~ 7.7 ~~of <var class="product">[[Janus SOAP]]</var>~~). </td></tr>		<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 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 PI node; stored exactly as is, that is, without whitespace normalization.</td></tr>

JALWiccan: 1 revision

2011-05-04T17:45:37Z

1 revision

← Older revision	Revision as of 17:45, 4 May 2011
(No difference)