OpenTestSystem.Otx.Extensions.XML.Terms.XmlToByteField Class Reference

Returns a ByteField from an XmlDocument. More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.XML.Terms.XmlToByteField:

Public Attributes
XmlDocumentTerm	document
	Cardinality [1] The XmlDocument object to which the operation is applied. More...
Public Attributes inherited from OpenTestSystem.Otx.Core.Terms.Term
MetaData	metaData
	Cardinality [0..1] The MetaData type allows tools to store additional, mainly tool-specific data. More...

Detailed Description

Returns a ByteField from an XmlDocument.

The XmlToByteField activity returns a ByteField from an XmlDocument.

The document is serialized using its encoding. The resulting ByteField shall contain the byte representation of a prolog which specifies the character encoding and XML version.
For encodings which require a byte-order mark (BOM), such as UTF-16, a BOM shall be inserted before the prolog. For other encodings, it is unspecified whether a BOM will be inserted.

Exceptions

Exceptions.XmlFormatException

If the content cannot be represented in the encoding of the XmlDocument.

Syntax

ByteFieldTerm = Xml.XmlToByteField(XmlDocumentTerm document);

Examples

// Local Declarations
ByteField ByteField1;
Xml.XmlDocument XmlDocument1;
 
// Flow
XmlDocument1 = Xml.XmlLoadFromFile("XmlStorage/XmlToByteField.xml", @Encoding:UTF-8);
ByteField1 = Xml.XmlToByteField(XmlDocument1);

Member Data Documentation

document

XmlDocumentTerm OpenTestSystem.Otx.Extensions.XML.Terms.XmlToByteField.document

Cardinality [1]
The XmlDocument object to which the operation is applied.