Difference between revisions of "Extensions.Xml.XmlToByteField"
Jump to navigation
Jump to search
| (One intermediate revision by the same user not shown) | |||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | ByteFieldTerm | + | ByteFieldTerm Xml.XmlToByteField(XmlDocumentTerm document); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 25: | Line 25: | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
Xml.XmlDocument XmlDocument1; | Xml.XmlDocument XmlDocument1; | ||
ByteField ByteField1; | ByteField ByteField1; | ||
Latest revision as of 06:36, 8 November 2018
Contents
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
