ToXPathString (XmlDoc/XmlNode function) - Revision history

Dme: /* Syntax terms */

2015-02-19T20:59:06Z

Syntax terms

← Older revision		Revision as of 20:59, 19 February 2015
Line 14:		Line 14:
	<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 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 is an EBCDIC string.</td></tr>
	</table>		</table>

JAL at 21:10, 3 March 2014

2014-03-03T21:10:02Z

← Older revision		Revision as of 21:10, 3 March 2014
Line 2:		Line 2:
	<var>ToXPathString </var> returns, in a string, an absolute XPath expression that identifies the node that a given XPath expression actually selects. <var>ToXPathString</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 </var> returns, in a string, an absolute XPath expression that identifies the node that a given XPath expression actually selects. <var>ToXPathString</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</var> is the same as <var>[[XPathNodeID (XmlDoc/XmlNode function)\|XPathNodeID]]</var> except its output is a string instead of a <var>Stringlist</var> (<var>ToXPathStringlist</var> is a synonym for <var>XPathNodeID</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. The <var>XPathNodeID</var> method does not work in those environments because of its object (<var>Stringlist</var>) output.		<var>ToXPathString</var> is the same as <var>[[XPathNodeID (XmlDoc/XmlNode function)\|XPathNodeID]]</var> except its output is a string instead of a <var>Stringlist</var> (<var>ToXPathStringlist</var> is a synonym for <var>XPathNodeID</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. The <var>XPathNodeID</var> method does not work in those environments because of its object (<var>Stringlist</var>) output.

	==Syntax==		==Syntax==
	{{Template:XmlDoc/XmlNode:ToXPathString syntax}}		{{Template:XmlDoc/XmlNode:ToXPathString syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 58:		Line 59:

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

JAL2 at 19:14, 6 June 2011

2011-06-06T19:14:39Z

← Older revision		Revision as of 19:14, 6 June 2011
Line 59:		Line 59:
	==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>

JAL2 at 19:09, 6 June 2011

2011-06-06T19:09:36Z

← Older revision		Revision as of 19:09, 6 June 2011
Line 9:		Line 9:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string or <var>~~longstring~~</var> that identifies the node identified by <var class="term">selectionXpath</var>.</td></tr>		<td>A string or <var>Longstring</var> that identifies 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 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 is an EBCDIC string.</td></tr>

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 57:		Line 57:
	</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 57:		Line 57:
	</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.

JAL2 at 21:05, 23 May 2011

2011-05-23T21:05:48Z

← Older revision		Revision as of 21:05, 23 May 2011
Line 2:		Line 2:
	<var>ToXPathString </var> returns, in a string, an absolute XPath expression that identifies the node that a given XPath expression actually selects. <var>ToXPathString</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 </var> returns, in a string, an absolute XPath expression that identifies the node that a given XPath expression actually selects. <var>ToXPathString</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</var> is the same as <var>[[XPathNodeID (XmlDoc/XmlNode function)\|XPathNodeID]]</var> except its output is a string instead of a <var>Stringlist</var> (<var>ToXPathStringlist</var> is a synonym for <var>XPathNodeID</var>). <var>ToXPathString</var> lets <var class="product">[[SirFact~~\|"Sirfact"]~~]</var>, <var class="product">[[~~Janus~~ Debugger\|"Janus Debugger"]]</var>, and <var class="product">[[~~Sirius~~ Debugger\|"Sirius Debugger"]]</var> users extract XPath information when needed. The <var>XPathNodeID</var> method does not work in those environments because of its object (<var>Stringlist</var>) output.		<var>ToXPathString</var> is the same as <var>[[XPathNodeID (XmlDoc/XmlNode function)\|XPathNodeID]]</var> except its output is a string instead of a <var>Stringlist</var> (<var>ToXPathStringlist</var> is a synonym for <var>XPathNodeID</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. The <var>XPathNodeID</var> method does not work in those environments because of its object (<var>Stringlist</var>) output.

	==Syntax==		==Syntax==
Line 13:		Line 13:
	<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 Root node is the context node. </td></tr>
	<tr><th>selectionXpath</th>		<tr><th>selectionXpath</th>
	<td>A <var>Unicode</var> string that is an ~~<var>~~[[XPath#XPath_syntax\|Xpath expression]]~~</var>~~ that selects a node from the method object. 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 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 is an EBCDIC string.</td></tr>
	</table>		</table>

Line 23:		Line 23:
	'''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>ToXPathString</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>ToXPathString</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 [[SelectionNamespace (XmlDoc property)\|SelectionNamespace]]). 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>ToXPathString</var> is available in <var class="product">~~[[Sirius Mods\|"~~Sirius Mods~~"]]~~</var> Version 7.3 and later.		<li><var>ToXPathString</var> is available in <var class="product">Sirius Mods</var> Version 7.3 and later.
	</ul>		</ul>

	==Examples==		==Examples==
	~~<ol><li>~~The following document contained in an <var>XmlDoc</var> is used as the method object for <var>ToXPathString</var>:		The following document contained in an <var>XmlDoc</var> is used as the method object for <var>ToXPathString</var>:
	<p class="code"><nowiki><a>		<p class="code"><nowiki><a>
	<?p1?>		<?p1?>
Line 55:		Line 55:
	/[2] /a/x:a x u:a		/[2] /a/x:a x u:a
	/[2]/*[2] /a/x:a/_xpID.00:y x u:a _xpID.00 u:c		/[2]/*[2] /a/x:a/_xpID.00:y x u:a _xpID.00 u:c
	</nowiki></p~~></ol~~>		</nowiki></p>

	==Request-Cancellation Errors==		==Request-Cancellation Errors==

Goff: xpath expression

2011-05-22T09:30:27Z

xpath expression

← Older revision		Revision as of 09:30, 22 May 2011
Line 13:		Line 13:
	<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 Root node is the context node. </td></tr>
	<tr><th>selectionXpath</th>		<tr><th>selectionXpath</th>
	<td>A <var>Unicode</var> string that is an <var>[[XPath]]</var> ~~expression~~ that selects a node from the method object. 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 that is an <var>[[XPath#XPath_syntax\|Xpath expression]]</var> that selects a node from the method object. Prior to <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6, this is an EBCDIC string.</td></tr>
	</table>		</table>