XMLExecuteXPath (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / XML file functions

Limitations
XML functions and threads

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

XMLExecuteXPath (Function)

In french: XMLExécuteXPath

Executes an XPATH query:

in a variable of type xmlDocument.
Not available.
in an XML document.

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

Example

See additional examples

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

// Chargement du fichier XML
MonDoc is string
MonDoc = fLoadText("exemple.xml")
// Texte de la requête : Recherche de la balise Index
RequêteXPATH is string = "Aide/Fonction/Index"
// Création du document
XMLDocument("Exemple", MonDoc)
IF ErrorOccurred = True THEN
	Error("Le fichier n'est pas au format XML.")
	RETURN
END
b is boolean
b = XMLExecuteXPath("Exemple", RequêteXPATH)
// Est-ce une requête de calcul ?
IF b = True AND XMLOut("Exemple") = True THEN
	 // Voilà le résultat du calcul
	 Trace("XMLRésultat=" + XMLResult("Exemple"))
END
// Est-ce une requête XPath de sélection ?
IF XMLFound("Exemple") = True THEN
	// Parcours de la sélection résultat
	WHILE XMLFound("Exemple") = True
		Trace(XMLPath("Exemple"))
		XMLNext("Exemple")
	END
	// Parcours terminé, on termine la requête
	XMLCancelSearch("Exemple")
END

Syntax

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:
The IsValue property allows you to know if 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), the Value property reads the result.

<XML document>: xmlDocument variable

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

<Text of XPath query>: Character string

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 the 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 the XML document>: Character string

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

<Text of XPath query>: Character string

Text of the XPath query to execute.

Remarks

Limitations

Several XPath browse queries cannot be nested.
Syntax 1: Execute an XPATH request on a variable of type xmlDocument:
- 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. For more details on threads, see Managing threads.

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: wd300xml.dll