Manuel des Scripts Automation Engine > Organisation fonctionnelle > Lecture ou modification d'objets > XML_REMOVE_CHILDREN

XML_REMOVE_CHILDREN

Fonction de script : Supprime tous les sous-éléments d'un élément XML.

Syntaxe

XML_REMOVE_CHILDREN(element)

Elément de syntaxe

Description / format

Elément

Référence à l'élément dont le sous-élément doit être supprimé.
Format : littéral de script ou variable de script


Code retour

"0" – Tous les sous-éléments de l'élément spécifié ont été supprimés avec succès.

Remarques

L'élément de script supprime tous les éléments subordonnés d'un élément spécifié dans le document XML ouvert (XML_OPEN). Il faut spécifier la référence à l'élément. Une fois le sous-élément supprimé avec succès, l'élément de script renvoie le code retour "0".

L'élément de script ne fait que copier la structure XML enregistrée dans la mémoire. L'onglet Documentation n'en est pas affecté.

Exemple

Dans l'exemple suivant, l'onglet Documentation structurée est ouvert sous forme de document XML. Le premier élément est alors spécifié et tous ses sous-éléments sont supprimés. Si la suppression a réussi, le message correspondant s'affiche dans le rapport d'activation.

:SET &XMLDOCU#=XML_OPEN(DOCU,,"@Details")

:IF &XMLDOCU# <>
""
:SET &FIRST# = XML_GET_FIRST_CHILD(&XMLDOCU#)
:SET &RET# = XML_REMOVE_CHILDREN(&FIRST#)

:IF &RET# = 0
:P 'Sub-element successfully deleted.'

:ENDIF

:ENDIF

:XML_CLOSE &XMLDOCU#

 

Rubriques connexes :

Elément de script Description
XML_OPEN Ouvre un document XML en vue du traitement
:XML_CLOSE Ferme un document XML