XML_BEAUTIFY

Fonction de script : Ameliore l'affichage d'un document XML.

Syntaxe

XML_BEAUTIFY (Reference)

Syntaxe

Description / format

Reference

Référence du document XML dont la structure doit être formattée.
Format : littéral de script ou variable de script


Codes retour

"0" : le contenu du document XML a été bien arrangé.

Cette fonction de script prépare l'affichage d'un document XML avant qu'il soit écrit dans un fichier XML avec XML_PRINTINTOFILE.

Un descripteur doit être transmis à la fonction de script pour qu'elle puisse accéder à l'élément. Cette référence est fournie par des scripts qui peuvent se positionner dans le document XML, comme XML_GET_FIRST_CHILD, XML_GET_NEXTSIBLING ou XML_SELECT_NODE. La fonction de script prépare cet élément, ses sous-éléments et les attributs correspondants.

Il est aussi possible d'utiliser le descripteur retourné par XML_OPEN pour l'affichage de tout le document XML.

Si vous n'utilisez pas XML_BEAUTIFY, toutes les informations du document XML sont écrites les unes à la suite des autres dans un fichier (sans retour à la ligne). Si vous ouvrez ce fichier avec un éditeur de texte tel que le Bloc-notes, l'information est inintelligible.

Exemples

La structure complète de la documentation est éditée afin d'être plus lisible, puis écrite dans le fichier Docu.xml.

Pour que cet exemple fonctionne, un onglet de documentation avec le nom "@Details" doit être ajouté à l'objet qui est utilisé avec XML_OPEN.

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

:
SET &RET1# = XML_BEAUTIFY(&XMLDOCU#)
:
SET &RET2# = XML_PRINTINTOFILE("C:\AUTOMIC\XML_Documentation\Docu.xml",&XMLDOCU#)

:
XML_CLOSE

Dans le second exemple, les éléments Description et Objets ainsi que leurs attributs sont écrits dans un fichier.

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

:
SET &HND# = XML_GET_FIRST_CHILD(&XMLDOCU#)
:
SET &RET1# = XML_BEAUTIFY(&HND#)
:
SET &RET2# = XML_PRINTINTOFILE("C:\AUTOMIC\XML_Documentation\Docu.xml",&HND#)

:
XML_CLOSE

Voir aussi :

voiraussi

Fonctions de script pour les éléments XML