xpxGetHashedAttrInstancesBN

FUNCTION xpxGetHashedAttrInstancesBN (modelId               : GENERIC;
                                      entityName            : STRING;
                                      attributeName         : STRING;
                                      attrValue             : GENERIC;
                                      index                 : INTEGER;
                                      maxHits               : INTEGER;
                                      VAR indexOfLastFound  : INTEGER;
                                      VAR matchingInstances : SET OF GENERIC)
                                      rstat                 : INTEGER;   

The xpxGetHashedAttrInstancesBN function is used to search the specified model for the instances with an attribute value equal to the specified attribute. The attribute is specified by name via the arguments <entityName> and <attributeName>. The argument <attrValue> is used to specify the attribute value, this value can be a string or integer. Additional input parameters are starting index and maximum number of hits. The index of last instance found and the aggregate of matching instances found are returned by the corresponding arguments.

If no attribute hash table is defined for the specified attribute, no sequential search is performed and the function returns an error code. See the functions xpxDefinePersistentAttrHashTable and xpxDefinePersistentAttrHashTableBN.

If no matching instances are found then the index of last found argument is zero and the matching instances argument is set to xpxINDETERMINATE.

Related functions: xpxGetHashedAttrInstances, xpfGetHashedAttrInstance and xpfGetHashedAttrInstanceBN.

This function is equivalent to the EDMinterface^TM function edmiGetHashedAttrInstancesBN.

Arguments

<arguments missing>

Return Value

Options

<arguments missing>

Example

<example missing>

See also