xpfFindAggrInstances

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

The xpfFindAggrInstances function search in the specified aggregate, as specified in the <aggrId> argument, for instances that matches the specified conditions. All instances in the specified aggregate will match an empty condition, i.e. the <condition> argument set to NULL. Each matching instance is identified by a numeric instanceID that uniquely identifies an instance in the EDMdatabase . The index of the first aggregate element, <firstIndex>, to test for matching the specified condition, and the maximum number of matching instances, <maxHits>, to return, are specified as input arguments to the function. The actual number of matching instances returned and the ?index of the last returned matching instance in the aggregate? are returned from the operation. This makes it convenient to query an aggregate by the xpfFindAggrInstances 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