GetDimElements

Syntax

GetDimElementsResult GetDimElements(DmId tDim, GetDimElementsArg tArg)

Parameters

tDim. Opened dictionary instance moniker.

tArg. Parameters for getting information about dictionary elements.

Description

The GetDimElements operation gets information about dictionary elements.

Comments

This operation enables the user to get the following information:

Values of the attributes determined for elements.
Information about location of the element in the general hierarchy.
Information about selection of elements.

To execute the operation, in the tDim parameter specify the opened dictionary instance moniker, and in the tArg parameter specify parameters to be used to select elements. The moniker can be obtained on executing the OpenDim operation. If no field is defined in the tArg parameter, the following information is obtained for all dictionary elements:

Element key.
Element name.
Availability of child elements.
Element level in the general hierarchy.

After defining the fields in the tArg parameter, the user can limit the obtained information and the list of elements for which it is to be obtained.

The list of elements is restricted by defining filtering parameters in the tArg.filter field. The list of elements will include only the elements that satisfy selected filtering criteria. If different filtering types are determined in the tArg.filter field, the filters are applied in the following order:

Selection of group of elements.
Selection of elements by keys.
Selection of elements by attribute values.

Example

Various methods of using the operation are given in the following examples:

Example name

Selecting elements by attribute values

Selecting lements before getting information

Selecting elements corresponding to group of elements

Selecting elements by their keys

Getting values of specified attributes

Getting information about element selection

Getting information about dictionary elements