PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Reminder: XML language
  • XML functions and threads
  • Limit
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
XMLDocument (Function)
In french: XMLDocument
Creates a new XML document. This document can be:
  • an empty document. It can be filled by XMLAddAttribute, XMLAddChild, ...
  • a document containing the XML code that will be used by the XML functions of WLanguage. This code can come from a file in XML format or from a Webservice. The current element automatically corresponds to the root tag (the root is not created if it does not exist). This document can be closed by XMLClose.
Remark: XMLDocument does not handle a file but an XML code.
Versions 18 and later
Universal Windows 10 App This function is now available in Windows Store apps mode.
New in version 18
Universal Windows 10 App This function is now available in Windows Store apps mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
XMLSource is string
Res is boolean
// Create the XML document
Res = XMLDocument("XMLDoc", XMLSource)
// Was the document created?
IF Res = False THEN
Error("The document was not created.")
ELSE
Info("The document was successfully created. It is ready to be used.")
END
// Modify the document
...
WINDEVUniversal Windows 10 AppJavaUser code (UMC)
XMLSource is string
Res is boolean
// Load the XML content
XMLSource = fLoadText("C:\Temp\example.xml")
// Create the XML document
Res = XMLDocument("XMLDoc", XMLSource)
// Was the document created?
IF Res = False THEN
Error("The following problem was detected: " + ErrorInfo())
ELSE
Info("The document was successfully created. It is ready to be used.")
END
// Modify the document
...
// Rebuild the XML string
XMLSource = XMLBuildString("XMLDoc")
// Save the XML document in a file
fSaveText("C:\Temp\ModifiedExample.xml", XMLSource)
Syntax
<Result> = XMLDocument(<XML document> [, <XML code> [, <Option>]])
<Result>: Boolean
  • True if the XML document is created,
  • False otherwise. If an error occurs:
    • the current position remains unchanged.
    • the ErrorOccurred variable is set to True. To get the details of the error, use ErrorInfo.
<XML document>: Character string
Name given to the XML document. This name will be used by all the XML functions.
<XML code>: Optional character string
XML code that will be analyzed by the XML functions. If this parameter is not specified, a new empty XML document is created.
Caution:
  • If the encoding of the document is not specified in the XML header, the encoding used is "UTF-8".
  • To specify a different encoding, the "encoding" attribute must be added to the XML tag.
    For example: <?xml version="1.0" encoding="UCS-2"?>
Java To create an empty XML document, this parameter must correspond to an empty string ("").
<Option>: Optional constant
Type of the created XML document (no option is selected by default):
Versions 16 and later
xdHTML
New in version 16
xdHTML
xdHTML
XHTML document. This constant is used to optimize the operating mode of XMLBuildString. The document is processed by using the XHTML mode.
xHTMLHTML document.
Versions 16 and later
Caution: This constant is not available anymore. Indeed, the operating mode of this constant was not optimized: the document was handled by using the XML format then, in case of failure, it was handled by using the XHTML format.
New in version 16
Caution: This constant is not available anymore. Indeed, the operating mode of this constant was not optimized: the document was handled by using the XML format then, in case of failure, it was handled by using the XHTML format.
Caution: This constant is not available anymore. Indeed, the operating mode of this constant was not optimized: the document was handled by using the XML format then, in case of failure, it was handled by using the XHTML format.
Java This parameter is ignored.
Remarks

Reminder: XML language

XML is a language containing tags and attributes (called "elements" in this help). The structure of an XML code corresponds to a tree structure: the information is organized hierarchically.
The following terms are used to describe the different parts of an XML code:

XML functions and threads

If your application uses threads, the XML document is shared between all these threads. For more details on threads, see Gestion des threads.

Limit

XMLDocument is suitable for loading XML documents whose size of text nodes does not exceed 9 MB. To handle documents with a greater size of nodes, you must use the XMLDocument type.
Component: wd270xml.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment