XMLInsertElement (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Functions for managing XML files

Prefixed syntax

XMLInsertElement

Presentation

Saving the modifications in the XML file

See also

XMLInsertElement (Function)

In french: XMLInsèreElement

Inserts an XML element (tag or attribute) into an XML document. The insertion position is relative to the current position.

An XML document can only contain a single tag at its root.

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.

Syntax

<Result> = XMLInsertElement(<XML document> , <Element name> [, <Value of inserted element> [, <Insertion position> [, <Change of position>]]])

<Result>: Boolean

True if the insertion was performed,
False otherwise (the ErrorOccurred variable is set to True).
To find out the error details, use ErrorInfo.

<XML document>: Character string with quotes

XML document into which the insertion will be performed.

<Element name>: Character string with quotes

Name of element to add. The added element and the current element have the same type:
If the current element is a tag, the inserted element is a tag.
If the current element is an attribute, the inserted element is an attribute.

<Value of inserted element>: Optional character string with quotes

Value of new element. This parameter corresponds to an empty string ("") by default.

<Insertion position>: Optional Integer constant

Position where the addition is performed in relation to the current element. This parameter can take one of the following values:
XMLPreviousElement The insertion is performed just before the current element, in the same branch.
This constant is ignored for the attributes.
XMLNextElement The insertion is performed just after the current element, in the same branch.
This constant is ignored for the attributes.
XMLChildItem
(Default value) The insertion is performed in the current level. The inserted part will be a child element of the current element.

<Change of position>: Optional boolean

True to be positioned on the added element. In this case, the added element becomes the current position.
False (default value) to avoid modifying the current position during the addition.

Remarks

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