XMLRead (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

XML file management functions

See also

XMLRead (Function)

In french: XMLLit

Returns the value of an XML element or the value of the attribute for an XML element.

Versions 15 and later

This function is now available for PHP sites.

New in version 15

This function is now available for PHP sites.

This function is now available for PHP sites.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 25 and later

This function is now available in browser code.

New in version 25

This function is now available in browser code.

Example

MyDoc is string = fLoadText("example.xml")
XMLDocument("DOM", MyDoc)
sFunctionName is string = XMLRead("DOM","/Example/Help/Function")
sFunctionType is string = XMLRead("DOM","Help/Function/@type")
sFunctionName2 is string = XMLRead("DOM","Help/Function[2]")
sImage is string = XMLRead("DOM","Help[2]/@image")
sImageType is string = XMLRead("DOM","/Example/Help[@image=""line.jpg""]/@format", "NotDefined")
XMLClose("DOM")
// Applies to the next XML document:
// <Example>
// <Help>
// <Function type="1">Read</Function>
// <Function>Write</Function>
// </Help>
// <Help image="line.jpg" format="jpg" />
// </Example>

Syntax

<Result> = XMLRead(<XML document> , <Path of the element to be read> [, <Not found>])

<Result>: Character string

Value of element or value of attribute,
Empty string ("") or value of <Not found> parameter in the following cases:
if the element was not found.
if the element has no value
if the XPath query is not a query for selecting records.
In this case, the ErrorOccurred variable is set to True and ErrorInfo returns more details about the error.

<XML document>: Character string

Name of XML document where the reading will be performed. This document contains the XML code to study and it was created by XMLDocument.

<Path of the element to be read>: Character string

Can correspond to:
the path of the value to read in the XML file. Caution: the case is taken into account (lowercase and uppercase characters). To read the value of an attribute, the name of the attribute must be preceded by the "@" character.
the text of an XPath query to run. The XPath query must be a query for "selecting records". If several elements match the selection, the first element found is used.
If this path does not start with "/", the name of the root node is automatically added. If the XML document has no root, <Result> will correspond to <Not found>.

<Not found>: Optional character string

Text to return if the element was not found. This parameter corresponds to an empty string ("") by default.

Remarks

Special cases

XMLRead does not modify the current position in the document.
Several XML browse queries cannot be nested.
XMLRead must not be used with an XMLDocument variable. To read the content of an XMLDocument variable, use the "FOR EACH" syntax.

Code wizard

The code editor includes a code wizard to generate the code of XMLRead. To use it, type "XMLRead(" in the code editor and select "Wizard for XMLRead".

Business / UI classification: Business Logic

Component: wd270xml.dll