xpxFindInstancesBN

FUNCTION xpxFindInstancesBN (modelId                : GENERIC;
                             entityName , condition : STRING;
                             firstIndex , maxHits   : INTEGER;                             
                             VAR indexOfLastFound   : INTEGER; 
                             VAR actualHits         : INTEGER; 
                             VAR foundInstances     : AGGREGATE OF GENERIC)
                             status                 : INTEGER;

The xpxFindInstancesBN function searches the specified model modelId for instances of a specified type, and that matches a specified condition. The instance type is specified by the entityName argument. The condition to match is specified in the condition argument. The condition argument can be an empty string meaning that all instances of the actual entity will match the query. The argument firstIndex specifies the index of the first instance in the actual entity extent to test against the condition. The first instance in the entity extent has an index equal to one. The argument maxHits specifies the maximum number of matching instanceIds that should be returned in the foundInstances argument. The argument indexOfLastFound is the index in the entity extent of the last found matching instance and the argument actualHits returns the actual number of returned instanceIds in the foundInstances aggregate.

When the input arguments ((maxHits == 0) && (foundInstances == NULL)) no instanceId or elementNumber will be returned. Only the number of matching instances/elements will be returned.

Arguments

Return Value

Options

Example

<Missing Example>

See also