...
| Code Block | ||||
|---|---|---|---|---|
| ||||
FUNCTION xpfSelectInstancesBN (modelId : GENERIC;
entityName, condition : STRING;
options : INTEGER;
firstIndex, maxHits : INTEGER;
VAR indexOfLastFound : INTEGER;
VAR actualHits : INTEGER)
resultAggrId : SET OF GENERIC;
|
The xpfSelectInstancesBN function search in the specified model, <modelId>, for instances of the specified type, <entityName>, that match the specified condition, <condition>. Optionally all subtype instances of the specified type will be search as well.
The condition is specified as any legal symbolic Express-X logical expression. 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 possible matching instances will be collected in a temporarily aggregate, hence this aggregate will be queried for matching instances. The index of the first 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 aggregate? " are returned from the operation. This makes it convenient to query the aggregate by the xpfSelectInstancesBN function in an incremental way.
The <condition> argument will be compiled by the EDMexpressXCompiler.
The specified query will fully be executed by the EDMexpressVM.
The actual model to query must be open before this operation can be successfully performed.
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.
This function is equivalent to the EDMinterface function edmiSelectInstancesBN.
See also xpxSelectInstancesBN.
Arguments
...
| Type | Name | Comment |
| GENERIC | modelId | Unique id of the model within the EDMdatabase |
| STRING | entityName | Entity name within the model to be search for |
| STRING | condition | Conditions for the search |
| INTEGER | options | |
| INTEGER | firstIndex | |
| INTEGER | maxHits | |
| INTEGER | indexOfLastFound | |
| INTEGER | actualHits |
Return Value
...
| Type | Name | Comment |
| SET OF GENERIC | resultAggrId | comments |
Options
...
| Option | Comment |
| XPXSOMEOPTION | comment |
Example
...
| Code Block | ||
|---|---|---|
| ||
<Missing Example> |
See also
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|