DOM Get XML element
DOM Get XML element ( elementRef : Text ; elementName : Text ; index : Integer {; elementValue : Variable {; attrNames : Text array {; attrValues : Text array }}}) : Text
| Parameter | Type | Description | |
|---|---|---|---|
| elementRef | Text | → | XML element reference |
| elementName | Text | → | Name of element to get |
| index | Integer | → | Index number of element to get |
| elementValue | Variable | ← | Value of the element |
| attrNames | Text array | ← | Attribute names |
| attrValues | Text array | ← | Attribute values |
| Function result | Text | ← | XML reference (16 characters) |
History
| Release | Changes |
|---|---|
| 16 R4 | Modified |
| 2004 | Modified |
| <6 | Created |
Description
The DOM Get XML element command returns a reference to the "child" element dependent on the elementName and index parameters.
The value of the element can be returned in the elementValue optional parameter.
The command fills the attrNames array, if passed, with the names of attributes of the element. If necessary, the command creates and sizes the array automatically.
The command also fills the attrValues array, if passed, with the values of attributes of the target element. If necessary, the command creates and sizes the array automatically.
Note: By default, DOM Get XML element is case sensitive regarding the elementName parameter (xml compliance). You can control the case sensitivity of the command using the XML DOM case sensitivity selector of the XML SET OPTIONS command.
System variables and sets
If the command has been correctly executed, the system variable OK is set to 1. If an error occurs, it is set to 0.
See also
DOM GET XML ELEMENT VALUE
XML SET OPTIONS
Properties
| Command number | 725 |
| Thread safe | yes |
| Modifies variables | OK, error |