Automation Engine Script-Leitfaden > Funktionelle Gliederung > Objekte lesen oder verändern > XML_BEAUTIFY

XML_BEAUTIFY

Scriptfunktion: Bereitet die Darstellung eines XML-Dokumentes auf.

Syntax

XML_BEAUTIFY (Reference)

Syntax

Beschreibung/Format

Verweis

Verweis auf ein XML-Dokument, dessen auszugebende Struktur formatiert werden soll.
Format: Script-Literal oder Script-Variable


Rückgabewerte

"0" - Der Inhalt des XML-Dokuments wurde erfolgreich aufbereitet.

Anmerkungen

Die Scriptfunktion bereitet die Darstellung eines XML-Dokuments auf, bevor diese mit XML_PRINTINTOFILE in eine XML-Datei geschrieben wird.

Der Scriptfunktion muss ein Verweis übergeben werden, um auf ein Element zugreifen zu können. Dieser wird von Script-Sprachmitteln bereitgestellt, die sich innerhalb des XML-Dokuments positionieren können, beispielsweise XML_GET_FIRST_CHILD, XML_GET_NEXTSIBLING oder XML_SELECT_NODE. Die Scriptfunktion bereitet dieses Element samt dessen Subelementen und den zugehörigen Attributen auf.

Es kann auch der Verweis verwendet werden, der XML_OPEN zurückgibt, um die Darstellung des gesamten XML-Dokuments aufzubereiten.

Ohne die Verwendung von XML_BEAUTIFY werden die Informationen des XML-Dokuments hintereinander (ohne Zeilenumbruch) in eine Datei geschrieben. Wird diese Datei mit einem Texteditor, beispielsweise Notepad, geöffnet, ist die Darstellung infolgedessen 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 eine strukturierte Doku-Registerkarte mit dem Namen "@Details" zu dem Objekt hinzugefügt werden, das mit XML_OPEN genutzt wird.

: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:

Script-Sprachmittel Beschreibung

XML_PRINTINTOFILE

Gibt das XML-Dokument in eine Datei aus

Script-Sprachmittel - Objekte lesen oder verändern

Strukturierte Dokumentation

www.w3c.org/TR/xmlbase

Allgemeines zum Script
Script-Sprachmittel - Alphabetische Auflistung

Script-Sprachmittel - Funktionelle Gliederung

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH