XMLBuildString (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

XML file management functions

Prefix syntax

XMLBuildString

Presentation

Example

XML functions and threads

See also

ToXML

ToJSON

Constants for managing XML documents

JSONToXML

JSONXMLConverter

Management of XML

Managing the XSD

Modifying an SVG image (XML functions)

TextToXML

Usage example of the XML types

XML functions

XML management: Use example

XML: Using files exceeding several gigabytes

XMLAddAttribute

XMLAddChild (Example)

XMLAddChild

XMLBuildString (Example)

XMLBuildString

XMLCancelSearch

XMLChild (Example)

XMLChild

XMLChildExist

XMLClose

XMLData (Example)

XMLData

XMLDelete (Example)

XMLDelete

XMLDocument

XMLDocument (Example)

XMLDocument

XMLElementName (Example)

XMLElementName

XMLElementType

XMLExecuteXPath (Example)

XMLExecuteXPath

XMLExtractDocument

XMLExtractString

XMLFind (Example)

XMLFind

XMLFindNamespaceByName

XMLFindNamespaceByURI

XMLFirst

XMLFound

XMLInsertDocument

XMLInsertElement

XMLLast

XMLModify

XMLNamespace

XMLNamespaceURI

XMLNext

XMLOpen

XMLOpenReader (Example)

XMLOpenReader

XMLOut

XMLParent (Example)

XMLParent

XMLParentName

XMLPath

XMLPrevious

XMLRead

XMLRename

XMLRestorePosition (Example)

XMLRestorePosition

XMLResult

XMLRoot (Example)

XMLRoot

XMLSave

XMLSavePosition (Example)

XMLSavePosition

XMLSign

XMLToJSON

XMLToText

XMLValidDocument

XMLValidNode

XMLWrite

xmlAttribute

xmlDocument

xmlNamespace

xmlNode

xmlReader

xpathResult

XML functions and threads

WINDEV

WEBDEV

WINDEV Mobile

Others

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.

The corresponding character string can be saved as an XML file by fSaveText. Reminder: fSaveText creates a text file in ANSI format. To create a Unicode text file, use fOpen / fWrite.

The corresponding character string can be sent to the server for example.

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)

XMLSource is string
Res is boolean

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

// Modify the XML document
...

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

// Send the XML document to the server
AJAXExécute(MyProc, XMLSource)

Syntax

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

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

<Result>: Character string

Formatted XML document. This result can be:
handled in memory.
saved in a file in XML format by fSaveText.
sent to the server.
...

<Name of the XML document>: Character string

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:
XMLCurrentPosition Generates the XML code from the current position in the XML document (instead of the root).
XMLDocumentDefault
(default value) Generates the XML code with a header and from the root.
XMLFormatting Generates XML code with formatting (indentation and carriage returns).
XMLNoHeader Generates the XML code without header.

<Output format>: Optional Integer constant

Indicates the encoding used in the file header:
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
XMLEncodingIso8859_15 Latin-9 encoding
XMLEncodingUTF8 UNICODE 8 encoding
XMLEncodingUTF16 UNICODE encoding
Remark: in this case, XMLBuildString generates a 2-byte header to specify the byte order.
XMLNoEncoding
(Default value) No 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.
saved in a file in XML format by fSaveText.
sent to the server.
...

<XML document>: xmlDocument variable

xmlDocument variable containing the XML document to format.
Caution: The encoding of the result is defined by the Encoding property of the xmlDocument variable. If no encoding is specified, the XML document will be encoded in UTF-8.

<Creation options>: Optional Integer constant

Combination of following values:
XMLDocumentDefault
(default value) Generates the XML code with a header and from the root.
XMLFormatting Generates XML code with formatting (indentation and carriage returns).
This constant is now available.
This constant is not available.
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. For more details on threads, see Managing threads.

Component: wd270xml.dll