FUNCTION xpfGetInstanceInInstanceHashTable (instanceHashTableIndex   : INTEGER;
                                            index                    : INTEGER;
                                            VAR associatedValue      : GENERIC)
                                            instanceIdOrAggrId       : GENERIC;

Function to get an element from an EDMinstanceHashTable. Optionally, an associated value of the actual EDMinstanceHashTable element can be returned. This function can be used to sequentially fetch all elements in a given EDMinstanceHashTable. The element in an EDMinstanceHashTable is either an instanceId or an aggregateId. An associated value is also either an instanceId or an aggregateId. This function has variable number of arguments, i.e., it can be invoked with a minimum of 2 arguments and a maximum of 3 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.
3	INTEGER	index	specifying the element index in the given EDMinstanceHashTable. The index range is 1 to "numer of elements" in the EDMinstanceHashTable. When specified it defines the index of the associated values of the given EDMinstanceHashTable entry to fetch.
4	GENERIC	associatedValue	Optional argument. When specified, the first associated value of the EDMinstanceHashTable element will be returned in this argument. When no acossated value exists, INDETERMINATE (?) will be returned in this argument.

Return Value

Type	Name	Comment
GENERIC	instanceIdOrAggrId	The function return the found EDMinstanceHashTable element, i.e. an instanceId or an aggregateId. When no EDMinstanceHashTable element is found, the constant xpxNULLID is returned. Exception handling should be used to handle error conditions in the actual xpfGetInstanceInInstanceHashTable() operation.

Options

Example

<Missing Example>

Arguments

Return Value

Options

Example

See also

Filter by label