%XML_ELEM_GETNAME

Get the tag name of an XML element

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
status = %XML_ELEM_GETNAME(element, tag_name)

Return value

status

XML_SUCCESS if a nonblank name is returned.

Arguments

element

The XML element instance to get a tag name for. (XML_ELEM_TYPE)

tag_name

Returned with the tag name of the XML element as a string value. The maximum length is 256 characters. (a)

Discussion

Every XML element is represented by a start tag and an end tag delimiting its text and/or children. For example, if the start and end tags are <time> and </time>, the tag name is time. %XML_ELEM_GETNAME retrieves the tag name for the specified element instance.

This function is defined as ^VAL.

Examples

xcall xml_elem_getName(root, tagName)

For a complete example, see Example of parsing XML.