%XML_DOC_DELETE

Release an XML document instance

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
status = %XML_DOC_DELETE(document)

Return value

status

XML_SUCCESS if the document is deleted successfully.

Arguments

document

The XML document instance to delete. (XML_DOC_TYPE)

Discussion

After you’re finished processing an XML document, you must release the document instance with %XML_DOC_DELETE. This routine releases all memory for an XML document, including the document itself, its root element, all of its children, and any attributes associated with these elements.

This function is defined as ^VAL.

Examples

xcall xml_doc_delete(document)

For a complete example, see Example of assembling XML.