Prefix (XmlDoc/XmlNode function) - Revision history

JAL: xpath arg

2015-02-18T17:41:21Z

xpath arg

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

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%unicode</th>		<tr><th>%unicode</th>
	<td>A string variable for the returned prefix.</td></tr>		<td>A string variable for the returned prefix.</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#XPath_syntax\|XPath expression]] that results in a nodelist. The head of the nodelist is the node to process. An optional argument, its default is a period (<tt>.</tt>), that is, the node referenced by the method object (<var class="term">nr</var>).		<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>Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>		<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>
			<p>
			Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>
	</table>		</table>

Line 51:		Line 57:
	==See also==		==See also==
	<ul>		<ul>
	<li>For more information about using XPath expressions, see [[XPath~~\|"XPath"~~]].		<li>For more information about using XPath expressions, see [[XPath]].</li>

	<li>These methods also obtain information about the name of a node:		<li>These methods also obtain information about the name of a node:
	<ul>		<ul>
	<li><var>[[LocalName (XmlDoc/XmlNode function)\|LocalName]]</var>		<li><var>[[LocalName (XmlDoc/XmlNode function)\|LocalName]]</var></li>
	<li><var>[[QName (XmlDoc/XmlNode function)\|QName]]</var>		<li><var>[[QName (XmlDoc/XmlNode function)\|QName]]</var></li>
	<li><var>[[URI (XmlDoc/XmlNode function)\|URI]]</var>		<li><var>[[URI (XmlDoc/XmlNode function)\|URI]]</var></li>
	</ul>		</ul></li>
	</ul>		</ul>

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

JAL: /* Request-cancellation errors */

2014-03-03T20:55:21Z

Request-cancellation errors

← Older revision		Revision as of 20:55, 3 March 2014
Line 41:		Line 41:

	==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>XmlDoc</var> <var>Namespace</var> property not <var>On</var>.		<li><var>XmlDoc</var> <var>Namespace</var> property not <var>On</var>.

JAL2 at 20:21, 3 June 2011

2011-06-03T20:21:22Z

← Older revision		Revision as of 20:21, 3 June 2011
Line 9:		Line 9:
	<td>A string variable for the returned prefix.</td></tr>		<td>A string variable for the returned prefix.</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 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">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 ~~<var>~~nodelist~~</var>~~. The head of the ~~<var>~~nodelist~~</var>~~ is the ~~<var>~~node~~</var>~~ to process. An optional argument, its default is a period (<~~code~~>.</~~code~~>), that is, the node referenced by the method object (<var class="term">nr</var>).		<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. An optional argument, 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.</p></td></tr>		<p>Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>
	</table>		</table>
Line 20:		Line 20:
	<li>The null string, otherwise.		<li>The null string, otherwise.
	</ul>		</ul>
	<li>This function may only be used if the <var>XmlDoc</var>'s <var>[[Namespace (XmlDoc property)\|Namespace]]</var> property is <~~code~~>On</~~code~~>.		<li>This function may only be used if the <var>XmlDoc</var>'s <var>[[Namespace (XmlDoc property)\|Namespace]]</var> property value is <var>On</var>.
	</ul>		</ul>

	==Examples==		==Examples==
	~~<ol><li>~~In the following example, two nodes are added to an <var>XmlDoc</var> and their name prefixes, one of which is the null string, are printed.		In the following example, two nodes are added to an <var>XmlDoc</var> and their name prefixes, one of which is the null string, are printed.
	<p class="code">begin		<p class="code">begin
	%d object xmlDoc		%d object xmlDoc
Line 38:		Line 38:
	<p class="output">Prefix = foo		<p class="output">Prefix = foo
	Prefix =		Prefix =
	</p~~></ol~~>		</p>

	==Request-~~Cancellation Errors~~==		==Request-cancellation errors==
	<ul>		<ul>
	<li><var>XmlDoc</var> <var>Namespace</var> property not <var>On</var>.		<li><var>XmlDoc</var> <var>Namespace</var> property not <var>On</var>.
	<li><var class="term">xpath</var> is invalid.		<li>The <var class="term">xpath</var> expression is invalid.
	<li>Result of <var class="term">xpath</var> is empty.		<li>Result of <var class="term">xpath</var> is empty.
	<li>Insufficient free space exists in CCATEMP.		<li>Insufficient free space exists in CCATEMP.

Goff: move footer template to actual end; edits, tags and links

2011-05-29T02:59:15Z

move footer template to actual end; edits, tags and links

← Older revision		Revision as of 02:59, 29 May 2011
Line 1:		Line 1:
	{{Template:XmlDoc/XmlNode:Prefix subtitle}}		{{Template:XmlDoc/XmlNode:Prefix subtitle}}
			<var>Prefix</var> returns the "prefix" (that is, the part of the name before the colon) of the node that is the head of an XPath result.

	~~This function gets the "prefix" (that is, the part of the name~~
	~~before the colon) of the node that is the head of an XPath result.~~
	==Syntax==		==Syntax==
	{{Template:XmlDoc/XmlNode:Prefix syntax}}		{{Template:XmlDoc/XmlNode:Prefix syntax}}
Line 8:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%unicode</th>		<tr><th>%unicode</th>
	<td>A string variable for the returned prefix. </td></tr>		<td>A string variable for the returned prefix.</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 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">xpath</var> expression. If an <var>XmlDoc</var>, the Root 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. An optional argument, its default is a period (<tt>.</tt>), that is, the node referenced by the method object (<i>nr</i>).		<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|XPath expression]] that results in a <var>nodelist</var>. The head of the <var>nodelist</var> is the <var>node</var> to process. An optional argument, its default is a period (<code>.</code>), 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.</p></td></tr>
	Prior to <var class="product">Sirius Mods</var> ~~version~~ 7.6, this is an EBCDIC string.</td></tr>

	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul><li>The prefix is defined to be:
	<li>The prefix is defined to be:		<ul><li>The element-type or attribute name prefix if the node is an <var>Element</var> or <var>Attribute</var>, respectively.
	<ul>
	<li>The element-type or attribute name prefix
	if the node is an <var>Element</var> or <var>Attribute</var>, respectively.
	<li>The null string, otherwise.		<li>The null string, otherwise.
	</ul>		</ul>
	<li>This function may only be used if the <var>XmlDoc</var>'s <var>[[Namespace (XmlDoc property)\|Namespace]]</var> property is <~~var~~>On</~~var~~>.		<li>This function may only be used if the <var>XmlDoc</var>'s <var>[[Namespace (XmlDoc property)\|Namespace]]</var> property is <code>On</code>.
	</ul>		</ul>

	==~~=Example=~~==		==Examples==
			<ol><li>In the following example, two nodes are added to an <var>XmlDoc</var> and their name prefixes, one of which is the null string, are printed.
	In the following example, two nodes are added to an <var>XmlDoc</var> and their name		<p class="code">begin
	prefixes, one of which is the null string, are printed.		%d object xmlDoc
	<p class="code">~~Begin~~		%d = new
	%d ~~Object XmlDoc~~		%n1 object xmlNode
	%d = ~~New~~		%n1 = %d:[[AddElement_(XmlDoc/XmlNode_function)\|addElement]]('foo:bar', , 'ftp:here')
	%n1 ~~Object XmlNode~~		print 'Prefix =' and %n1:prefix
	%n1 = %d:~~AddElement~~('foo:bar', , 'ftp:here')		%n1 = %n1:addElement('junk')
	~~Print~~ 'Prefix =' ~~And~~ %n1:~~Prefix~~		print 'Prefix =' and %n1:prefix
	%n1 = %n1:~~AddElement~~('junk')		end
	~~Print~~ 'Prefix =' ~~And~~ %n1:~~Prefix~~
	~~End~~
	</p>		</p>

	The example result follows:		The example result follows:
	<p class="output">Prefix = foo		<p class="output">Prefix = foo
	Prefix =		Prefix =
	</p>		</p></ol>

	===Request-Cancellation Errors===		==Request-Cancellation Errors==
	<ul>		<ul>
	<li><var>XmlDoc</var> <var>Namespace</var> property not <var>On</var>.		<li><var>XmlDoc</var> <var>Namespace</var> property not <var>On</var>.
Line 58:		Line 49:

	==See also==		==See also==
	~~{{Template:XmlDoc/XmlNode:Prefix footer}}~~
	<ul>		<ul>
	<li>For more information about using XPath expressions, see [[XPath\|"XPath"]].		<li>For more information about using XPath expressions, see [[XPath\|"XPath"]].
Line 68:		Line 58:
	</ul>		</ul>
	</ul>		</ul>
			{{Template:XmlDoc/XmlNode:Prefix footer}}

JAL2 at 20:59, 24 May 2011

2011-05-24T20:59:03Z

← Older revision		Revision as of 20:59, 24 May 2011
Line 12:		Line 12:
	<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 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">xpath</var> expression. If an <var>XmlDoc</var>, the Root 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. An optional argument, its default is a period (.), that is, the node referenced by the method object (<i>nr</i>).		<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. An optional argument, its default is a period (<tt>.</tt>), that is, the node referenced by the method object (<i>nr</i>).

	Prior to ''Sirius Mods'' version 7.6, this is an EBCDIC string.</td></tr>		Prior to <var class="product">Sirius Mods</var> version 7.6, this is an EBCDIC string.</td></tr>

	</table>		</table>
Line 34:		Line 34:
	prefixes, one of which is the null string, are printed.		prefixes, one of which is the null string, are printed.
	<p class="code">Begin		<p class="code">Begin
	%d ~~<var>~~Object~~</var> <var>~~XmlDoc~~</var>~~		%d Object XmlDoc
	%d = New		%d = New
	%n1 ~~<var>~~Object~~</var> <var>~~XmlNode~~</var>~~		%n1 Object XmlNode
	%n1 = %d:AddElement('foo:bar', , 'ftp:here')		%n1 = %d:AddElement('foo:bar', , 'ftp:here')
	Print '~~<var>~~Prefix~~</var>~~ =' And %n1:~~<var>~~Prefix~~</var>~~		Print 'Prefix =' And %n1:Prefix
	%n1 = %n1:AddElement('junk')		%n1 = %n1:AddElement('junk')
	Print '~~<var>~~Prefix~~</var>~~ =' And %n1:~~<var>~~Prefix~~</var>~~		Print 'Prefix =' And %n1:Prefix
	End		End
	</p>		</p>

	The example result follows:		The example result follows:
	<p class="output"~~><var~~>Prefix~~</var>~~ = foo		<p class="output">Prefix = foo
	~~<var>~~Prefix~~</var>~~ =		Prefix =
	</p>		</p>

Line 60:		Line 60:
	{{Template:XmlDoc/XmlNode:Prefix footer}}		{{Template:XmlDoc/XmlNode:Prefix footer}}
	<ul>		<ul>
	<li>For more information about using XPath expressions, see [[XPath]].		<li>For more information about using XPath expressions, see [[XPath\|"XPath"]].
	<li>These methods also obtain information about the name of a node:		<li>These methods also obtain information about the name of a node:
	<ul>		<ul>
	<li>[[LocalName (XmlDoc/XmlNode function)\|LocalName]]		<li><var>[[LocalName (XmlDoc/XmlNode function)\|LocalName]]</var>
	<li>[[QName (XmlDoc/XmlNode function)\|QName]]		<li><var>[[QName (XmlDoc/XmlNode function)\|QName]]</var>
	<li>[[URI (XmlDoc/XmlNode function)\|URI]]		<li><var>[[URI (XmlDoc/XmlNode function)\|URI]]</var>
	</ul>		</ul>
	</ul>		</ul>

JAL2: /* Usage notes */

2011-05-24T20:54:10Z

Usage notes

← Older revision		Revision as of 20:54, 24 May 2011
Line 23:		Line 23:
	<ul>		<ul>
	<li>The element-type or attribute name prefix		<li>The element-type or attribute name prefix
	if the node is an Element or Attribute, respectively.		if the node is an <var>Element</var> or <var>Attribute</var>, respectively.
	<li>The null string, otherwise.		<li>The null string, otherwise.
	</ul>		</ul>
	<li>This function may only be used if the <var>XmlDoc</var>'s Namespace property is <tt>On</tt>.		<li>This function may only be used if the <var>XmlDoc</var>'s <var>[[Namespace (XmlDoc property)\|Namespace]]</var> property is <var>On</var>.
	</ul>		</ul>

Line 51:		Line 51:
	===Request-Cancellation Errors===		===Request-Cancellation Errors===
	<ul>		<ul>
	<li><var>XmlDoc</var> Namespace property not <tt>On</tt>.		<li><var>XmlDoc</var> <var>Namespace</var> property not <var>On</var>.
	<li><i>~~XPath~~</i> is invalid.		<li><var class="term">xpath</var> is invalid.
	<li>Result of (<i>~~XPath~~</i>) is empty.		<li>Result of <var class="term">xpath</var> is empty.
	<li>Insufficient free space exists in CCATEMP.		<li>Insufficient free space exists in CCATEMP.
	</ul>		</ul>


	==See also==		==See also==

JALWiccan: 1 revision

2011-05-24T15:57:08Z

1 revision

← Older revision	Revision as of 15:57, 24 May 2011
(No difference)

JAL2 at 15:57, 24 May 2011

2011-05-24T15:57:07Z

← Older revision		Revision as of 15:57, 24 May 2011
Line 12:		Line 12:
	<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 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">xpath</var> expression. If an <var>XmlDoc</var>, the Root 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 nodelist. The head of the nodelist is the node to process. An optional argument, its default is a period (.), that is, the node referenced by the method object (<i>nr</i>).		<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. An optional argument, its default is a period (.), that is, the node referenced by the method object (<i>nr</i>).

	Prior to ''Sirius Mods'' version 7.6, this is an EBCDIC string.</td></tr>		Prior to ''Sirius Mods'' version 7.6, this is an EBCDIC string.</td></tr>

JAL2 at 15:56, 24 May 2011

2011-05-24T15:56:47Z

← Older revision		Revision as of 15:56, 24 May 2011
Line 12:		Line 12:
	<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 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">xpath</var> expression. If an <var>XmlDoc</var>, the Root 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 nodelist. The head of the nodelist is the node to process. An optional argument, its default is a period (.), that is, the node referenced by the method object (<i>nr</i>).		<td>A <var>Unicode</var> string that is an <var>[[XPath#XPath_syntax\|Xpath expression]]</var> that results in a nodelist. The head of the nodelist is the node to process. An optional argument, its default is a period (.), that is, the node referenced by the method object (<i>nr</i>).

	Prior to ''Sirius Mods'' version 7.6, this is an EBCDIC string.</td></tr>		Prior to ''Sirius Mods'' version 7.6, this is an EBCDIC string.</td></tr>

Goff: xpath expression

2011-05-22T09:16:39Z

xpath expression

New page

{{Template:XmlDoc/XmlNode:Prefix subtitle}}

This function gets the "prefix" (that is, the part of the name
before the colon) of the node that is the head of an XPath result.
==Syntax==
{{Template:XmlDoc/XmlNode:Prefix syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%unicode</th>
<td>A string variable for the returned prefix. </td></tr>
<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 Root node is the context node. </td></tr>
<tr><th>xpath</th>
<td>A <var>Unicode</var> string that is an<var>[[XPath#XPath_syntax|Xpath expression]]</var> that results in a nodelist. The head of the nodelist is the node to process. An optional argument, its default is a period (.), that is, the node referenced by the method object (nr).

Prior to ''Sirius Mods'' version 7.6, this is an EBCDIC string.</td></tr>

</table>

==Usage notes==
<ul>
<li>The prefix is defined to be:
<ul>
<li>The element-type or attribute name prefix
if the node is an Element or Attribute, respectively.
<li>The null string, otherwise.
</ul>
<li>This function may only be used if the <var>XmlDoc</var>'s Namespace property is <tt>On</tt>.
</ul>

===Example===

In the following example, two nodes are added to an <var>XmlDoc</var> and their name
prefixes, one of which is the null string, are printed.
Begin
%d <var>Object</var> <var>XmlDoc</var>
%d = New
%n1 <var>Object</var> <var>XmlNode</var>
%n1 = %d:AddElement('foo:bar', , 'ftp:here')
Print '<var>Prefix</var> =' And %n1:<var>Prefix</var>
%n1 = %n1:AddElement('junk')
Print '<var>Prefix</var> =' And %n1:<var>Prefix</var>
End


The example result follows:
<var>Prefix</var> = foo
<var>Prefix</var> =


===Request-Cancellation Errors===
<ul>
<li><var>XmlDoc</var> Namespace property not <tt>On</tt>.
<li>XPath is invalid.
<li>Result of (XPath) is empty.
<li>Insufficient free space exists in CCATEMP.
</ul>

==See also==
{{Template:XmlDoc/XmlNode:Prefix footer}}
<ul>
<li>For more information about using XPath expressions, see [[XPath]].
<li>These methods also obtain information about the name of a node:
<ul>
<li>[[LocalName (XmlDoc/XmlNode function)|LocalName]]
<li>[[QName (XmlDoc/XmlNode function)|QName]]
<li>[[URI (XmlDoc/XmlNode function)|URI]]
</ul>
</ul>