Classification
| Name |
XmlToByteField
|
| Short Description |
Returns a ByteField from an XmlDocument.
|
| Class |
Term
|
| Extension |
OTX Xml extension
|
| Group |
Xml related Terms
|
| Exceptions |
-
|
| Checker Rules |
-
|
| Standard Compliant |
Yes
|
OTL Syntax
ByteFieldTerm Xml.XmlToByteField(XmlDocumentTerm document);
Description
The XmlToByteField term 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.
Return Value
The Term returns the value, see table below.
|
|
In OTX, Terms are categorized according to its return data type!
|
| Data Type |
Description
|
| ByteField |
The ByteField from an XmlDocument.
|
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;
ByteField ByteField1;
/// Flow
XmlDocument1 = Xml.XmlLoadFromFile("XmlStorage/XmlToByteField.xml", @Encoding:UTF-8);
ByteField1 = Xml.XmlToByteField(XmlDocument1);
See also
CopyXmlElement
CreateXmlDocument
CreateXmlElement
GetXmlElementAttributes
GetXmlElementChildElements
GetXmlElementName
GetXmlElementsByXPath
GetXmlElementText
GetXmlRootElement
XmlFromByteField
XmlLoadFromFile
