Engine Help Category: XML
Filtered overview of the Engine Help documentation.
@XMLAddChild
This @Function creates a new direct child XML element below an existing XML node. Optionally, content can be assigned to the new element directly. In addition, a namespace URI can be specified. In this case, the namespac …
@XMLCreate
This @Function creates a new, empty XML document. The created XML document uses XML version 1.0. The supplied flags are stored in the created VSPECHXMLDOC (XMLD) handle and are inherited by XML handles derived from it la …
@XMLCreateRoot
This @Function creates the root element of an XML document previously created with @XMLCreate. Optionally, one or more namespace prefixes and their corresponding namespace URIs can also be specified. The first specified …
@XMLGetAllContent
This @Function retrieves the complete text content of an XML node, including the content of all child elements. The content is converted to the desired character set according to the output flags set for the XML handle. …
@XMLGetAttribute
This @Function retrieves the value of a specified attribute of an XML node. The attribute is searched by name. Optionally, a namespace can also be specified. In this case, both the attribute name and the namespace URI mu …
@XMLGetAttributes
This @Function retrieves the attributes of an XML node. The attribute names are returned as a text list. Optionally, the corresponding attribute values, namespace URIs, and namespace prefixes can also be returned in addi …
@XMLGetChildByName
This @Function retrieves the first direct child XML element with a specified name. Optionally, a namespace can also be specified. In this case, both the element name and the namespace URI must match. The search parameter …
@XMLGetContent
This @Function retrieves the direct text content of an XML node. Only directly contained text and CDATA nodes are included. Content from child XML elements is not included. The content is converted to the desired charact …
@XMLGetFirstChild
This @Function retrieves the first direct child XML element of an XML node. Only XML elements are considered. Other node types, such as text, comment, or CDATA nodes, are skipped. The flags inherited from the supplied XM …
@XMLGetName
This @Function retrieves the name of an XML node. The supplied handle must contain a valid VSPECHXMLNODE (XMLN) handle. The name of the node is returned as text. If character set conversion is enabled for the XML handle, …
@XMLGetNamespace
The supplied handle must contain a valid VSPECHXMLNODE (XMLN) handle. If a namespace is associated with the node, its namespace URI is returned as text. If character set conversion is enabled for the XML handle, the retu …
@XMLGetNextSibling
This @Function retrieves the next XML sibling element of an XML node. Only XML elements are considered. Other node types, such as text, comment, or CDATA nodes, are skipped. The flags inherited from the supplied XML node …
@XMLGetNextSiblingByName
This @Function retrieves the next XML sibling element with a specified name. The search starts with the immediately following sibling element of the supplied XML node and continues until an element with a matching name i …
@XMLGetPrefix
This @Function retrieves the namespace prefix of an XML node. The supplied handle must contain a valid VSPECHXMLNODE (XMLN) handle. If a namespace with a prefix is associated with the node, the prefix is returned as text …
@XMLGetRoot
This @Function retrieves the root element of a previously parsed XML document. The supplied XML document must contain a valid VSPECHXMLDOC (XMLD) handle. The function returns a VSPECHXMLNODE (XMLN) handle that references …
@XMLNodeListGetElements
This @Function retrieves the number of nodes contained in an XML node list. VSPECHXMLNODELIST XMLNL: Handle of the XML node list whose number of elements is to be retrieved. XMLNL must contain a valid VSPECHXMLNODELIST ( …
@XMLNodeListGetNode
This @Function retrieves a specific XML node from a previously created XML node list. The desired node is selected using a numeric index. Indexing starts at 1. The flags inherited from the XML node list handle are also a …
@XMLNodeListRelease
This @Function releases a previously created VSPECHXMLNODELIST (XMLNL) handle. The function releases the internal memory used for the XML node references stored in the node list handle. After successful execution, the su …
@XMLParse
This @Function reads an XML document from a text value or binary buffer and creates an internal XML document structure from it. The returned XML document reference can be processed using the other @XML... functions. Afte …
@XMLRelease
This @Function releases a previously created VSPECHXMLDOC (XMLD) handle. The function releases all resources associated with the VSPECHXMLDOC (XMLD) handle. After successful execution, the supplied XML document handle mu …
@XMLSelectNodes
This @Function evaluates an XPath expression relative to an XML node and returns all matching XML nodes as a VSPECHXMLNODELIST (XMLNL) handle. Optionally, namespace prefixes and their corresponding namespace URIs can als …
@XMLSelectSingleNode
This @Function evaluates an XPath expression relative to an XML node and returns the first matching XML element. Optionally, namespace prefixes and their corresponding namespace URIs can also be specified. These are regi …
@XMLSerialize
This @Function serializes an XML document and returns it as text or as a binary buffer. The XML document is always output in UTF-8. The optional Options parameter specifies whether the result is returned as TEXT or VSPEC …
@XMLSetAttribute
This @Function sets the value of an attribute of an XML node. If the specified attribute already exists, its value is updated. Otherwise, a new attribute is created. Optionally, a namespace URI can be specified. In this …