XML Functions

Use DAL XML API functions to let Documaker applications access specified XML documents and retrieve XML data via a DAL script. These functions are registered in keywords, called built-in functions. An XML built-in function performs an operation on a set of parameters and returns a DAL variable in one of the three types: list, integer, or string.

The XML functions are summarized in the table below. Click the function name to jump to a discussion of that function.

Function

Result

DestroyList

Destroys the XML tree created by the LoadXMLList function.

GetListElem

Returns a text string which contains the first element that matches the search criteria

IsXMLError

Checks the list for the error status.

LoadXMLList

Loads an XML document and extracts an XML tree.

XMLAttrName

Returns the name of the current attribute pointed to by the XMLFirstAttrib and XMLNextAttrib functions.

XMLAttrValue

Returns the value of the attribute pointed to by the XMLFirstAttrib and XMLNextAttrib functions.

XMLFind

Locates the XML path from the extracted XML tree and returns a list of matched elements to a list type DAL variable or a matched text to a string type DAL variable.

XMLFirst

Sets the current pointer to the first element in the specified list.

XMLFirstAttrib

Sets the attribute pointer to the first attribute for the current element in the element list or to the first attribute element in the attribute list.

XMLFirstText

Sets the current text to be the first text element in the XML search list and then retrieve that text.

XMLGetCurName

Returns the element name from the current element.

XMLGetCurText

Returns the text from the current element.

XMLNext

Sets the current pointer to the next node or element in the specified list.

XMLNextAttrib

Sets the current attribute pointer to the next attribute for the current element in the list or to the next attribute element in the attribute list.

XMLNextText

Retrieves the next text element in the XML search list.

XMLNthAttrName

Returns the nth attribute name indicated by the index number.

XMLNthAttrValue

Returns the nth attribute value indicated by the index number.

XMLNthText

Returns the nth text value, as indicated by the index number.