XMLRestorePosition (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

XML file management functions

XML functions and threads

See also

XMLRestorePosition (Function)

In french: XMLRetourPosition

Restores the previously saved context of an XML document (XMLSavePosition). The current filter when saving the position can be restored (the filter is implemented by XMLFind).

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.

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

See additional examples

IF XMLDocument("MyXMLDoc", XMLCode) = True THEN
// Find the links
XMLFind("MyXMLDoc", "a", XMLTag)
WHILE XMLFound("MyXMLDoc") = True
IF XMLChildExist("MyXMLDoc", XMLAttribute) = True THEN
TheXMLPosition is int = XMLSavePosition("MyXMLDoc")
XMLChild("myXMLDoc")
Trace(XMLData("MyXMLDoc"))
// Process
XMLRestorePosition("MyXMLDoc", TheXMLPosition, XMLRPFilter)
END
// Next element in the search
XMLNext("MyXMLDoc")
END
END

Syntax

<Result> = XMLRestorePosition(<XML document> , <Position> [, <Options>])

<Result>: Integer

True if the position is restored,
False otherwise (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.

<Position>: Integer

Position to restore. This position was returned by XMLSavePosition.

<Options>: Optional constant (or combination of constants)

Used to configure the restore operation:
XMLRPKeep The position is not freed (other calls to XMLRestorePosition can be performed on this position).
XMLRPDefault
(default value) The position is freed. The stored position is restored.
XMLRPFilter Restores the filter implemented by XMLSavePosition.

Remarks

XML functions and threads

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

Business / UI classification : Business Logic

Component : wd260xml.dll