InsertPIBefore (XmlNode function) - Revision history

ELowell: /* Syntax terms */

2015-09-02T21:18:37Z

Syntax terms

← Older revision		Revision as of 21:18, 2 September 2015
Line 7:		Line 7:
	===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 PI node that is inserted.</td></tr>		<td>If specified, an <var>XmlNode</var> that is set to point to the PI node that is inserted.</td></tr>

JAL at 17:31, 3 March 2014

2014-03-03T17:31:05Z

← Older revision		Revision as of 17:31, 3 March 2014
Line 1:		Line 1:
	{{Template:XmlNode:InsertPIBefore subtitle}}		{{Template:XmlNode:InsertPIBefore subtitle}}
	The <var>InsertPIBefore</var> [[Notation_conventions_for_methods#Callable_methods\|callable]] function inserts a PI (Processing Instruction) node as the immediate sibling preceding the method <var>XmlNode</var>.		The <var>InsertPIBefore</var> [[Notation_conventions_for_methods#Callable_methods\|callable]] function inserts a [[XmlDoc API#XmlDoc node types\|PI (Processing Instruction) node]] as the immediate sibling preceding the method <var>XmlNode</var>.

	==Syntax==		==Syntax==
	{{Template:XmlNode:InsertPIBefore syntax}}		{{Template:XmlNode:InsertPIBefore syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outNod</th>		<tr><th>%outNod</th>
	<td>If specified, an <var>XmlNode</var> that is set to point to the PI node that is inserted.</td></tr>		<td>If specified, an <var>XmlNode</var> that is set to point to the PI node that is inserted.</td></tr>

	<tr><th>nod</th>		<tr><th>nod</th>
	<td><var>XmlNode</var> pointing to the (non-<var>Root</var>) node before which the PI node is inserted.</td></tr>		<td><var>XmlNode</var> pointing to the (non-<var>Root</var>) node before which the PI node is inserted.</td></tr>

	<tr><th>name</th>		<tr><th>name</th>
	<td>A <var>Unicode</var> string that is the target of the inserted 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 inserted 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 inserted 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 inserted PI node; stored exactly as is, that is, without whitespace normalization.</td></tr>
Line 20:		Line 24:
	<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, the <var>InsertPIBefore</var> method arguments may include only non-null EBCDIC characters that translate to Unicode. As of <var class="product">Sirius Mods</var> Version 7.6, these argument strings are Unicode or are converted to Unicode. For more information about the effects of this Version 7.6		<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, the <var>InsertPIBefore</var> method arguments may include only non-null EBCDIC characters that translate to Unicode. As of <var class="product">Sirius Mods</var> 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 [[XmlDoc API#Strings and Unicode with the XmlDoc API\|"Strings and Unicode with the XmlDoc API"]].		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>InsertPIBefore</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>InsertPIBefore</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods\|Call]] it instead of saving its return value.

	<li>There is a very small "one-time" processing cost if [[XPath#ordScan\|certain Xpath expression]] operations are performed after using this method, because Insert-Before methods are guaranteed to add a node out of document order.		<li>There is a very small "one-time" processing cost if [[XPath#ordScan\|certain Xpath expression]] operations are performed after using this method, because Insert-Before methods are guaranteed to add a node out of document order.
	In general, processing 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).		In general, processing 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 a <var>PI</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>PI</var> node.		<li>To modify the value stored in a <var>PI</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>PI</var> node.
	</ul>		</ul>
Line 49:		Line 56:

	==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">nod</var> object is the <var>Root</var> node.		<li>The <var class="term">nod</var> object is the <var>Root</var> node.

Dme at 00:42, 17 October 2012

2012-10-17T00:42:55Z

← Older revision		Revision as of 00:42, 17 October 2012
Line 21:		Line 21:
	change, see [[XmlDoc API#Strings and Unicode with the XmlDoc API\|"Strings and Unicode with the XmlDoc API"]].		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>InsertPIBefore</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>InsertPIBefore</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods\|Call]] it instead of saving its return value.
	<li>There is a very small "one-time" processing cost if [[XPath#~~perf~~\|certain Xpath expression]] operations are performed after using this method, because Insert-Before methods are guaranteed to add a node out of document order.		<li>There is a very small "one-time" processing cost if [[XPath#ordScan\|certain Xpath expression]] operations are performed after using this method, because Insert-Before methods are guaranteed to add a node out of document order.
	In general, processing 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).		In general, processing 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 a <var>PI</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>PI</var> node.		<li>To modify the value stored in a <var>PI</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>PI</var> node.

Dme at 00:33, 17 October 2012

2012-10-17T00:33:36Z

← Older revision		Revision as of 00:33, 17 October 2012
Line 21:		Line 21:
	change, see [[XmlDoc API#Strings and Unicode with the XmlDoc API\|"Strings and Unicode with the XmlDoc API"]].		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>InsertPIBefore</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>InsertPIBefore</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods\|Call]] it instead of saving its return value.
	<li>There is a very small "one-time" processing cost if ~~certain~~ [[XPath]] operations are performed after using this method, because Insert-Before methods are guaranteed to add a node out of document order.		<li>There is a very small "one-time" processing cost if [[XPath#perf\|certain Xpath expression]] operations are performed after using this method, because Insert-Before methods are guaranteed to add a node out of document order.
	In general, processing 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).		In general, processing 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 a <var>PI</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>PI</var> node.		<li>To modify the value stored in a <var>PI</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>PI</var> node.

JAL2 at 22:59, 31 May 2011

2011-05-31T22:59:27Z

← Older revision		Revision as of 22:59, 31 May 2011
Line 1:		Line 1:
	{{Template:XmlNode:InsertPIBefore subtitle}}		{{Template:XmlNode:InsertPIBefore subtitle}}
	The <var>InsertPIBefore</var> callable function inserts a PI (Processing Instruction) node as the immediate sibling preceding the method <var>XmlNode</var>.		The <var>InsertPIBefore</var> [[Notation_conventions_for_methods#Callable_methods\|callable]] function inserts a PI (Processing Instruction) node as the immediate sibling preceding the method <var>XmlNode</var>.

	==Syntax==		==Syntax==
Line 9:		Line 9:
	<td>If specified, an <var>XmlNode</var> that is set to point to the PI node that is inserted.</td></tr>		<td>If specified, an <var>XmlNode</var> that is set to point to the PI node that is inserted.</td></tr>
	<tr><th>nod</th>		<tr><th>nod</th>
	<td><var>XmlNode</var> pointing to the (non-Root) node before which the PI node is inserted.</td></tr>		<td><var>XmlNode</var> pointing to the (non-<var>Root</var>) node before which the PI node is inserted.</td></tr>
	<tr><th>name</th>		<tr><th>name</th>
	<td>A <var>Unicode</var> string that is the target of the inserted 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 inserted 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>
Line 18:		Line 18:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, the <var>InsertPIBefore</var> 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		<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, the <var>InsertPIBefore</var> method arguments may include only non-null EBCDIC characters that translate to Unicode. As of <var class="product">Sirius Mods</var> 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 [[XmlDoc API#Strings and Unicode with the XmlDoc API\|"Strings and Unicode with the XmlDoc API"]].		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>InsertPIBefore</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>InsertPIBefore</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods\|Call]] it instead of saving its return value.
	<li>There is a very small "one-time" processing cost if certain [[XPath]] operations are performed after using this method, because Insert-Before methods are guaranteed to add a node out of document order.		<li>There is a very small "one-time" processing cost if certain [[XPath]] operations are performed after using this method, because Insert-Before methods are guaranteed to add a node out of document order.
	In general, processing 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).		In general, processing 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 a PI node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|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_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>PI</var> node.
	</ul>		</ul>

	==Examples==		==Examples==
	~~<ol><li>~~
	In the following example, a PI node is inserted before node "top":		In the following example, a PI node is inserted before node "top":
	<p class="code">begin		<p class="code">begin
Line 47:		Line 46:
	</a>		</a>
	</top>		</top>
	</p~~></ol~~>		</p>

	==Request-~~Cancellation Errors~~==		==Request-cancellation errors==
	<ul>		<ul>
	<li><var class="term">~~Nod~~</var> is the <var>Root</var> node.		<li>The <var class="term">nod</var> object is the <var>Root</var> node.
	<li><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><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><var>[[AddPI_(XmlDoc/XmlNode_function)\|AddPI]]</var> also adds a PI node. <var>InsertPIBefore</var> adds a PI as the immediately preceding sibling of the node pointed to by the method object. <var>AddPI</var> adds a PI as the last child of the node pointed to by the method object.		<li><var>[[AddPI_(XmlDoc/XmlNode_function)\|AddPI]]</var> also adds a <var>PI</var> node. <var>InsertPIBefore</var> adds a <var>PI</var> as the immediately preceding sibling of the node pointed to by the method object. <var>AddPI</var> adds a <var>PI</var> as the last child of the node pointed to by the method object.
	<li>For hints about inserting a node ''after'' a sibling node, see the ~~see the~~ [[InsertElementBefore_(XmlNode_function)#Examples\|~~"InsertElementBefore: Examples"~~]].		<li>For hints about inserting a node ''after'' a sibling node, see the <var>InsertElementBefore</var> [[InsertElementBefore_(XmlNode_function)#Examples\|examples]].
	</ul>		</ul>
	{{Template:XmlNode:InsertPIBefore footer}}		{{Template:XmlNode:InsertPIBefore footer}}

JALWiccan: 1 revision

2011-05-24T21:09:58Z

1 revision

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

JALWiccan: 1 revision

2011-05-24T21:09:57Z

1 revision

← Older revision		Revision as of 21:09, 24 May 2011
Line 18:		Line 18:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, the <var>InsertPIBefore</var> 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		<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, the <var>InsertPIBefore</var> 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 with the XmlDoc API"]].		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>InsertPIBefore</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>InsertPIBefore</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods\|Call]] it instead of saving its return value.

JALWiccan: 1 revision

2011-05-24T17:27:08Z

1 revision

← Older revision	Revision as of 17:27, 24 May 2011
(No difference)

Dme: /* Syntax terms */

2011-05-24T17:27:07Z

Syntax terms

← Older revision		Revision as of 17:27, 24 May 2011
Line 18:		Line 18:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>As of <var class="product">[[Sirius Mods~~\|"Sirius Mods"~~]]</var> Version 7.3, the <var>InsertPIBefore</var> 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		<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, the <var>InsertPIBefore</var> 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 with the XmlDoc API"]].		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>InsertPIBefore</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>InsertPIBefore</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods\|Call]] it instead of saving its return value.

Dme: /* Syntax terms */

2011-05-22T20:50:43Z

Syntax terms

← Older revision		Revision as of 20:50, 22 May 2011
Line 11:		Line 11:
	<td><var>XmlNode</var> pointing to the (non-Root) node before which the PI node is inserted.</td></tr>		<td><var>XmlNode</var> pointing to the (non-Root) node before which the PI node is inserted.</td></tr>
	<tr><th>name</th>		<tr><th>name</th>
	<td>A <var>Unicode</var> string that is the target of the inserted 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\|"Janus Soap"]]</var>~~).</td></tr>		<td>A <var>Unicode</var> string that is the target of the inserted 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 inserted 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 inserted PI node; stored exactly as is, that is, without whitespace normalization.</td></tr>

← Older revision		Revision as of 00:42, 17 October 2012
Line 21:		Line 21:
	change, see [[XmlDoc API#Strings and Unicode with the XmlDoc API\|"Strings and Unicode with the XmlDoc API"]].		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>InsertPIBefore</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>InsertPIBefore</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods\|Call]] it instead of saving its return value.
	<li>There is a very small "one-time" processing cost if [[XPath#~~perf~~\|certain Xpath expression]] operations are performed after using this method, because Insert-Before methods are guaranteed to add a node out of document order.		<li>There is a very small "one-time" processing cost if [[XPath#ordScan\|certain Xpath expression]] operations are performed after using this method, because Insert-Before methods are guaranteed to add a node out of document order.
	In general, processing 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).		In general, processing 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 a <var>PI</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>PI</var> node.		<li>To modify the value stored in a <var>PI</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>PI</var> node.