Release an XML element instance
|
WTSupported in traditional Synergy on Windows
|
WNSupported in Synergy .NET on Windows
|
USupported on UNIX
|
VSupported on OpenVMS
|
status = %XML_ELEM_DELETE(element)
Return value
status
XML_SUCCESS if the element was released successfully.
Arguments
element
The XML element instance to release. (XML_ELEM_TYPE)
Discussion
%XML_ELEM_DELETE releases an XML element and all of its subelements and attributes. You will rarely need to call this function, because the %XML_DOC_DELETE function releases all memory for an XML document, including all elements and attributes associated with the document. The only time you will need to release an individual element is when the element was explicitly created with %XML_ELEM_CREATE and was not added as data to a parent element (and therefore would not be released as part of a document or list).
Note that while %XML_ELEM_DELETE releases the element’s memory, it does not automatically remove the element from any element lists of which it is a member.
This function is defined as ^VAL.
