Script-Funktion: Bereitet die Darstellung eines XML-Dokumentes auf.
Syntax
XML_BEAUTIFY (Reference)
|
Syntax |
Beschreibung/Format |
|---|---|
|
Reference |
Verweis auf ein XML-Dokument dessen auszugebende Struktur formatiert werden soll
|
|
Rückgabewerte |
|---|
|
„0“ - Der Inhalt des XML-Dokumentes wurde erfolgreich aufbereitet |
Die Script-Funktion bereitet die Darstellung eines XML-Dokumentes auf, bevor diese mit XML_PRINTINTOFILE in eine XML-Datei geschrieben wird.
Der Script-Funktion muss ein Verweis übergeben werden, um auf ein Element zugreifen zu können. Dieser wird von Script-Sprachmitteln bereitgestellt, die innerhalb des XML-Dokumentes positionieren können, beispielsweise XML_GET_FIRST_CHILD, XML_GET_NEXTSIBLING oder XML_SELECT_NODE. Die Script-Funktion bereitet dieses Element samt dessen Subelementen und die zugehörigen Attributen auf.
Es kann auch der Verweis verwendet werden, der XML_OPEN zurückgibt, um die Darstellung des gesamten XML-Dokumentes aufzubereiten.
Ohne die Verwendung von XML_BEAUTIFY werden die Informationen des XML-Dokumentes hintereinander (ohne Zeilenumbruch) in eine Datei geschrieben. Wird diese Datei mit einem Texteditor, beispielsweise Notepad, geöffnet, ist die Darstellung in Folge dessen unübersichtlich.
Beispiele
Die komplette Struktur der Dokumentation wird zunächst in besser lesbarer Form aufbereitet und anschließend in die Datei Doku.xml ausgegeben.
Damit dieses Beispiel funktioniert, muss dem Objekt, das mit XML_OPEN verwendet wird, eine Registerkarte Strukturierte Dokumentation mit dem Namen "@Details" hinzugefügt werden.
: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
Das zweite Beispiel gibt die Elemente Beschreibung und Objekte mit ihren Attributen in eine Datei aus.
: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
Siehe auch: