ToXPathStringlist and XPathNodeID (XmlDoc/XmlNode functions) - Revision history

JAL: link repair

2018-06-01T16:06:23Z

link repair

← Older revision		Revision as of 16:06, 1 June 2018
Line 4:		Line 4:
	<var>XPathNodeID</var> is designed to provide additional information when sending an error message to an XML client application, helping the application to identify an invalid node selection in its request XML document. A complex XPath expression might not be finding the node intended, for example.		<var>XPathNodeID</var> is designed to provide additional information when sending an error message to an XML client application, helping the application to identify an invalid node selection in its request XML document. A complex XPath expression might not be finding the node intended, for example.

	<var>[[ToXPathString (XmlDoc/XmlNode function)\|ToXPathString]]</var> is the same as <var>XPathNodeID</var> except its output is a string instead of a <var>Stringlist</var>. <var>ToXPathString</var> lets <var class="product">[~~http://m204wiki.rocketsoftware.com/images/f/fb/FactrNew.pdf~~ SirFact]</var>, <var class="product">[[Debugger\|Janus Debugger]]</var>, and <var class="product">[[Debugger\|~~Sirius~~ Debugger]]</var> users extract XPath information when needed. <var>XPathNodeID</var> does not work in those environments because of its object (<var>Stringlist</var>) output.		<var>[[ToXPathString (XmlDoc/XmlNode function)\|ToXPathString]]</var> is the same as <var>XPathNodeID</var> except its output is a string instead of a <var>Stringlist</var>. <var>ToXPathString</var> lets <var class="product">[[SirFact]]</var>, <var class="product">[[Debugger\|Janus Debugger]]</var>, and <var class="product">[[Debugger\|TN3270 Debugger]]</var> users extract XPath information when needed. <var>XPathNodeID</var> does not work in those environments because of its object (<var>Stringlist</var>) output.

	==Syntax==		==Syntax==
Line 25:		Line 25:
	<ul>		<ul>
	<li>If the absolute XPath expression returned by <var>XPathNodeID</var> contains no prefixes, the <var>Stringlist</var> <var class="term">%sl</var> contains only one item: the expression. However, if the expression uses an element or attribute that has one or more non-null namespace URIs, the expression occupies an additional pair of <var>Stringlist</var> items for each such URI (an item for the associated prefix, then an item for the URI).		<li>If the absolute XPath expression returned by <var>XPathNodeID</var> contains no prefixes, the <var>Stringlist</var> <var class="term">%sl</var> contains only one item: the expression. However, if the expression uses an element or attribute that has one or more non-null namespace URIs, the expression occupies an additional pair of <var>Stringlist</var> items for each such URI (an item for the associated prefix, then an item for the URI).
	<p>		<p class="note"> '''Note:'''
	'''Note:'''
	If the expression uses a URI that is without a prefix in the document or if a single prefix in the document is used for two different URIs, <var>XPathNodeID</var> generates an "invented" prefix.		If the expression uses a URI that is without a prefix in the document or if a single prefix in the document is used for two different URIs, <var>XPathNodeID</var> generates an "invented" prefix.
	Such a prefix is generated because an XPath expression requires a prefix if it names an element or attribute that has a URI (for more about this requirement, see <var>[[SelectionNamespace (XmlDoc property)\|SelectionNamespace]]</var>). A generated prefix is shown in the example, below.</p>		Such a prefix is generated because an XPath expression requires a prefix if it names an element or attribute that has a URI (for more about this requirement, see <var>[[SelectionNamespace (XmlDoc property)\|SelectionNamespace]]</var>). A generated prefix is shown in the example, below. </p>
	~~<li><var>XPathNodeID</var> is available in <var class="product">Sirius Mods</var> Version 7.0 and later.~~
	~~<li><var>ToXPathStringlist</var> is available in <var class="product">Sirius Mods</var> Version 7.3 and later.~~
	</ul>		</ul>

JAL: typos

2018-06-01T16:00:37Z

typos

← Older revision		Revision as of 16:00, 1 June 2018
Line 51:		Line 51:
	When applied to the above document, the following table shows the <var>Stringlist</var>'s item(s) returned for each of various <var>XPathNodeID</var> arguments:		When applied to the above document, the following table shows the <var>Stringlist</var>'s item(s) returned for each of various <var>XPathNodeID</var> arguments:
	<p class="code"><nowiki>		<p class="code"><nowiki>
	Argument: Returned ~~<var>~~Stringlist~~</var>~~ item(s):		Argument: Returned Stringlist item(s):
	----------------------------- ---------------------------		----------------------------- ------------------------------
	/ /a/b		/ /a/b
	//* /a/b/c[1]		//* /a/b/c[1]
Line 70:		Line 70:
	x		x
	u:a		u:a
	_xpID.00~~</p>~~		_xpID.00
	u:c		u:c
	</nowiki></p>		</nowiki></p>

Dme: /* Syntax terms */

2015-02-19T21:00:18Z

Syntax terms

← Older revision		Revision as of 21:00, 19 February 2015
Line 17:		Line 17:
	<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">selectionXpath</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">selectionXpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node.</td></tr>
	<tr><th>selectionXpath</th>		<tr><th>selectionXpath</th>
	<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|Xpath expression]] that ~~selects~~ a node ~~from~~ the method object. 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 that is an [[XPath#XPath_syntax\|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, and its default is a period (<tt>.</tt>), that is, the node referenced by the method object (<var class="term">nr</var>). </p>Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this argument is an EBCDIC string.</td></tr>
	</table>		</table>

JAL at 21:11, 3 March 2014

2014-03-03T21:11:18Z

← Older revision		Revision as of 21:11, 3 March 2014
Line 4:		Line 4:
	<var>XPathNodeID</var> is designed to provide additional information when sending an error message to an XML client application, helping the application to identify an invalid node selection in its request XML document. A complex XPath expression might not be finding the node intended, for example.		<var>XPathNodeID</var> is designed to provide additional information when sending an error message to an XML client application, helping the application to identify an invalid node selection in its request XML document. A complex XPath expression might not be finding the node intended, for example.

	<var>[[ToXPathString (XmlDoc/XmlNode function)\|ToXPathString]]</var> is the same as <var>XPathNodeID</var> except its output is a string instead of a <var>Stringlist</var>. <var>ToXPathString</var> lets <var class="product">[http://~~www~~.~~sirius-software~~.com/~~maint~~/~~factr~~.pdf SirFact]</var>, <var class="product">[[Debugger\|Janus Debugger]]</var>, and <var class="product">[[Debugger\|Sirius Debugger]]</var> users extract XPath information when needed. <var>XPathNodeID</var> does not work in those environments because of its object (<var>Stringlist</var>) output.		<var>[[ToXPathString (XmlDoc/XmlNode function)\|ToXPathString]]</var> is the same as <var>XPathNodeID</var> except its output is a string instead of a <var>Stringlist</var>. <var>ToXPathString</var> lets <var class="product">[http://m204wiki.rocketsoftware.com/images/f/fb/FactrNew.pdf SirFact]</var>, <var class="product">[[Debugger\|Janus Debugger]]</var>, and <var class="product">[[Debugger\|Sirius Debugger]]</var> users extract XPath information when needed. <var>XPathNodeID</var> does not work in those environments because of its object (<var>Stringlist</var>) output.

	==Syntax==		==Syntax==
	{{Template:XmlDoc/XmlNode:ToXPathStringlist syntax}}		{{Template:XmlDoc/XmlNode:ToXPathStringlist syntax}}
	{{Template:XmlDoc/XmlNode:XPathNodeID syntax}}		{{Template:XmlDoc/XmlNode:XPathNodeID syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 72:		Line 73:

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

JAL2 at 15:53, 7 June 2011

2011-06-07T15:53:46Z

← Older revision		Revision as of 15:53, 7 June 2011
Line 1:		Line 1:
	{{Template:XmlDoc/XmlNode:ToXPathStringlist and XPathNodeID subtitle}}		{{Template:XmlDoc/XmlNode:ToXPathStringlist and XPathNodeID subtitle}}
	<var>ToXPathStringlist</var> and <var>XPathNodeID</var> are synonyms; they return an absolute XPath expression that identifies the node that the argument [[XPath]] expression actually selects. In the remainder of this article, you can use <var>ToXPathStringlist</var> and <var>XPathNodeID</var> interchangeably.		<var>ToXPathStringlist</var> and <var>XPathNodeID</var> are synonyms; they return an absolute [[XPath]] expression that identifies the node that the argument XPath expression actually selects. In the remainder of this article, you can use <var>ToXPathStringlist</var> and <var>XPathNodeID</var> interchangeably.

	<var>XPathNodeID</var> is designed to provide additional information when sending an error message to an XML client application, helping the application to identify an invalid node selection in its request XML document. A complex XPath expression might not be finding the node intended, for example.		<var>XPathNodeID</var> is designed to provide additional information when sending an error message to an XML client application, helping the application to identify an invalid node selection in its request XML document. A complex XPath expression might not be finding the node intended, for example.
Line 57:		Line 57:
	///@ /a/b/c[1]/@n		///@ /a/b/c[1]/@n
	/ /		/ /

	/[2] /a/x:a		/[2] /a/x:a
	Two prefix/URI items:		</nowiki><i>Two prefix/URI items:</i><nowiki>
	x		x
	u:a		u:a

	/[2]/*[2] /a/x:a/_xpID.00:y		/[2]/*[2] /a/x:a/_xpID.00:y
	Four prefix/URI items:		</nowiki><i>Four prefix/URI items:</i><nowiki>
	x		x
	u:a		u:a
Line 71:		Line 73:
	==Request-cancellation errors==		==Request-cancellation errors==
	<ul>		<ul>
	<li><var class="term">selectionXpath</var> expression is invalid.		<li>The <var class="term">selectionXpath</var> expression is invalid.
	<li>Insufficient free space exists in CCATEMP.		<li>Insufficient free space exists in CCATEMP.
	</ul>		</ul>

JAL2 at 19:18, 6 June 2011

2011-06-06T19:18:49Z

← Older revision		Revision as of 19:18, 6 June 2011
Line 1:		Line 1:
	{{Template:XmlDoc/XmlNode:ToXPathStringlist and XPathNodeID subtitle}}		{{Template:XmlDoc/XmlNode:ToXPathStringlist and XPathNodeID subtitle}}
	<var>ToXPathStringlist</var> and <var>XPathNodeID</var> are synonyms; they return an absolute XPath expression that identifies the node that the argument ~~<var>~~[[XPath]]~~</var>~~ expression actually selects. In the remainder of this article, you can use <var>ToXPathStringlist</var> and <var>XPathNodeID</var> interchangeably.		<var>ToXPathStringlist</var> and <var>XPathNodeID</var> are synonyms; they return an absolute XPath expression that identifies the node that the argument [[XPath]] expression actually selects. In the remainder of this article, you can use <var>ToXPathStringlist</var> and <var>XPathNodeID</var> interchangeably.

	<var>XPathNodeID</var> is designed to provide additional information when sending an error message to an XML client application, helping the application to identify an invalid node selection in its request XML document. A complex XPath expression might not be finding the node intended, for example.		<var>XPathNodeID</var> is designed to provide additional information when sending an error message to an XML client application, helping the application to identify an invalid node selection in its request XML document. A complex XPath expression might not be finding the node intended, for example.
Line 14:		Line 14:
	<td>A <var>Stringlist</var> to contain one or more items that identify the node identified by <var class="term">selectionXpath</var>.</td></tr>		<td>A <var>Stringlist</var> to contain one or more items that identify the node identified by <var class="term">selectionXpath</var>.</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">selectionXpath</var> expression. If an <var>XmlDoc</var>, the Root 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">selectionXpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node.</td></tr>
	<tr><th>selectionXpath</th>		<tr><th>selectionXpath</th>
	<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|Xpath expression]] that selects a node from the method object. 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 that is an [[XPath#XPath_syntax\|Xpath expression]] that selects a node from the method object. Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this argument is an EBCDIC string.</td></tr>
Line 26:		Line 26:
	If the expression uses a URI that is without a prefix in the document or if a single prefix in the document is used for two different URIs, <var>XPathNodeID</var> generates an "invented" prefix.		If the expression uses a URI that is without a prefix in the document or if a single prefix in the document is used for two different URIs, <var>XPathNodeID</var> generates an "invented" prefix.
	Such a prefix is generated because an XPath expression requires a prefix if it names an element or attribute that has a URI (for more about this requirement, see <var>[[SelectionNamespace (XmlDoc property)\|SelectionNamespace]]</var>). A generated prefix is shown in the example, below.</p>		Such a prefix is generated because an XPath expression requires a prefix if it names an element or attribute that has a URI (for more about this requirement, see <var>[[SelectionNamespace (XmlDoc property)\|SelectionNamespace]]</var>). A generated prefix is shown in the example, below.</p>
	<li><var>XPathNodeID</var> is available in <var class="product">[[Sirius Mods]]</var> Version 7.0 and later.		<li><var>XPathNodeID</var> is available in <var class="product">Sirius Mods</var> Version 7.0 and later.
	<li><var>ToXPathStringlist</var> is available in <var class="product">Sirius Mods</var> Version 7.3 and later.		<li><var>ToXPathStringlist</var> is available in <var class="product">Sirius Mods</var> Version 7.3 and later.
	</ul>		</ul>
Line 71:		Line 71:
	==Request-cancellation errors==		==Request-cancellation errors==
	<ul>		<ul>
	<li><var class="term">selectionXpath</var> is invalid.		<li><var class="term">selectionXpath</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:49Z

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 69:		Line 69:
	</nowiki></p>		</nowiki></p>

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

JALWiccan: 1 revision

2011-06-06T17:44:04Z

1 revision

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

JAL2 at 17:44, 6 June 2011

2011-06-06T17:44:03Z

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

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