URI (XmlDoc/XmlNode function): Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:XmlDoc/XmlNode:URI subtitle}} | {{Template:XmlDoc/XmlNode:URI subtitle}} | ||
<var>URI</var> returns the "Uniform Resource Identifier" (URI) associated with the name of the node which is the head of an | <var>URI</var> returns the "Uniform Resource Identifier" (URI) associated with the name of the node which is the head of an [[XPath]] result. | ||
==Syntax== | ==Syntax== | ||
| Line 29: | Line 29: | ||
==Examples== | ==Examples== | ||
In the following example, the | In the following example, the URI of the first element | ||
and the null string are printed: | and the null string are printed: | ||
<p class="code">begin | <p class="code">begin | ||
| Line 50: | Line 50: | ||
<ul> | <ul> | ||
<li><var>XmlDoc</var> <var>Namespace</var> property value not <var>On</var>. | <li><var>XmlDoc</var> <var>Namespace</var> property value not <var>On</var>. | ||
<li><var class="term">xpath</var> is invalid. | <li><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. | ||
Revision as of 19:25, 6 June 2011
Namespace URI of name of selected node (XmlDoc and XmlNode classes)
URI returns the "Uniform Resource Identifier" (URI) associated with the name of the node which is the head of an XPath result.
Syntax
%unicode = nr:URI[( [xpath])] Throws XPathError
Syntax terms
| %unicode | A Unicode string variable for the returned URI. Prior to Sirius Mods Version 7.6, this variable is an EBCDIC string. |
|---|---|
| nr | An XmlDoc or XmlNode, used as the context node for the xpath expression. If an XmlDoc, the Root node is the context node. |
| xpath | A Unicode string that is an 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 nr. |
Usage notes
- The Uniform Resource Identifier (URI) of a node is defined to be:
- The URI of the namespace declaration in scope for the prefix of the element-type or attribute name if there is one.
- The URI of the default namespace declaration in scope for an unprefix of element-type.
- The null string, otherwise.
- URI may only be used if the XmlDoc's Namespace property is On.
- Namespace-aware applications should use the namespace URI rather than the prefix to identify elements.
- As of Sirius Mods Version 7.3, the method's argument and result may include only non-null EBCDIC characters that translate to Unicode.
As of Sirius Mods Version 7.6, these strings are Unicode or are converted to Unicode. For more information about the effects of this Version 7.6 change, see "Strings and Unicode with the XmlDoc API".
Examples
In the following example, the URI of the first element and the null string are printed:
begin %d oject xmlDoc %d = new %n1 object xmlNode %n2 object xmlNode %n1 = %d:addElement('foo:bar', , 'ftp:here') print 'URI =' and %n1:URI %n1 = %n1:addElement('junk') print 'URI =' and %n1:URI end
The example result follows:
URI = ftp:here URI =
Request-cancellation errors
- XmlDoc Namespace property value not On.
- xpath expression is invalid.
- Result of (xpath) is empty.
- Insufficient free space exists in CCATEMP.
See also
- For more information about using XPath expressions, see "XPath".
- These methods also obtain information about the name of a node: