Function DE Version 10.01

@XMLGetRoot

XML

Syntax

@XMLGetRoot(XMLD);

Beschreibung

Diese @Function ermittelt das Root-Element eines zuvor eingelesenen XML-Dokuments.
Das übergebene XML-Dokument muss ein gültiges VSPECHXMLDOC (XMLD) Handle enthalten. Als Ergebnis wird ein VSPECHXMLNODE (XMLN) Handle zurückgegeben, das auf das Root-Element des XML-Dokuments verweist.
Die vom XML-Dokument geerbten Flags werden auch auf das zurückgegebene XML-Node-Handle übernommen.

VSPECHXMLDOC XMLD:
Handle der XML-Dokumentstruktur, deren Root-Element ermittelt werden soll.
XMLD muss ein gültiges VSPECHXMLDOC (XMLD) Handle enthalten, das auf eine XML-Dokumentstruktur verweist.

Return-Wert:
Kann kein gültiges Root-Element ermittelt werden, liefert die @Function @ERROR.
Andernfalls wird ein VSPECHXMLNODE (XMLN) Handle zurückgegeben, das auf das Root-Element des XML-Dokuments verweist.

Fehler:
Ist das übergebene XML-Dokument-Handle ungültig, wird ein entsprechender Fehler zurückgegeben.
Enthält das XML-Dokument kein Root-Element, wird folgender Fehler erzeugt:
"XML DOCUMENT HAS NO ROOT ELEMENT"

Beispiel: @XMLGetRoot(XMLD);

XML := "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
"<customer>" +
" <name>Example GmbH</name>" +
" <city>Berlin</city>" +
"</customer>";

hXMLD := @XMLParse(XML);
hXMLRoot := @XMLGetRoot(hXMLD);
@XMLRelease(hXMLD);

Das Beispiel liest ein XML-Dokument ein, ermittelt dessen Root-Element "<customer>" und gibt die XML-Struktur anschließend wieder frei.