QName (XmlDoc/XmlNode function) - Revision history

JAL: xpath arg

2015-02-18T17:45:00Z

xpath arg

← Older revision		Revision as of 17:45, 18 February 2015
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:XmlDoc/XmlNode:QName syntax}}		{{Template:XmlDoc/XmlNode:QName 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 name.</td></tr>		<td>A <var>Unicode</var> string variable for the returned name.</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>An [[XPath#XPath_syntax\|XPath expression]] that results in a nodelist, the head of which 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></tr>		<td>An [[XPath#XPath_syntax\|XPath expression]] that results in a nodelist, the head of which 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></td></tr>
	</table>		</table>

Line 18:		Line 23:
	<li>The fully qualified name is defined to be:		<li>The fully qualified name is defined to be:
	<ul>		<ul>
	<li>The element-type or attribute name prefix and colon, if there is one, followed by the local name, if the node is an <var>Element</var> or <var>Attribute</var>, respectively.		<li>The element-type or attribute name prefix and colon, if there is one, followed by the local name, if the node is an <var>Element</var> or <var>Attribute</var>, respectively.</li>
	<li>The processing instruction's target, if the node is a <var>PI</var>.		<li>The processing instruction's target, if the node is a <var>PI</var>.</li>
	<li>Other node types will return the null string.		<li>Other node types will return the null string.</li>
	</ul>		</ul></li>
	<li>This function may be used with any value of the <var>XmlDoc</var>'s <var>[[Namespace (XmlDoc property)\|Namespace]]</var> property.
	<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, the <var>QName</var> method argument 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]]</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>This function may be used with any value of the <var>XmlDoc</var>'s <var>[[Namespace (XmlDoc property)\|Namespace]]</var> property.</li>

			<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, the <var>QName</var> method argument 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]]</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>
	</ul>		</ul>

Line 54:		Line 61:
	==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>[[Prefix (XmlDoc/XmlNode function)\|Prefix]]</var>		<li><var>[[Prefix (XmlDoc/XmlNode function)\|Prefix]]</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:QName footer}}		{{Template:XmlDoc/XmlNode:QName footer}}

JAL: /* Request-cancellation errors */

2014-03-03T21:00:34Z

Request-cancellation errors

← Older revision		Revision as of 21:00, 3 March 2014
Line 45:		Line 45:

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

JAL2 at 15:32, 6 June 2011

2011-06-06T15:32:07Z

← Older revision		Revision as of 15:32, 6 June 2011
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>An [[XPath#XPath_syntax\|XPath expression]] that results in a ~~<var>~~nodelist~~</var>~~, the head of which is the node 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></tr>		<td>An [[XPath#XPath_syntax\|XPath expression]] that results in a nodelist, the head of which 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></tr>
	</table>		</table>

Line 27:		Line 27:

	==Example==		==Example==
	~~<ol><li>~~In the following example, the entire names of both elements are printed:		In the following example, the entire names of both elements are printed:
	<p class="code">begin		<p class="code">begin
	%d object xmlDoc		%d object xmlDoc
Line 42:		Line 42:
	<p class="output">foo:bar		<p class="output">foo:bar
	junk		junk
	</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.

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

2011-05-29T03:45:09Z

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

← Older revision		Revision as of 03:45, 29 May 2011
Line 1:		Line 1:
	{{Template:XmlDoc/XmlNode:QName subtitle}}		{{Template:XmlDoc/XmlNode:QName subtitle}}
			<var>QName</var> returns the "fully qualified name" (that is, the entire name as it was specified) of the node that is the head of an [[XPath]] result.

	~~This function gets the "fully qualified name" (that is, the~~
	~~entire name as it was specified)~~
	~~of the node that is the head of an XPath result.~~
	==Syntax==		==Syntax==
	{{Template:XmlDoc/XmlNode:QName syntax}}		{{Template:XmlDoc/XmlNode:QName syntax}}
Line 9:		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 name. </td></tr>		<td>A <var>Unicode</var> string variable for the returned name.</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>An [[XPath#XPath_syntax\|XPath expression]] that results in a nodelist, the head of which 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></tr>		<td>An [[XPath#XPath_syntax\|XPath expression]] that results in a <var>nodelist</var>, the head of which is the node 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></tr>
	</table>		</table>

Line 20:		Line 18:
	<li>The fully qualified name is defined to be:		<li>The fully qualified name is defined to be:
	<ul>		<ul>
	<li>The element-type or attribute name prefix and colon, if there is one, followed		<li>The element-type or attribute name prefix and colon, if there is one, followed by the local name, if the node is an <var>Element</var> or <var>Attribute</var>, respectively.
	by the local name,
	if the node is an <var>Element</var> or <var>Attribute</var>, respectively.
	<li>The processing instruction's target, if the node is a <var>PI</var>.		<li>The processing instruction's target, if the node is a <var>PI</var>.
	<li>Other node types will return the null string.		<li>Other node types will return the null string.
	</ul>		</ul>
	<li>This function may be used with any value of the		<li>This function may be used with any value of the <var>XmlDoc</var>'s <var>[[Namespace (XmlDoc property)\|Namespace]]</var> property.
	<var>XmlDoc</var>'s <var>[[Namespace (XmlDoc property)\|Namespace]]</var> property.		<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, the <var>QName</var> method argument 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]]</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, the <var>QName</var> method argument 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]]</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"]].
	</ul>		</ul>

	==Example==		==Example==
			<ol><li>In the following example, the entire names of both elements are printed:
	In the following example, the entire names of both elements are printed:		<p class="code">begin
	<p class="code">~~Begin~~		%d object xmlDoc
	%d ~~<var>Object</var> <var>XmlDoc</var>~~		%d = new
	%d = ~~New~~		%n1 object xmlNode
	%n1 ~~<var>Object</var> <var>XmlNode</var>~~		%n2 object xmlNode
	%n2 ~~<var>Object</var> <var>XmlNode</var>~~		%n1 = %d:[[AddElement_(XmlDoc/XmlNode_function)\|addElement]]('foo:bar', , 'ftp:here')
	%n1 = %d:~~AddElement~~('foo:bar', , 'ftp:here')		print %n1:qName
	~~Print~~ %n1:~~<var>QName</var>~~		%n1 = %n1:AddElement('junk')
	%n1 = %n1:AddElement('junk')		print %n1:qQName
	~~Print~~ %n1:~~<var>QName</var>~~		end
	~~End~~
	</p>		</p>

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

	==Request-Cancellation Errors==		==Request-Cancellation Errors==
Line 62:		Line 50:
	<li>Insufficient free space exists in CCATEMP.		<li>Insufficient free space exists in CCATEMP.
	</ul>		</ul>


	==See also==		==See also==
	~~{{Template:XmlDoc/XmlNode:QName 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 75:		Line 61:
	</ul>		</ul>
	</ul>		</ul>
			{{Template:XmlDoc/XmlNode:QName footer}}

JAL2 at 00:14, 24 May 2011

2011-05-24T00:14:15Z

← Older revision		Revision as of 00:14, 24 May 2011
Line 36:		Line 36:
	</ul>		</ul>

	===Example===		==Example==

	In the following example, the entire names of both elements are printed:		In the following example, the entire names of both elements are printed:
Line 56:		Line 56:
	</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 at 00:13, 24 May 2011

2011-05-24T00:13:14Z

← Older revision		Revision as of 00:13, 24 May 2011
Line 11:		Line 11:
	<td>A <var>Unicode</var> string variable for the returned name. </td></tr>		<td>A <var>Unicode</var> string variable for the returned name. </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>An ~~<var>~~[[XPath#XPath_syntax\|~~Xpath~~ expression]]~~</var> which~~ results in a nodelist, the head of which 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></tr>		<td>An [[XPath#XPath_syntax\|XPath expression]] that results in a nodelist, the head of which 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></tr>
	</table>		</table>

Line 22:		Line 22:
	<li>The element-type or attribute name prefix and colon, if there is one, followed		<li>The element-type or attribute name prefix and colon, if there is one, followed
	by the local name,		by the local name,
	if the node is an Element or Attribute, respectively.		if the node is an <var>Element</var> or <var>Attribute</var>, respectively.
	<li>The processing instruction's target, if the node is a PI.		<li>The processing instruction's target, if the node is a <var>PI</var>.
	<li>Other node types will return the null string.		<li>Other node types will return the null string.
	</ul>		</ul>
	<li>This function may be used with any value of the		<li>This function may be used with any value of the
	<var>XmlDoc</var>'s Namespace property.		<var>XmlDoc</var>'s <var>[[Namespace (XmlDoc property)\|Namespace]]</var> property.
	<li>As of ''Sirius Mods'' version 7.3, the <var>QName</var> method argument may		<li>As of <var class="product">Sirius Mods</var> version 7.3, the <var>QName</var> method argument may
	include only non-null EBCDIC characters that translate to <var>Unicode</var>.		include only non-null EBCDIC characters that translate to <var>Unicode</var>.
	As of ''Sirius Mods'' version 7.6, all [[Janus SOAP]] string arguments and results are <var>Unicode</var>		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>.		or are converted to <var>Unicode</var>.
	For more information about the effects of this version 7.6		For more information about the effects of this version 7.6
	change, see [[Strings and Unicode]].		change, see [[XmlDoc API#Strings and Unicode with the XmlDoc API\|"Strings and Unicode with the XmlDoc API"]].
	</ul>		</ul>

Line 58:		Line 58:
	===Request-Cancellation Errors===		===Request-Cancellation Errors===
	<ul>		<ul>
	<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>
Line 67:		Line 67:
	{{Template:XmlDoc/XmlNode:QName footer}}		{{Template:XmlDoc/XmlNode:QName 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>[[Prefix (XmlDoc/XmlNode function)\|Prefix]]		<li><var>[[Prefix (XmlDoc/XmlNode function)\|Prefix]]</var>
	<li>[[URI (XmlDoc/XmlNode function)\|URI]]		<li><var>[[URI (XmlDoc/XmlNode function)\|URI]]</var>
	</ul>		</ul>
	</ul>		</ul>

Goff: xpath expression

2011-05-22T09:18:09Z

xpath expression

New page

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

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

==Usage notes==
<ul>
<li>The fully qualified name is defined to be:
<ul>
<li>The element-type or attribute name prefix and colon, if there is one, followed
by the local name,
if the node is an Element or Attribute, respectively.
<li>The processing instruction's target, if the node is a PI.
<li>Other node types will return the null string.
</ul>
<li>This function may be used with any value of the
<var>XmlDoc</var>'s Namespace property.
<li>As of ''Sirius Mods'' version 7.3, the <var>QName</var> method argument may
include only non-null EBCDIC characters that translate to <var>Unicode</var>.
As of ''Sirius Mods'' version 7.6, all [[Janus SOAP]] 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 [[Strings and Unicode]].
</ul>

===Example===

In the following example, the entire names of both elements are printed:
Begin
%d <var>Object</var> <var>XmlDoc</var>
%d = New
%n1 <var>Object</var> <var>XmlNode</var>
%n2 <var>Object</var> <var>XmlNode</var>
%n1 = %d:AddElement('foo:bar', , 'ftp:here')
Print %n1:<var>QName</var>
%n1 = %n1:AddElement('junk')
Print %n1:<var>QName</var>
End


The example result follows:
foo:bar
junk


===Request-Cancellation Errors===
<ul>
<li>XPath is invalid.
<li>Result of (XPath) is empty.
<li>Insufficient free space exists in CCATEMP.
</ul>

==See also==
{{Template:XmlDoc/XmlNode:QName 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>[[Prefix (XmlDoc/XmlNode function)|Prefix]]
<li>[[URI (XmlDoc/XmlNode function)|URI]]
</ul>
</ul>

Wiccan: 1 revision

2011-02-08T16:54:09Z

1 revision

← Older revision	Revision as of 16:54, 8 February 2011
(No difference)

Wiccan: 1 revision

2011-02-08T16:54:08Z

1 revision

← Older revision		Revision as of 16:54, 8 February 2011
Line 7:		Line 7:
	{{Template:XmlDoc/XmlNode:QName syntax}}		{{Template:XmlDoc/XmlNode:QName syntax}}
	===Syntax terms===		===Syntax terms===
	<dl>		<table class="syntaxTable">
	<dt>%name		<tr><th>%name</th>
	<dd>A <var>Unicode</var> string variable for the returned name.		<td>A <var>Unicode</var> string variable for the returned name. </td></tr>
	<dt>nr		<tr><th>nr</th>
	<dd>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the		<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <i>XPath</i> expression. If an <var>XmlDoc</var>, the Root node is the context node. </td></tr>
	<i>XPath</i> expression.		<tr><th>XPath</th>
	If an <var>XmlDoc</var>, the Root node is the context node.		<td>An XPath expression which results in a nodelist, the head of which 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></tr>
	<dt>XPath		</table>
	<dd>An XPath expression which results in a nodelist, the head of which 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>).

	</dl>

	==Usage notes==		==Usage notes==

Wiccan: 1 revision

2011-01-25T17:46:33Z

1 revision

← Older revision	Revision as of 17:46, 25 January 2011
(No difference)