InsertCommentBefore (XmlNode function) - Revision history

ELowell: /* Syntax terms */

2015-09-02T21:17:20Z

Syntax terms

← Older revision		Revision as of 21:17, 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 <var>Comment</var> node that is added. </td></tr>		<td>If specified, an <var>XmlNode</var> that is set to point to the <var>Comment</var> node that is added. </td></tr>

JAL at 17:28, 3 March 2014

2014-03-03T17:28:03Z

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

	==Syntax==		==Syntax==
	{{Template:XmlNode:InsertCommentBefore syntax}}		{{Template:XmlNode:InsertCommentBefore 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 <var>Comment</var> node that is added. </td></tr>		<td>If specified, an <var>XmlNode</var> that is set to point to the <var>Comment</var> node that is added. </td></tr>

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

	<tr><th>value</th>		<tr><th>value</th>
	<td>A <var>Unicode</var> string that is the value of the added <var>Comment</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>Comment</var> node; stored exactly as is, that is, without whitespace normalization.</td></tr>
Line 17:		Line 20:
	<ul>		<ul>
	<li>Since the return value of <var>InsertCommentBefore</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>InsertCommentBefore</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>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 <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"]].		<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 <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"]].

	<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).		<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).

	<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.		<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.
	</ul>		</ul>
Line 44:		Line 50:

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

Dme at 00:43, 17 October 2012

2012-10-17T00:43:15Z

← Older revision		Revision as of 00:43, 17 October 2012
Line 18:		Line 18:
	<li>Since the return value of <var>InsertCommentBefore</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>InsertCommentBefore</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>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 <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"]].		<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 <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"]].
	<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).		<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).
	<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.		<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.
	</ul>		</ul>

Dme: /* Usage notes */

2012-10-17T00:33:04Z

Usage notes

← Older revision		Revision as of 00:33, 17 October 2012
Line 18:		Line 18:
	<li>Since the return value of <var>InsertCommentBefore</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>InsertCommentBefore</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>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 <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"]].		<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 <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"]].
	<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).		<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).
	<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.		<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.
	</ul>		</ul>

JAL2 at 22:14, 31 May 2011

2011-05-31T22:14:30Z

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

	==Syntax==		==Syntax==
Line 17:		Line 17:
	<ul>		<ul>
	<li>Since the return value of <var>InsertCommentBefore</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>InsertCommentBefore</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>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 ~~<var>~~Unicode~~</var>~~. As of <var class="product">Sirius Mods</var> Version 7.6, all <var class="product">[[Janus SOAP~~\|"Janus Soap"~~]]</var> string arguments and results 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"]].		<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 <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"]].
	<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).		<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).
	<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.		<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.
	</ul>		</ul>

	==Examples==		==Examples==
	~~<ol><li>~~
	In the following example, a <var>Comment</var> node is inserted before node "a":		In the following example, a <var>Comment</var> node is inserted before node "a":
	<p class="code">begin		<p class="code">begin
Line 42:		Line 41:
	</a>		</a>
	</top>		</top>
	</p~~></ol~~>		</p>

	==Request-~~Cancellation Errors~~==		==Request-cancellation errors==
	<ul>		<ul>
	<li><var class="term">~~Nod~~</var> is the Root node.		<li>The <var class="term">nod</var> argument is the <var>Root</var> node.
	<li><var class="term">value</var> violates the rules for an XML comment.		<li>The <var class="term">value</var> argument violates the rules for an XML comment.
	</ul>		</ul>

Line 53:		Line 52:
	<ul>		<ul>
	<li><var>[[AddComment_(XmlDoc/XmlNode_function)\|AddComment]]</var> also adds a <var>Comment</var> node. <var>InsertCommentBefore</var> adds a <var>Comment</var> as the immediately preceding sibling of the node pointed to by the method object; <var>AddComment</var> adds the <var>Comment</var> as the last child of the node pointed to by the method object.		<li><var>[[AddComment_(XmlDoc/XmlNode_function)\|AddComment]]</var> also adds a <var>Comment</var> node. <var>InsertCommentBefore</var> adds a <var>Comment</var> as the immediately preceding sibling of the node pointed to by the method object; <var>AddComment</var> adds the <var>Comment</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 [[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:InsertCommentBefore footer}}		{{Template:XmlNode:InsertCommentBefore 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 17:		Line 17:
	<ul>		<ul>
	<li>Since the return value of <var>InsertCommentBefore</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>InsertCommentBefore</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>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 <var>Unicode</var>. As of <var class="product">"Sirius Mods"</var> Version 7.6, all <var class="product">[[Janus SOAP\|"Janus Soap"]]</var> string arguments and results 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"]].		<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 <var>Unicode</var>. As of <var class="product">Sirius Mods</var> Version 7.6, all <var class="product">[[Janus SOAP\|"Janus Soap"]]</var> string arguments and results 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"]].
	<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).		<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).
	<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.		<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.

JALWiccan: 1 revision

2011-05-24T17:27:08Z

1 revision

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

Goff: /* See also */

2011-05-24T17:27:07Z

Goff: /* See also */

2011-05-07T04:46:08Z

← Older revision		Revision as of 00:43, 17 October 2012
Line 18:		Line 18:
	<li>Since the return value of <var>InsertCommentBefore</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>InsertCommentBefore</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>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 <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"]].		<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 <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"]].
	<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).		<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).
	<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.		<li>To modify the value stored in a <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.
	</ul>		</ul>

← Older revision		Revision as of 04:46, 7 May 2011
Line 53:		Line 53:
	<ul>		<ul>
	<li><var>[[AddComment_(XmlDoc/XmlNode_function)\|AddComment]]</var> also adds a <var>Comment</var> node. <var>InsertCommentBefore</var> adds a <var>Comment</var> as the immediately preceding sibling of the node pointed to by the method object; <var>AddComment</var> adds the <var>Comment</var> as the last child of the node pointed to by the method object.		<li><var>[[AddComment_(XmlDoc/XmlNode_function)\|AddComment]]</var> also adds a <var>Comment</var> node. <var>InsertCommentBefore</var> adds a <var>Comment</var> as the immediately preceding sibling of the node pointed to by the method object; <var>AddComment</var> adds the <var>Comment</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 [[InsertElementBefore_(XmlNode_function)#Examples\|"Examples ~~in InsertElementBefore~~"]].		<li>For hints about inserting a node ''after'' a sibling node, see the [[InsertElementBefore_(XmlNode_function)#Examples\|"InsertElementBefore: Examples"]].
	</ul>		</ul>
	{{Template:XmlNode:InsertCommentBefore footer}}		{{Template:XmlNode:InsertCommentBefore footer}}