xpfGetHashedAttrInstanceBN

FUNCTION xpfGetHashedAttrInstanceBN (modelId            : GENERIC;
                                     entityName         : STRING;
                                     attributeName      : STRING;
                                     attrValue          : GENERIC)
                                     matchingInstanceId : GENERIC;       

The xpfGetHashedAttrInstanceBN function is used to search the specified model for the instance id of the instance where the specified attribute has exactly the specified value. 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. This function returns only one instance id, which implies that you only should use this function if the attribute value is defined to be unique. If the attribute value may occur in more than one instance, use xpxGetHashedAttrInstancesBN.

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.

The matching instance found is returned by the function. If no matching instance is found then the function returns xpxINDETERMINATE.

Arguments

Return Value

Options

Example

<example missing>

See also