XMLData (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

XML file management functions

Identifying the current element

XML functions and threads

See also

XMLData (Function)

In french: XMLDonnée

Returns the value of current element (tag or XML attribute) or the value of one of its attributes.

To select an element, use the functions for XML search and browse (XMLFirst, XMLLast, XMLChild, ...).

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

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 Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

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.

Example

See additional examples

// Value of "Product" attribute for the current element
Value is string
Value = XMLData("XMLDoc", "Product")

// Test of value
IF Value = "" THEN
Error("The Product attribute has no value")
ELSE
Info("The value of Product attribute is: " + Value)
END

// Value of tag
Value is string
Value = XMLData("XMLDoc")

// Positioned on a tag?
IF ErrorOccurred = True THEN
Error(ErrorInfo())
ELSE
// Test of value
IF Value = "" THEN
Error("The current element has no value")
ELSE
Info("The value of current element is: " + Value)
END
END

Syntax

<Result> = XMLData(<XML document> [, <Attribute> [, <Search mode>]])

<Result>: Character string

Value of current element or value of specified attribute.
Empty string (""):
if the current element has no value.
if the specified attribute is not a child of the current element.
if there is no current element. In this case, the ErrorOccurred variable is set to True. To get the details of the error, use ErrorInfo.
if the current element is already an attribute. In this case, the ErrorOccurred variable is set to True. To get the details of the error, use ErrorInfo.

<XML document>: Character string (with quotes)

Name of XML document used. This document contains the XML code to study and it was created by XMLDocument.

<Attribute>: Optional character string (with quotes)

Name of child attribute of current tag for which the value must be returned. This attribute is sought among the direct children of current element. If this parameter is not specified (or if it corresponds to Null or an empty string), XMLData returns the value of the current tag.

<Search mode>: Optional Integer constant

Search mode use to find the attribute among the children of current element.
XMLStartWith Search for the first attribute whose name starts with the content of <Attribute>.
XMLContains Search for the first attribute whose name contains the value of <Attribute>.
XMLExact
(Default value) Search for the first attribute whose name exactly corresponds to the value of <Attribute>.
XMLIgnoreCase Search for the first attribute whose name corresponds to the value of <Attribute> regardless of the case.
Can be combined with the constants XMLContains, XMLStartWith or XMLExact.

Remarks

Identifying the current element

The type of current element is returned by XMLElementType.
The name of current element is returned by XMLElementName.

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