...
| Code Block | ||||
|---|---|---|---|---|
| ||||
FUNCTION xpfGetAggrByIndex (aggrId : AGGREGATE OF GENERIC;
elementIndex : INTEGER)
elementValue : GENERIC;
|
The xpfGetAggrByIndex function returns the data value in the actual aggregate element in the argument <elementValue> for the specified aggregate, <aggrid>, and index of the element, <elementIndex>.
This operation is applicable to ordered aggregates, i.e. ARRAY and LIST type aggregates. The actual aggregate element is specified by the element index. Element index zero is the lowest index in a LIST, hence the legal indexes for a LIST are: 0 <= index <= number of elements in LIST. The legal index range for ARRAY is as found in the actual ARRAY declaration in the related EXPRESS schema.
The model that holds the actual aggregate must be open before this function can be successfully performed.
This function is equivalent to the EDMinterface function sdaiGetAggrByIndex.
See also xpxGetAggrByIndex and xpfGetAggrByIterator.
Arguments
...
| Type | Name | Comment |
| AGGREGATE OF GENERIC | aggrId | comments |
| INTEGER | elementIndex |
Return Value
...
| Type | Name | Comment |
| GENERIC | elementValue | comments |
Options
...
Example
...
| Code Block | ||
|---|---|---|
| ||
<Missing Example> |
See also
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|