Extensions.Xml.GetXmlRootElement

Classification

Name	GetXmlRootElement
Short Description	Returns the root element of an XML document.
Class	Term
Extension	OTX Xml extension
Group	Xml related Terms
Exceptions	-
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

/// Local Declarations
Xml.XmlElement XmlElementVariable;
/// Flow
XmlElementVariable = Xml.GetXmlRootElement(XmlDocumentTerm);

Description

The GetXmlRootElement term returns the root element (root node) of an XML document.

Return Value

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
XmlElement	The root element of an XML document.

Properties

Name	Data Type	Class	Default	Cardinality	Description
Document	XmlDocument	Term	-	[1..1]	The XmlDocument object, to which the operation is applied.

OTL Examples

/// Local Declarations

Xml.XmlDocument XmlDocument1;
Xml.XmlElement XmlElement1;

/// Flow

XmlDocument1 = Xml.XmlLoadFromFile("XmlStorage/GetXmlElementsByXPath.xml", @Encoding:UTF-8);
XmlElement1 = Xml.GetXmlRootElement(XmlDocument1);

See also

CopyXmlElement
CreateXmlDocument
CreateXmlElement
GetXmlElementAttributes
GetXmlElementChildElements
GetXmlElementName
GetXmlElementsByXPath
GetXmlElementText
XmlFromByteField
XmlLoadFromFile
XmlToByteField