Prefix (XmlDoc/XmlNode function): Difference between revisions
Jump to navigation
Jump to search
m (move footer template to actual end; edits, tags and links) |
mNo edit summary |
||
| 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 | <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 < | <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== | ||
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 | </p> | ||
==Request- | ==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. | ||
Revision as of 20:21, 3 June 2011
Prefix part of name of selected node (XmlDoc and XmlNode classes)
Prefix returns the "prefix" (that is, the part of the name before the colon) of the node that is the head of an XPath result.
Syntax
%unicode = nr:Prefix[( [xpath])] Throws XPathError
Syntax terms
| %unicode | A string variable for the returned prefix. |
|---|---|
| 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).
Prior to Sirius Mods Version 7.6, this is an EBCDIC string. |
Usage notes
- The prefix is defined to be:
- The element-type or attribute name prefix if the node is an Element or Attribute, respectively.
- The null string, otherwise.
- This function may only be used if the XmlDoc's Namespace property value is On.
Examples
In the following example, two nodes are added to an XmlDoc and their name prefixes, one of which is the null string, are printed.
begin %d object xmlDoc %d = new %n1 object xmlNode %n1 = %d:addElement('foo:bar', , 'ftp:here') print 'Prefix =' and %n1:prefix %n1 = %n1:addElement('junk') print 'Prefix =' and %n1:prefix end
The example result follows:
Prefix = foo Prefix =
Request-cancellation errors
- XmlDoc Namespace property not On.
- The 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: