FB_XmlDomParser

	Strings in UTF-8 format The variables of type STRING used here are based on the UTF-8 format. This STRING formatting is common for MQTT communication as well as for JSON documents. In order to be able to receive special characters and texts from a wide range of languages, the character set in the Tc3_IotBase and Tc3_JsonXml libraries is not limited to the typical character set of the data type STRING. Instead, the Unicode character set in UTF-8 format is used in conjunction with the data type STRING. If the ASCII character set is used, there is no difference between the typical formatting of a STRING and the UTF-8 formatting of a STRING. Further information on the UTF-8 STRING format and available display and conversion options can be found in the documentation for the Tc2_Utilities PLC library.

Outputs

Name	Type
initStatus	HRESULT

Methods

Name	Description
AppendAttribute	Appends a new attribute to an existing node.
AppendAttributeAsBool	Appends a new attribute to an existing node (Boolean).
AppendAttributeAsDouble	Appends a new attribute to an existing node (Double).
AppendAttributeAsFloat	Appends a new attribute to an existing node (Float).
AppendAttributeAsInt	Appends a new attribute to an existing node (Integer).
AppendAttributeAsLint	Appends a new attribute to an existing node (Integer64).
AppendAttributeAsUint	Appends a new attribute to an existing node (Unsigned Integer).
AppendAttributeAsUlint	Appends a new attribute to an existing node (Unsigned Integer64).
AppendAttributeCopy	Appends a new attribute to an existing node.
AppendChild	Appends a new node below an existing node.
AppendChildAsBool	Appends a new node below an existing node (Boolean).
AppendChildAsDouble	Appends a new node below an existing node (Double).
AppendChildAsFloat	Appends a new node below an existing node (Float).
AppendChildAsInt	Appends a new node below an existing node (Integer).
AppendChildAsLint	Appends a new node below an existing node (Integer64).
AppendChildAsUint	Appends a new node below an existing node (Unsigned Integer).
AppendChildAsUlint	Appends a new node below an existing node (Unsigned Integer64).
AppendCopy	Appends a new node below an existing node.
AppendNode	Appends a new node below an existing node.
Attributes	Reads the attribute of a given XML node.
AttributeAsBool	Returns the value of an attribute as data type Boolean.
AttributeAsDouble	Returns the value of an attribute as data type Double.
AttributeAsFloat	Returns the value of an attribute as data type Float.
AttributeAsInt	Returns the value of an attribute as data type Integer.
AttributeAsLint	Returns the value of an attribute as data type Integer64.
AttributeAsUint	Returns the value of an attribute as data type Unsigned Integer.
AttributeAsUlint	Returns the value of an attribute as data type Unsigned Integer64.
AttributeBegin	Returns an iterator over all attributes of an XML node.
AttributeFromIterator	Converts the current position of an iterator to an XML attribute object.
AttributeName	Returns the name of a given attribute.
Attributes	Used to navigate the DOM and returns an iterator for all attributes found at an XML node.
AttributeText	Returns the text of a given attribute.
Begin	Returns an iterator over all child elements of an XML node.
BeginByName	Returns an iterator over all child elements of an XML node, starting at a particular element.
Child	Used to navigate through the DOM. It returns a reference to the (first) child element of the current node.
ChildByAttribute	Used to navigate through the DOM. It returns a reference to a child element in the XML document.
ChildByAttributeAndName	Used to navigate through the DOM. It returns a reference to a child element in the XML document.
ChildByName	Used to navigate through the DOM. It returns a reference to a child element in the XML document.
Children	Used to navigate through the DOM. It returns an iterator for several child elements found in the XML document.
ChildrenByName	Used to navigate through the DOM. It returns an iterator for several child elements found in the XML document.
ClearIterator	This method resets iterators that have already been used so that they can be used again the next time the program is run.
Compare	Checks two iterators for equality.
CopyAttributeText	Reads the value of an XML attribute and writes it to a variable of data type String.
CopyDocument	Copies the contents of the DOM memory into a variable of data type String.
CopyNodeText	Reads the value of an XML node and writes it to a variable of data type String.
CopyNodeXml	Reads the XML structure of an XML node and writes it to a variable of data type String.
End
FirstNodeByPath	Navigates through an XML document using a path that was transferred to the method.
GetAttributeTextLength	Returns the length of the value of an XML attribute.
GetDocumentLength	Returns the length of an XML document in bytes.
GetDocumentNode	Returns the root node of an XML document.
GetNodeTextLength	Returns the length of the value of an XML node.
GetNodeXmlLength	Returns the length of the XML structure of an XML node.
GetRootNode	Returns a reference to the first XML node in the XML document.
InsertAttributeCopy	Inserts an attribute to an XML node, copying the name and value of an existing attribute.
InsertAttribute	Inserts an attribute to an XML node.
InsertChild	Inserts a node to an existing XML node.
InsertCopy	Inserts a new node to an existing XML node and copies an existing node.
IsEnd	Checks whether a given XML iterator is at the end of the iteration that is to be performed.
LoadDocumentFromFile	Loads a XML document from a file.
NewDocument	Generates a new empty XML document in the DOM memory.
Next	Sets an XML iterator for the next object that is to be processed.
NextAttribute	Returns the next attribute for a given XML attribute.
NextByName	Sets an XML iterator for the next object that is to be processed, which is identified by its name.
NextSibling	Returns the next direct node for a given XML node at the same XML level.
NextSiblingByName	Returns the next direct node for a given XML node with a particular name at the same XML level.
Node	Used in conjunction with an iterator to navigate through the DOM.
NodeAsBool	Returns the text of an XML node as data type Boolean.
NodeAsDouble	Returns the text of an XML node as data type Double.
NodeAsFloat	Returns the text of an XML node as data type Float.
NodeAsInt	Returns the text of an XML node as data type Integer.
NodeAsLint	Returns the text of an XML node as data type Integer64.
NodeAsUint	Returns the text of an XML node as data type Unsigned Integer.
NodeAsUlint	Returns the text of an XML node as data type Unsigned Integer64.
NodeName	Returns the name of an XML node.
NodeText	Returns the text of an XML node.
ParseDocument	Loads an XML object into the DOM memory for further processing.
RemoveAttribute
RemoveAttributeByName
RemoveChild	Removes an XML child node from a given XML node.
RemoveChildByName	Removes an XML child node from a given XML node.
SaveDocumentToFile	Saves the current XML document in a file.
SetAttribute	Sets the value of an attribute.
SetAttributeAsBool	Sets the value of an attribute (Boolean).
SetAttributeAsDouble	Sets the value of an attribute (double).
SetAttributeAsFloat	Sets the value of an attribute (float).
SetAttributeAsInt	Sets the value of an attribute (integer).
SetAttributeAsLint	Sets the value of an attribute (Integer64).
SetAttributeAsUint	Sets the value of an attribute (Unsigned Integer).
SetAttributeAsUlint	Sets the value of an attribute (Unsigned Integer64).
SetChild	Sets the value of an XML node (String).
SetChildAsBool	Sets the value of an XML node (Boolean).
SetChildAsDouble	Sets the value of an XML node (Double).
SetChildAsFloat	Sets the value of an XML node (Float).
SetChildAsInt	Sets the value of an XML node (Integer).
SetChildAsLint	Sets the value of an XML node (Integer64).
SetChildAsUint	Sets the value of an XML node (Unsigned Integer).
SetChildAsUlint	Sets the value of an XML node (Unsigned Integer64).

Requirements

TwinCAT version	Hardware	Libraries to be integrated
TwinCAT 3.1, Build 4022	x86, x64, ARM	Tc3_JsonXml

Further Information