Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current » 

FUNCTION xpxRemoveInstancesFromInstanceHashTable (instanceHashTableIndex                     : INTEGER;
                                                  instanceIdOrAggrIdOrInstanceHashTableIndex : GENERIC;
                                                  options                                    : INTEGER) 
                                                  status                                     : INTEGER;

Function to remove one or a set of given elements from an EDMinstanceHashTable.

Arguments

1TypeNameComment
2INTEGERinstanceHashTableIndexThe function return the integer value xpxOK ( = 0) when the function is successfully performed. When the function fails, an error code is returned. Exception handling can also be used to handle error conditions in the actual xpxRemoveInstancesFromInstanceHashTable() operation.
3GENERICinstanceIdOrAggrIdOrInstanceHashTableIndex

This argument defines the elements that should be removed from the given EDMinstanceHashTable. This argument can be specified in the following ways:

  1. As an instanceId.
  2. As an aggregateId that can mean one of the following:
    1. When the option xpxINSERT_AGGRID_IN_INSTANCE_HASH_TABLE is enabled, the actual specified aggregateId will be removed
    2. The set of elements in the aggregateId will be removed.
  3. An integer that is an EDMinstanceHashTableIndex, i.e., all elements in this EDMinstanceHashTable will be removed from the EDMinstanceHashTable spcified by the "instanceHashTableIndex".

An instanceId can be an element in all types of EDMinstanceHashTable. An aggregateId can only be an element in EDMinstanceTable of type INSTANCE_HASH_TABLE_WITH_ROLES and INSTANCE_HASH_TABLE_WITH_MULTIPLE_ASSOCIATED_VALUES

4INTEGERoptionsOptional argument. Default value is INDETERMINATE (?)

Return Value

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_XPX_Return_Value'.

Options

OptionComment
xpxINSERT_AGGRID_IN_INSTANCE_HASH_TABLEWhen the "instanceIdOrAggrIdOrInstanceHashTableIndex" argument is an aggregateId, the actual aggregateId will be removed instead of the contents (elements) of the aggregate identified by the aggregateId.

 

Example

<Missing Example>

 

See also

Filter by label

There are no items with the selected labels at this time.

 

  • No labels