xpfFindAggrElements

FUNCTION xpfFindAggrElements (aggrId               : AGGREGATE OF GENERIC;
                              condition            : STRING; 
                              firstIndex, maxHits  : INTEGER;
                              VAR indexOfLastFound : INTEGER;
                              VAR actualHits       : INTEGER)
                              resultAggrId         : LIST OF INTEGER;
                

The xpfFindAggrElements function search in the specified aggregate, as specified in the <aggrId> argument, for elements that matches the specified conditions. All elements in the specified aggregate will match an empty condition, i.e. the <condition> argument set to NULL. Each matching element is identified by the element index. The index of the first aggregate element to test for matching the specified condition, and the maximum number of matching elements to return, are specified as input arguments to the function. The actual number of matching elements, argument <actualHits>, and the ?index of the last returned matching element in the aggregate?, argument <indexOfLastFound>, are returned from the operation. This makes it convenient to query an aggregate by the xpfFindAggrElements function in an incremental way. The actual model hosting the specified aggregate to query must be open before this operation can be successfully performed.

Arguments

Return Value

Options

Example

<Missing Example>

See also