XMLExecuteXPath (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

XML file management functions

XML functions and threads

See also

XMLExecuteXPath (Function)

In french: XMLExecuteXPath

Executes an XPATH query:

Versions 21 and later
in an xmlDocument variable.
Not available.
New in version 21
in an xmlDocument variable.
Not available.
in an xmlDocument variable.
Not available.
in an XML document.

Only the calculation queries performed in an XML document are supported in PHP.

Versions 25 and later

This function is now available in browser code.

New in version 25

This function is now available in browser code.

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.

Example

See additional examples

Versions 21 and later

clDoc is xmlDocument = XMLOpen(n, fromString)
c is xpathResult = XMLExecuteXPath(clDoc, "/root/text()")
IF c..IsValue THEN
Trace(c..Value)
ELSE
FOR EACH node OF c..Node
Trace("Node: " + node..Text)
END
FOR EACH attrib OF c..Attribute
Trace("Node: " + attrib..Name)
END
END

New in version 21

// Load the XML file
MyDoc is string
MyDoc = fLoadText("example.xml")
// Text of query: Find the Index tag
XPATHQuery is string = "Help/Function/Index"
// Create the document
XMLDocument("Example", MyDoc)
IF ErrorOccurred = True THEN
Error("The file is not in XML format.")
RETURN
END
b is boolean
b = XMLExecuteXPath("Example", XPATHQuery)
// Is it a calculation query?
IF b = True AND XMLOut("Example") = True THEN
// The calculation result is as follows
Trace("XMLResult=" + XMLResult("Example"))
END
// Is it a selection XPath query?
IF XMLFound("Example") = True THEN
// Browse the result selection
WHILE XMLFound("Example") = True
Trace(XMLPath("Example"))
XMLNext("Example")
END
// Browse completed, end the query
XMLCancelSearch("Example")
END

Syntax

Versions 21 and later

Syntax not available in PHP and browser code

Executing an XPATH query on an xmlDocument variable Hide the details

<Result> = XMLExecuteXPath(<XML document> , <Text of XPath query>)

<Result>: xpathResult variable

xpathResult variable containing the result of the XPATH query.
Reading the result:
..IsValue is used to find out whether the result is a value.
For a selection query (the result is not a value), the xpathResult variable must be browsed.
For a calculation query (the result is a value), ..Value is used to read the result.

<XML document>: xmlDocument variable

Name of the xmlDocument variable containing the XML code to analyze.

<Text of XPath query>: Character string (with quotes)

Text of the XPath query to execute.

New in version 21

Syntax not available in PHP and browser code

Executing an XPATH query on an xmlDocument variable Hide the details

<Result> = XMLExecuteXPath(<XML document> , <Text of XPath query>)

<Result>: xpathResult variable

xpathResult variable containing the result of the XPATH query.
Reading the result:
..IsValue is used to find out whether the result is a value.
For a selection query (the result is not a value), the xpathResult variable must be browsed.
For a calculation query (the result is a value), ..Value is used to read the result.

<XML document>: xmlDocument variable

Name of the xmlDocument variable containing the XML code to analyze.

<Text of XPath query>: Character string (with quotes)

Text of the XPath query to execute.

Syntax not available in PHP and browser code

Executing an XPATH query on an xmlDocument variable Hide the details

<Result> = XMLExecuteXPath(<XML document> , <Text of XPath query>)

<Result>: xpathResult variable

xpathResult variable containing the result of the XPATH query.
Reading the result:
..IsValue is used to find out whether the result is a value.
For a selection query (the result is not a value), the xpathResult variable must be browsed.
For a calculation query (the result is a value), ..Value is used to read the result.

<XML document>: xmlDocument variable

Name of the xmlDocument variable containing the XML code to analyze.

<Text of XPath query>: Character string (with quotes)

Text of the XPath query to execute.

Executing an XPATH query on an XML document (syntax kept for backward compatibility) Hide the details

<Result> = XMLExecuteXPath(<Name of XML document> , <Text of XPath query>)

<Result>: Boolean

True if the query was executed,
False otherwise or if no element corresponds to the query.
Reading the result:
For a selection query, if the XPATH query has been executed, the XML search functions are used to browse the result of the XPATH query.
For a calculation query, XMLResult is used to read the result.

<Name of 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.

<Text of XPath query>: Character string (with quotes)

Text of the XPath query to execute.

Remarks

Limitations

Several XPath browse queries cannot be nested.
Syntax 1: Executing an XPATH query on an xmlDocument variable:
- The list of nodes is not sorted.
- The standard used for the XPath query is XPath 1.0.
Syntax 2: Executing an XPATH query on an XML document:
XMLSavePosition and XMLRestorePosition cannot be used to save/restore a position when browsing the result of a select XPath query.

XML functions and threads

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

If the current position in an XML document is modified in a thread, the current position in this XML document is modified for all the threads.

Business / UI classification: Business Logic

Component: wd260xml.dll