4D v13.4

DOM EXPORT TO VAR

Home

 
4D v13.4
DOM EXPORT TO VAR

DOM EXPORT TO VAR 


 

DOM EXPORT TO VAR ( elementRef ; vXmlVar ) 
Parameter Type   Description
elementRef  String in Root XML element reference
vXmlVar  Text, BLOB in Variable to receive XML tree

The DOM EXPORT TO VAR command saves 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.

In XML, line breaks are not significant regardless of whether they are within or between XML elements. Internally, XML uses standard LF characters as line separators.

During import and export operations, line break characters can be converted. During an import, the XML parser replaces CRLF characters (standard line breaks under Windows) with LF characters. During export, LF characters are replaced by CR characters.

If you want to keep carriage returns, you must include them in an XML CDATA element so that they will not be processed by the XML parser. Instead of CRLF characters, you can also use "<br/>" characters, which are explicit carriage returns that will not be processed by the parser.

Example  

This example stores the tree vElemRef in a text variable:

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

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).

 
PROPERTIES 

Product: 4D
Theme: XML DOM
Number: 863

The OK variable is changed by the commandThis command modifies the Error system variableThe Unicode mode affects this command

 
INDEX

Alphabetical list of commands

 
HISTORY 

Created: 4D 2004

 
SEE ALSO 

DOM EXPORT TO FILE
SVG EXPORT TO PICTURE