XMLDelete (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

XML file management functions

Deletion during a search

Saving the modifications in the XML file

See also

XMLDelete (Function)

In french: XMLSupprime

Deletes the current element (as well as the entire branch) from an XML document.

Versions 17 and later

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

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

// Deletion during a search
// Positions at the root of document
XMLRoot(:m_sDocName)
LOOP
// Finds all the "txsr" from the root in order to delete them
XMLFind(:m_sDocName, CParagraph::CST_TAG, XMLTag + XMLChildItem + XMLContinue, ...
XMLExact)
IF XMLFound(:m_sDocName) THEN
XMLDelete(:m_sDocName)
ELSE
BREAK
END
END

Syntax

<Result> = XMLDelete(<XML document>)

<Result>: Boolean

True if the deletion is performed,
False otherwise. 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

XML document from which the deletion will be performed.
If the current element is an attribute, the attribute will be deleted.
If the current element is a tag, the tag will be deleted as well as all its attributes and all its child elements.

Remarks

Current position

After the deletion, the current position is moved toward the parent of deleted element.

Deletion during a search

XMLDelete used during a search cancels the search. Example to avoid (this code does not operate):

// Positions at the root of document
XMLRoot(:m_sDocName)
// Finds all the "txsr" from the root in order to delete them
XMLFind(:m_sDocName, CParagraph::CST_TAG, XMLTag + XMLChildItem + XMLContinue, XMLExact)
WHILE XMLFound(:m_sDocName)
XMLDelete(:m_sDocName)
// Next element in the search
XMLNext(:m_sDocName)
END
XMLCancelSearch(:m_sDocName)

The code to use is given in example of the function.

Saving the modifications in the XML file

To save the modifications performed in an XML file, you must:

Use XMLBuildString. This function retrieves and formats the content of an XML document.
Save the character string generated by XMLBuildString in an XML file. To do so, use fSaveText.

Example:

// Once the XML document was modified
XMLSource = XMLBuildString("XMLDoc")
// Save the XML file
fSaveText("ModifiedExample.xml", XMLSource)

Business / UI classification : Business Logic

Component : wd260xml.dll