XMLInsertDocument (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Functions for managing XML files

Saving the modifications in the XML file

See also

XMLInsertDocument (Function)

In french: XMLInsèreDocument

Inserts the current XML tag found in an XML document into another XML document.

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.

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

Result1 is boolean
// Inserts the current tag found in MySourceDoc into MyTargetDoc
// This tag will be a child tag of the current tag found in MyTargetDoc
Result1 = XMLInsertDocument("MyTargetDoc", "MySourceDoc", XMLChildItem)
IF Result1 = True THEN
Info("Insertion successful")
ELSE
Info("The insertion failed")
END

Syntax

<Result> = XMLInsertDocument(<Target XML document> , <Source XML document> [, <Insertion position>])

<Result>: Boolean

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

<Target XML document>: Character string with quotes

Name of XML document into which the insertion will be performed.

<Source XML document>: Character string with quotes

Name of XML document containing the tag that will be inserted into an XML document.

<Insertion position>: Optional Integer constant

Position where the addition is performed in relation to the current tag in <Target XML document>. This parameter can take one of the following values:
XMLPreviousElement The insertion is performed just before the current tag, in the same branch.
XMLNextElement
(Default value) The insertion is performed just after the current tag, in the same branch.
XMLChildItem The insertion is performed in the current level. The inserted part will be a child tag of the current tag.

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