xpfGetAssociatedValueOfInstanceInInstanceHashTable

FUNCTION xpfGetAssociatedValueOfInstanceInInstanceHashTable(instanceHashTableIndex                : INTEGER;
                                                            instanceIdOrAggrId                    : GENERIC;
                                                            options                               : INTEGER;
                                                            index                                 : INTEGER;
                                                            VAR associatedValues                  : INTEGER)
                                                            assoiatedValueOrSetOfAssociatedValues : GENERIC;

Function to get the associated value of a specified element in a given EDMinstanceHashTable. An associate value is an instanceId or an aggregateId. This function is only applicable for EDMinstanceHashTables of type INSTANCE_HASH_TABLE_WITH_ASSOCIATED_VALUE and INSTANCE_HASH_TABLE_WITH_MULTIPLE_ASSOCIATED_VALUES. This function has variable number of arguments, i.e., it can be invoked with a minimum of 3 arguments and a maximum of 5 arguments.

Arguments

1	Type	Name	Comment
2	INTEGER	instanceHashTableIndex	An integer value that identifies the actual EDMinstanceHashTable. This "instanceHashTableIndex" is returned when the actual EDMinstanceHashTable was created. The actual EDMinstanceHashTable must be of type INSTANCE_HASH_TABLE_WITH_ASSOCIATED_VALUE or INSTANCE_HASH_TABLE_WITH_MULTIPLE_ASSOCIATED_VALUES
3	GENERIC	instanceIdOrAggrId	An instanceId or an aggregateId that identifies the actual element in the EDMinstanceHashTable to get the associated value of.
4	INTEGER	options	Optional argument. Default value is INDETERMINATE (?), meaning that only one associated value will be returned in one invocation of the xpfGetAssociatedValueOfInstanceInInstanceHashTable() function.
5	INTEGER	index	Optional argument. Default value is "index = 1", meaning that the first associated value will be fetched. When specified it defines the index of the associated values of the given EDMinstanceHashTable entry to fetch.
6	INTEGER	associatedValues	Optional argument. When specified, the number of associated values of the given EDMinstanceHashTable entry will be returned in this argument.

Return Value

Type	Name	Comment
GENERIC	assoiatedValueOrSetOfAssociatedValues	The function return the found associated value as a single instanceId/aggregateId or as a SET aggregate that contains all the associated values. Each element in the returned SET aggregate is an instanceId or an aggregateId. When the function fails, the value INDETERMINATE (?) will be returned. Exception handling should be used to handle error conditions in the actual xpfGetAssociatedValueOfInstanceInInstanceHashTable() operation.

Options

Option	Comment
xpxALL_ASSOCIATED_VALUES	When this option is enabled, all associated values of the given EDMinstanceHashTable entry are returned.

Example

<Missing Example>

EDMsix

xpfGetAssociatedValueOfInstanceInInstanceHashTable

Arguments

Return Value

Options

Example

See also

Filter by label