Prefix (XmlDoc/XmlNode function)

Prefix part of name of selected node (XmlDoc and XmlNode classes)

Prefix is a member of the XmlDoc and XmlNode classes.

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

%unicode = nr:Prefix[( [xpath])] Throws XPathError

Syntax terms

%pref

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 is On.

Example

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.
• XPath 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:
  • LocalName
  • QName
  • URI