IsSelectionPrefix (XmlDoc function): Difference between revisions
Jump to navigation
Jump to search
m (move footer template to actual end (otherwise subsequent intervening text gets omitted); edits, tags and links) |
m (move footer template to actual end (otherwise subsequent intervening text gets omitted); edits, tags and links) |
||
| Line 11: | Line 11: | ||
<td>An <var>XmlDoc</var> object expression. </td></tr> | <td>An <var>XmlDoc</var> object expression. </td></tr> | ||
<tr><th>prefix</th> | <tr><th>prefix</th> | ||
<td>A string prefix (the part of the name before the colon) for a node. This is a <var>Unicode</var> string argument; prior to <var class="product">[[Sirius Mods| | <td>A string prefix (the part of the name before the colon) for a node. This is a <var>Unicode</var> string argument; prior to <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.6, this is an EBCDIC string. Its length must be at most 255 characters.</td></tr> | ||
</table> | </table> | ||
| Line 17: | Line 17: | ||
<ul> | <ul> | ||
<li><var>IsSelectionPrefix</var> has no cancellation conditions other than the usual requirement that the method obj8ect not be Null. | <li><var>IsSelectionPrefix</var> has no cancellation conditions other than the usual requirement that the method obj8ect not be Null. | ||
<li><var>IsSelectionPrefix</var> is available in <var class="product">[[Sirius Mods| | <li><var>IsSelectionPrefix</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.0 and later. | ||
</ul> | </ul> | ||
Revision as of 17:45, 4 May 2011
Check if prefix has XPath-selection association (XmlDoc class)
IsSelectionPrefix determines whether its argument is a prefix that can be used in an XPath expression. IsSelectionPrefix returns the value True if its argument is currently associated (either with the null string or with a namespace URI) as a prefix that you can use in an XPath expression. Otherwise, it returns False.
Syntax
%boolean = doc:IsSelectionPrefix( prefix)
Syntax terms
| %boolean | A declared enumeration object of type Boolean to contain the returned value (True or False) of IsSelectionPrefix. For more information about enumerations, see Enumerations. |
|---|---|
| doc | An XmlDoc object expression. |
| prefix | A string prefix (the part of the name before the colon) for a node. This is a Unicode string argument; prior to Sirius Mods Version 7.6, this is an EBCDIC string. Its length must be at most 255 characters. |
Usage notes
- IsSelectionPrefix has no cancellation conditions other than the usual requirement that the method obj8ect not be Null.
- IsSelectionPrefix is available in Sirius Mods Version 7.0 and later.
Examples
- In the following example fragment, the code is testing for a new prefix to use in an XPath expression, to avoid having to change any existing prefix associations:
... for %i from 1 to 100 if %doc:isSelectionPrefix('p' With %i) eq false then loop end end if end for %doc:selectionNamespace('p' with %i) = 'urn:localxxx' %node = %inpNode:selectSingleNode(%p With %i - with ':infoChild') %doc:deleteSelectionPrefix('p' with %i) ...
See also
- DeleteSelectionPrefix method is useful in conjunction with IsSelectionPrefix to delete the selected subtree.
- SelectionNamespace specifies the namespace URI associated with a prefix, when the prefix is used in an XPath expression.