Extensions.Xml.XmlLoadFromFile

Classification

Name	XmlLoadFromFile
Short Description	Returns a XmlDocument from a path.
Class	Term
Extension	OTX Xml extension
Group	Xml related Terms
Exceptions	InvalidReferenceException XmlFormatException
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

XmlDocumentTerm Xml.XmlLoadFromFile(StringTerm path, EncodingTerm fallbackEncoding);

Description

The XmlLoadFromFile term returns a XmlDocument from a path.

Return Value

The Term returns the value, see table below.

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

Data Type	Description
XmlDocument	The XmlDocument from a path.

Properties

Name	Data Type	Class	Default	Cardinality	Description
FallbackEncoding	Encoding	Term	@Encoding:UTF-8	[0..1]	Optional encoding value of the ByteField, if no encoding is described in the XML prolog or byte order mark (BOM). If the encoding is defined in the prolog this value should be ignored. If an invalid encoding (BIN, OCT, HEX) is specified, a XmlFormatException shall be thrown.
Path	String	Term	-	[1..1]	The URI path to the file. The path parameter is permitted to specify relative or absolute path information.

OTL Examples

/// Local Declarations

Xml.XmlDocument XmlDocument1;

/// Flow

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

See also

CopyXmlElement
CreateXmlDocument
CreateXmlElement
GetXmlElementAttributes
GetXmlElementChildElements
GetXmlElementName
GetXmlElementsByXPath
GetXmlElementText
GetXmlRootElement
XmlFromByteField
XmlToByteField