XMLSave (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

XML file management functions

See also

XMLSave (Function)

In french: XMLSauve

Saves an XML document in a file.

Versions 15 and later
If an XSD description was used, it is automatically used to validate the XML document when saved.

New in version 15
If an XSD description was used, it is automatically used to validate the XML document when saved.

If an XSD description was used, it is automatically used to validate the XML document when saved.

Versions 17 and later

This function is now available for Java applications.

New in version 17

This function is now available for Java applications.

Example

MyXMLDocument is xmlDocument
...
Filter is string = "XML files (*.xml)" + TAB + "*.xml" + CR + ...
"All files (*.*)" + TAB + "*.*"
OutputFile is string = fSelect("", "", "Select an XML file...", ...
Filter, "xml", fselCreate)
IF OutputFile <>"" THEN
XMLSave(MyXMLDocument, OutputFile, XMLDocumentDefault)
IF ErrorOccurred = True THEN
ErrorBuild("An error occurred when saving: %1", ...
ErrorInfo(errFullDetails))
END
END

// The description of the XML file named "stream" was imported into the project.
// A blank XML file will be created from this description.
// The XML file does not physically exist yet.
// Load the XML content
MyXMLDoc is xmlDocument,description="stream"
MyXMLDoc.rss.Channel[1].Title = gsParamTitle
MyXMLDoc.rss.Channel[1].Link = gsParamSiteAddress
MyXMLDoc.rss.Channel[1].Description = gsParamSiteDescription
MyXMLDoc.rss.Channel[1].Copyright = gsParamCopyright
MyXMLDoc.rss.Channel[1].Webmaster = gsParamContactAddress
MyXMLDoc.rss.Channel[1].Image = gsParamURLSiteImage
MyXMLDoc.rss.Channel[1].Generator = "Easy RSS"
// Save the file
XMLSave(MyXMLDoc, gsPathXMLFile)
// Save the file with formatting (new feature of version 22)
XMLSave(MyXMLDoc, gsPathXMLFile_With_Formatting, XMLFormatting)

Syntax

XMLSave(<XML document> [, <File name and path>] [, <Options>])

<XML document>: xmlDocument variable

xmlDocument variable containing the document to save. This variable can be the result of a call to XMLOpen or it may have been declared and initialized directly.

<File name and path>: Optional ANSI or Unicode character string

Name and full (or relative) path of text file to create. A UNC path can be used.
If this parameter is not specified or if it is set to "" (empty string):
When XMLSave is called for the first time on this document, the XML document is saved at the location specified during its opening (XMLOpen).
During the next calls to XMLSave, the XML document is saved at the location specified during the previous save.
An error occurs if the XML document was not opened by XMLOpen (opened from a URL, from a string or if the document was created).

<Options>: Optional Integer constant

Options for saving the XML document.
The possible values are:
XMLDocumentDefault
(default value) Saves the XML document with a header.
Versions 22 and later
XMLFormatting
New in version 22
XMLFormatting
XMLFormatting Saves the XML document with formatting (indent and carriage returns).
This constant is not available.
XMLNoHeader Saves the XML document without header. This constant can be used when the XML document corresponds to a fragment of a more important document, concatenated with other XML documents thereafter.
xvNoValidation Saves the XML document without taking into account the XSD model specified when describing the XML document.
Versions 17 and later
This constant is not available.
New in version 17
This constant is not available.
This constant is not available.

Remarks

When describing an XML document, you have the ability to specified the XSD file that will be used as validation model for the XML file. For example:

cMyDoc is xmlDocument <description="person.xsd">

By default, this XSD file is taken into account when saving the document: the validity of the document is automatically checked before saving the XML document (equivalent to XMLValidDocument). To avoid performing this validation, all you have to do is used the xvNoValidation constant.

Business / UI classification: Business Logic

Component: wd260xml.dll