xpfFindInstancesBN

FUNCTION  xpfFindInstancesBN (modelId               : GENERIC;
                              entityName, condition : STRING; 
                              firstIndex, maxHits   : INTEGER; 
                              VAR indexOfLastFound  : INTEGER;  
                              VAR actualHits        : INTEGER)  
                              resultAggrId          : LIST OF GENERIC;
                

The xpfFindInstancesBN function search in the specified model, as specified in the argument <modelId>, for instances of the specified type that match the specified condition. The condition is specified as attribute values of the instances. All instances of the specified type in the specified model 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 . All instances of a particular type is hold in an entity extent aggregate, hence this aggregate will be queried for matching instances. The index of the first entity extent aggregate element to test for an instance that match the specified condition, and the maximum number of matching instances 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 entity extent aggregate? are returned from the operation. This makes it convenient to query the entity extent aggregate by the xpfFindInstancesBN function in an incremental way. The actual model to query must be open before this operation can be successfully performed.

Arguments

Return Value

Options

Example

<Missing Example>

See also