XML_BEAUTIFY

Script-Funktion: Bereitet die Darstellung eines XML-Dokumentes auf.

Syntax

XML_BEAUTIFY (Referenz)

Syntax

Beschreibung/Format

Referenz

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


Rückgabewerte

"0" - Der Inhalt des XML-Dokumentes wurde erfolgreich aufbereitet

Die Script-Funktion bereitet die Darstellung eines XML-Dokuments auf, bevor dieses mit XML_PRINTINTOFILE in eine XML-Datei geschrieben wird. Weitere Informationen finden Sie unter XML_PRINTINTOFILE.

Hinweis: Sie müssen ein Handle für die Script-Funktion angeben, um auf das Element zugreifen zu können. Verwenden Sie eine Script-Funktion, die die Position innerhalb des XML-Dokuments übernimmt, um das Handle bereitzustellen. Im Folgenden finden Sie Beispiele für Script-Elemente, die Sie für diesen Zweck verwenden können:

Die Script-Funktion bereitet dieses Element samt dessen Subelementen und die zugehörigen Attributen auf. 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 infolgedessen unübersichtlich.

Tipp: Sie können auch das von XML_OPEN zurückgegebene Handle verwenden, um die Anzeige des gesamten XML-Dokuments vorzubereiten. Weitere Informationen finden Sie unter XML_OPEN.

Beispiele

Die komplette Struktur der Dokumentation wird zunächst in besser lesbarer Form aufbereitet und anschließend in die Datei Doku.xml ausgegeben.

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