ValueDefault (XmlDoc/XmlNode function) - Revision history

JAL: xpath arg

2015-02-18T18:12:57Z

xpath arg

← Older revision		Revision as of 18:12, 18 February 2015
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:XmlDoc/XmlNode:ValueDefault syntax}}		{{Template:XmlDoc/XmlNode:ValueDefault syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%unicode</th>		<tr><th>%unicode</th>
	<td>A <var>Unicode</var> string variable for the returned substring or for the <i>default</i> value. Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</td></tr>		<td>A <var>Unicode</var> string variable for the returned substring or for the <i>default</i> value. Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</td></tr>

	<tr><th>nr</th>		<tr><th>nr</th>
	<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node. </td></tr>		<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node. </td></tr>

	<tr><th>xpath</th>		<tr><th>xpath</th>
	<td>A <var>Unicode</var> string that is an XPath expression that results in a nodelist. The head of the nodelist is the node to process.		<td>A <var>Unicode</var> string that is an XPath expression that results in a nodelist. The head of the nodelist is the node to process. Any other nodes in the nodelist are ignored.
	<p>This is an optional argument whose default is a period (<code>.</code>), that is, the node referenced by the method object (<var class="term">nr</var>). Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</p></td></tr>		<p>
			This is an optional argument whose default is a period (<code>.</code>), that is, the node referenced by the method object (<var class="term">nr</var>). Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</p></td></tr>

	<tr><th>value</th>		<tr><th>value</th>
	<td>A <var>Unicode</var> string expression to use as the result of <var>ValueDefault</var> if the result of <var class="term">xpath</var> is an empty nodelist. An optional argument, its default is the null string. Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</td></tr>		<td>A <var>Unicode</var> string expression to use as the result of <var>ValueDefault</var> if the result of <var class="term">xpath</var> is an empty nodelist. An optional argument, its default is the null string. Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</td></tr>
Line 20:		Line 25:
	<ul>		<ul>
	<li>As of <var class="product">Sirius Mods</var> Version 7.3, the <var>ValueDefault</var> result and string arguments may include only non-null EBCDIC characters that translate to Unicode.		<li>As of <var class="product">Sirius Mods</var> Version 7.3, the <var>ValueDefault</var> result and string arguments may include only non-null EBCDIC characters that translate to Unicode.
	<p>As of <var class="product">Sirius Mods</var> Version 7.6, these 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"]].</p>		<p>As of <var class="product">Sirius Mods</var> Version 7.6, these 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]].</p>
	</ul>		</ul>

Line 43:		Line 48:
	<ul>		<ul>
	<li><var>[[Value (XmlDoc/XmlNode property)\|Value]]</var> discusses the '''string-value''' of various <var>node</var> types.		<li><var>[[Value (XmlDoc/XmlNode property)\|Value]]</var> discusses the '''string-value''' of various <var>node</var> types.
	<li>For more information about using XPath expressions, see <var>[[XPath~~\|"XPath"~~]]</var>.		<li>For more information about using XPath expressions, see <var>[[XPath]]</var>.
	</ul>		</ul>

	{{Template:XmlDoc/XmlNode:ValueDefault footer}}		{{Template:XmlDoc/XmlNode:ValueDefault footer}}

JAL: /* Request-cancellation errors */

2014-03-03T21:16:23Z

Request-cancellation errors

← Older revision		Revision as of 21:16, 3 March 2014
Line 34:		Line 34:

	==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><var class="term">xpath</var> expression is invalid.		<li><var class="term">xpath</var> expression is invalid.

JAL2 at 19:46, 6 June 2011

2011-06-06T19:46:23Z

← Older revision		Revision as of 19:46, 6 June 2011
Line 1:		Line 1:
	{{Template:XmlDoc/XmlNode:ValueDefault subtitle}}		{{Template:XmlDoc/XmlNode:ValueDefault subtitle}}
	<var>ValueDefault</var> obtains a substring of the string-value of a node, including its <var>Text</var> descendants. <var>ValueDefault</var> provides an optional argument to use as a return value if the [[XPath#XPath_syntax\|~~Xpath~~ expression]] that designates the node to process is empty.		<var>ValueDefault</var> obtains a substring of the string-value of a node, including its <var>Text</var> descendants. <var>ValueDefault</var> provides an optional argument to use as a return value if the [[XPath#XPath_syntax\|XPath expression]] that designates the node to process is empty.

	==Syntax==		==Syntax==
Line 11:		Line 11:
	<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node. </td></tr>		<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node. </td></tr>
	<tr><th>xpath</th>		<tr><th>xpath</th>
	<td>A <var>Unicode</var> string that is an [[XPath~~#XPath_syntax\|Xpath~~ expression]] that results in a nodelist. The head of the nodelist is the node to process.		<td>A <var>Unicode</var> string that is an XPath expression that results in a nodelist. The head of the nodelist is the node to process.
	<p>This is an optional argument whose default is a period (<code>.</code>), that is, the node referenced by the method object (<var class="term">nr</var>). Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</p></td></tr>		<p>This is an optional argument whose default is a period (<code>.</code>), that is, the node referenced by the method object (<var class="term">nr</var>). Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</p></td></tr>
	<tr><th>value</th>		<tr><th>value</th>
	<td>A <var>Unicode</var> string expression to use as the result of <var>ValueDefault</var> if the result of <var class="term">xpath</var> is ~~the~~ empty nodelist. An optional argument, its default is the null string. Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</td></tr>		<td>A <var>Unicode</var> string expression to use as the result of <var>ValueDefault</var> if the result of <var class="term">xpath</var> is an empty nodelist. An optional argument, its default is the null string. Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>As of <var class="product">Sirius Mods</var> Version 7.3, the <var>ValueDefault</var> result and string arguments may include only non-null EBCDIC characters that translate to ~~<var>~~Unicode~~</var>~~.		<li>As of <var class="product">Sirius Mods</var> Version 7.3, the <var>ValueDefault</var> result and string arguments may include only non-null EBCDIC characters that translate to Unicode.
	<p>As of <var class="product">Sirius Mods</var> Version 7.6, these 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"]].</p>		<p>As of <var class="product">Sirius Mods</var> Version 7.6, these 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"]].</p>
	</ul>		</ul>
Line 35:		Line 35:
	==Request-cancellation errors==		==Request-cancellation errors==
	<ul>		<ul>
	<li><var class="term">xpath</var> is invalid.		<li><var class="term">xpath</var> expression is invalid.
	<li>Insufficient free space exists in CCATEMP.		<li>Insufficient free space exists in CCATEMP.
	</ul>		</ul>

JALWiccan: 1 revision

2011-06-06T19:05:50Z

1 revision

← Older revision	Revision as of 19:05, 6 June 2011
(No difference)

JALWiccan: 1 revision

2011-06-06T19:05:48Z

1 revision

← Older revision		Revision as of 19:05, 6 June 2011
Line 33:		Line 33:
	</p>		</p>

	==Request-~~Cancellation Errors/~~==		==Request-cancellation errors==
	<ul>		<ul>
	<li><var class="term">xpath</var> is invalid.		<li><var class="term">xpath</var> is invalid.

JALWiccan: 1 revision

2011-06-06T17:44:05Z

1 revision

← Older revision	Revision as of 17:44, 6 June 2011
(No difference)

JAL2: /* Usage notes */

2011-06-06T17:44:03Z

Usage notes

← Older revision		Revision as of 17:44, 6 June 2011
Line 33:		Line 33:
	</p>		</p>

	==Request-Cancellation Errors==		==Request-Cancellation Errors/==
	<ul>		<ul>
	<li><var class="term">xpath</var> is invalid.		<li><var class="term">xpath</var> is invalid.

JAL2: /* Usage notes */

2011-05-23T21:46:34Z

Usage notes

← Older revision		Revision as of 21:46, 23 May 2011
Line 19:		Line 19:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>As of <var class="product">Sirius Mods</var> Version 7.3, the <var>ValueDefault</var> string arguments ~~and result~~ may include only non-null EBCDIC characters that translate to <var>Unicode</var>.		<li>As of <var class="product">Sirius Mods</var> Version 7.3, the <var>ValueDefault</var> result and string arguments may include only non-null EBCDIC characters that translate to <var>Unicode</var>.
	<p>As of <var class="product">Sirius Mods</var> Version 7.6, these 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"]].</p>		<p>As of <var class="product">Sirius Mods</var> Version 7.6, these 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"]].</p>
	</ul>		</ul>

JAL2: /* Syntax terms */

2011-05-23T21:42:13Z

Syntax terms

← Older revision		Revision as of 21:42, 23 May 2011
Line 12:		Line 12:
	<tr><th>xpath</th>		<tr><th>xpath</th>
	<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|Xpath expression]] that results in a nodelist. The head of the nodelist is the node to process.		<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|Xpath expression]] that results in a nodelist. The head of the nodelist is the node to process.
	<p>This is an optional argument whose default is a period (<code>.</code>), that is, the ~~<var>~~node~~</var>~~ referenced by the method object (<var class="term">nr</var>). Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</p></td></tr>		<p>This is an optional argument whose default is a period (<code>.</code>), that is, the node referenced by the method object (<var class="term">nr</var>). Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</p></td></tr>
	<tr><th>value</th>		<tr><th>value</th>
	<td>A <var>Unicode</var> string expression to use as the result of <var>ValueDefault</var> if the result of <var class="term">xpath</var> is the empty nodelist. An optional argument, its default is the null string. Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</td></tr>		<td>A <var>Unicode</var> string expression to use as the result of <var>ValueDefault</var> if the result of <var class="term">xpath</var> is the empty nodelist. An optional argument, its default is the null string. Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</td></tr>

JAL2 at 21:41, 23 May 2011

2011-05-23T21:41:37Z

← Older revision		Revision as of 21:41, 23 May 2011
Line 1:		Line 1:
	{{Template:XmlDoc/XmlNode:ValueDefault subtitle}}		{{Template:XmlDoc/XmlNode:ValueDefault subtitle}}
	<var>ValueDefault</var> obtains a substring of the string-value of a node, including its <var>Text</var> descendants. <var>ValueDefault</var> provides an optional argument to use as a return value if the ~~<var>~~[[XPath#XPath_syntax\|Xpath expression]]~~</var>~~ that designates the node to process is empty.		<var>ValueDefault</var> obtains a substring of the string-value of a node, including its <var>Text</var> descendants. <var>ValueDefault</var> provides an optional argument to use as a return value if the [[XPath#XPath_syntax\|Xpath expression]] that designates the node to process is empty.

	==Syntax==		==Syntax==
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%unicode</th>		<tr><th>%unicode</th>
	<td>A <var>Unicode</var> string variable for the returned substring or for the <i>default</i> value. Prior to <var class="product">[[Sirius Mods~~\|"Sirius Mods"~~]]</var> Version 7.6, this is an EBCDIC string.</td></tr>		<td>A <var>Unicode</var> string variable for the returned substring or for the <i>default</i> value. Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</td></tr>
	<tr><th>nr</th>		<tr><th>nr</th>
	<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node. </td></tr>		<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node. </td></tr>
	<tr><th>xpath</th>		<tr><th>xpath</th>
	<td>A <var>Unicode</var> string that is an ~~<var>~~[[XPath#XPath_syntax\|Xpath expression]]~~</var>~~ that results in a ~~<var>~~nodelist~~</var>~~. The head of the ~~<var>~~nodelist~~</var>~~ is the ~~<var>~~node~~</var>~~ to process.		<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|Xpath expression]] that results in a nodelist. The head of the nodelist is the node to process.
	<p>This is an optional argument whose default is a period (<code>.</code>), that is, the <var>node</var> referenced by the method object (<var class="term">nr</var>). Prior to <var class="product">"Sirius Mods"</var> Version 7.6, this argument is an EBCDIC string.</p></td></tr>		<p>This is an optional argument whose default is a period (<code>.</code>), that is, the <var>node</var> referenced by the method object (<var class="term">nr</var>). Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</p></td></tr>
	<tr><th>value</th>		<tr><th>value</th>
	<td>A <var>Unicode</var> string expression to use as the result of <var>ValueDefault</var> if the result of <var class="term">xpath</var> is the empty ~~<var>~~nodelist~~</var>~~. An optional argument, its default is the null string. Prior to <var class="product">"Sirius Mods"</var> Version 7.6, this argument is an EBCDIC string.</td></tr>		<td>A <var>Unicode</var> string expression to use as the result of <var>ValueDefault</var> if the result of <var class="term">xpath</var> is the empty nodelist. An optional argument, its default is the null string. Prior to <var class="product">Sirius Mods</var> Version 7.6, this argument is an EBCDIC string.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>As of <var class="product">[[Sirius Mods~~\|"Sirius Mods"]]~~</var> Version 7.3, the <var>ValueDefault</var> string arguments and result may include only non-null EBCDIC characters that translate to <var>Unicode</var>.		<li>As of <var class="product">Sirius Mods</var> Version 7.3, the <var>ValueDefault</var> string arguments and result may include only non-null EBCDIC characters that translate to <var>Unicode</var>.
	<p>As of <var class="product">"Sirius Mods"</var> Version 7.6, these 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"]].</p>		<p>As of <var class="product">Sirius Mods</var> Version 7.6, these 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"]].</p>
	</ul>		</ul>

	==Examples==		==Examples==
	~~<ol><li>~~The following example displays the default string, a single underscore ( _ ) character:		The following example displays the default string, a single underscore ( _ ) character:
	<p class="code">begin		<p class="code">begin
	%d object xmlDoc		%d object xmlDoc
Line 31:		Line 31:
	print %d:valueDefault('/x', '_')		print %d:valueDefault('/x', '_')
	end		end
	</p~~></oL~~>		</p>

	==Request-Cancellation Errors==		==Request-Cancellation Errors==
	<ul>		<ul>
	<li><var class="term">~~XPath~~</var> is invalid.		<li><var class="term">xpath</var> is invalid.
	<li>Insufficient free space exists in CCATEMP.		<li>Insufficient free space exists in CCATEMP.
	</ul>		</ul>
Line 42:		Line 42:
	<ul>		<ul>
	<li><var>[[Value (XmlDoc/XmlNode property)\|Value]]</var> discusses the '''string-value''' of various <var>node</var> types.		<li><var>[[Value (XmlDoc/XmlNode property)\|Value]]</var> discusses the '''string-value''' of various <var>node</var> types.
	<li>For more information about using XPath expressions, see <var>[[XPath]]</var>.		<li>For more information about using XPath expressions, see <var>[[XPath\|"XPath"]]</var>.
	</ul>		</ul>
	{{Template:XmlDoc/XmlNode:ValueDefault footer}}		{{Template:XmlDoc/XmlNode:ValueDefault footer}}