DOM EXPORT TO VAR

version 2004

DOM EXPORT TO VAR (elementRef; vXmlVar)

The DOM EXPORT TO VAR command allows you to save an XML tree in a text or BLOB variable.

Pass the root element reference to export in elementRef.

Pass the name of the variable that must contain the XML tree in vXmlVar. This variable must either be a Text or BLOB type. You can select the type depending on what you plan on doing next or the size that the tree can reach (remember that when not in Unicode mode, Text type variables are limited to 32 K of text, whereas in Unicode mode, this limit is 2 GB).

Keep in mind that if you use a Text variable to store elementRef when not in Unicode mode, , it will be encoded using the "current" Mac character set (i.e. Mac Roman on most Western systems). This means that the text returned will lose its original encoding (encoding="xxx"). In this case, the vVarXml variable allows you to view or store the code but NOT to generate a valid XML document (using the SEND PACKET command for example).

In Unicode mode, the original encoding is kept in the variable.

This example stores the tree vElemRef in a text variable:

   C_TEXT(vtMyText)
   DOM EXPORT TO VAR(vElemRef;vtMyText)

DOM EXPORT TO FILE, SVG EXPORT TO PICTURE.

If the command has been executed correctly, the system variable OK is set to 1. Otherwise, it is set to 0 and an error is generated (for example, if the element reference is invalid).