4D v16.3
DOM EXPORT TO FILE
- 4D Language Reference
-
- XML DOM
-
- Overview of XML DOM Commands
- DOM Append XML child node
- DOM Append XML element
- DOM CLOSE XML
- DOM Count XML attributes
- DOM Count XML elementsUpd
- DOM Create XML element
- DOM Create XML element arrays
- DOM Create XML Ref
- DOM EXPORT TO FILE
- DOM EXPORT TO VAR
- DOM Find XML element
- DOM Find XML element by ID
- DOM Get first child XML element
- DOM Get last child XML element
- DOM Get next sibling XML element
- DOM Get parent XML element
- DOM Get previous sibling XML element
- DOM Get Root XML element
- DOM GET XML ATTRIBUTE BY INDEX
- DOM GET XML ATTRIBUTE BY NAME
- DOM GET XML CHILD NODES
- DOM Get XML document ref
- DOM GET XML ELEMENT NAME
- DOM GET XML ELEMENT VALUE
- DOM Get XML elementUpd
- DOM Get XML information
- DOM Insert XML element
- DOM Parse XML source
- DOM Parse XML variable
- DOM REMOVE XML ATTRIBUTE
- DOM REMOVE XML ELEMENT
- DOM SET XML ATTRIBUTE
- DOM SET XML DECLARATION
- DOM SET XML ELEMENT NAME
- DOM SET XML ELEMENT VALUE
DOM EXPORT TO FILE
| DOM EXPORT TO FILE ( elementRef ; filePath ) | ||||||||
| Parameter | Type | Description | ||||||
| elementRef | String |
|
Root XML element reference | |||||
| filePath | Text |
|
Full access path of the file | |||||
The DOM EXPORT TO FILE command stores an XML tree in a file on disk.
Pass the root element reference to export in the elementRef parameter.
Pass the full access path to use or create of the export file in filePath. If the file does not already exist, it is created.
If you only pass a file name (without an access path), a search for the file will take place or it will be created next to the structure file.
If you pass an empty string (""), a standard open file and new file dialog box appears.
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 on macOS and CRLF characters on Windows.
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.
This example stores the tree vElemRef in the file MyDoc.xml:
DOM EXPORT TO FILE(vElemRef;"C:\\folder\MyDoc.xml")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.
An error is generated when:
- The element reference is invalid,
- The specified access path is invalid,
- The storage volume returns an error (insufficient disk space, etc.).
Product: 4D
Theme: XML DOM
Number:
862
Created: 4D 2004
4D Language Reference ( 4D v16)
4D Language Reference ( 4D v16.1)
4D Language Reference ( 4D v16.2)
4D Language Reference ( 4D v16.3)
