Write contents of an XML document to a file
|
WTSupported in traditional Synergy on Windows
|
WNSupported in Synergy .NET on Windows
|
USupported on UNIX
|
VSupported on OpenVMS
|
status = %XML_DOC_TOFILE(document, filename)
Return value
status
XML_SUCCESS if the file was written successfully.
Arguments
document
The XML document instance whose contents will be written to the specified file. (XML_DOC_TYPE)
filename
The name of the file that will be written. (a)
Discussion
%XML_DOC_TOFILE serializes an XML document into a stream file. You can alternatively serialize an XML document into an XML string using %XML_DOC_TOSTRING.
|
When serializing an XML document to a file, %XML_DOC_TOFILE will not unescape any escaped text or attribute values in the XML document even if %XML_OPTION is set to SYNESCAPE_UNESCAPE. |
This function is defined as ^VAL.
Examples
xcall xml_doc_tofile(document, "myfile.xml")
For a more detailed example, see Example of assembling XML.
