XMLBuildString (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

XML file management functions

XML functions and threads

See also

XMLBuildString (Function)

In french: XMLConstruitChaîne

Retrieves and formats the content of an XML document. This XML document could:

have been created with XMLDocument and modified with the XML functions.
correspond to an xmlDocument variable.

In the final XML document, the list of attributes is sorted in alphabetical order.

If the XML document to format contains the declaration of an internal DTD, the description of this DTD will not be transcribed in the final XML document.

Example

See additional examples

XMLSource is string
Res is boolean
// Load the XML content
XMLSource = fLoadText("example.xml")

// Create the XML document
Res = XMLDocument("XMLDoc", XMLSource)

// Modify the XML document
...

// Retrieve and format the XML document
XMLSource = XMLBuildString("XMLDoc")

// Save the XML file
fSaveText("ModifiedExample.xml", XMLSource)

Syntax

Retrieving the source of an XML document created by XMLDocument Hide the details

<Result> = XMLBuildString(<Name of XML document> [, <Creation options> [, <Output format>]])

<Result>: Character string

Formatted XML document. This result can be:
handled in memory.
...

<Name of XML document>: Character string with quotes

Name of XML document to format. This document was created by XMLDocument and it was modified by the XML functions.

<Creation options>: Optional Integer constant

Combination of following values:
XMLDocumentDefault
(default value) Generates the XML code with a header and from the root.
XMLCurrentPosition Generates the XML code from the current position in the XML document (instead of the root)
XMLNoHeader Generates the XML code without header.

<Output format>: Optional Integer constant

Indicates the encoding used in the file header:
XMLNoEncoding
(Default value) No encoding
XMLEncodingIso8859_1 Encoding according to the Latin character set
XMLEncodingIso8859_2 Encoding according to Iso8859_2
XMLEncodingIso8859_3 Encoding according to Iso8859_3
XMLEncodingIso8859_4 Encoding according to Iso8859_4
XMLEncodingIso8859_5 Encoding according to Iso8859_5
XMLEncodingIso8859_6 Encoding according to Iso8859_6
XMLEncodingIso8859_7 Encoding according to Iso8859_7
XMLEncodingIso8859_8 Encoding according to Iso8859_8
XMLEncodingIso8859_9 Encoding according to Iso8859_9
XMLEncodingUTF16 UNICODE encoding
Remark: in this case, XMLBuildString generates a 2-byte header to specify the "Byte Order".
XMLEncodingUTF8 UNICODE 8 encoding
This parameter is not available. The encoding used is Iso8859_1.
The encoding used by default will be Iso8859_1 (Latin character set).

Retrieving the source of an XML document found in an xmlDocument variable Hide the details

<Result> = XMLBuildString(<XML document> [, <Creation options>])

<Result>: Character string

Formatted XML document. This result can be:
handled in memory.
...

<XML document>: xmlDocument variable

xmlDocument variable containing the XML document to format.
Caution: The encoding of result corresponds to the ..Encoding property of xmlDocument variable. If no encoding is specified, the XML document will be encoded in UTF8 by default.

<Creation options>: Optional Integer constant

Combination of following values:
XMLDocumentDefault
(default value) Generates the XML code with a header and from the root.
XMLNoHeader Generates the XML code without header.

Remarks

XML functions and threads

If your application uses threads, the XML document is shared between all these threads. See Managing threads for more details.

Component: wd260xml.dll