Class TKeyArrayVar

TKeyArrayVar

Support

Supported from 5.0

Description

Defines the characteristics of a key used to access the elements of arrays of variable length objects.

An object of this type can represent three categories of key, depending on the constructor used:

• a descriptor key

• a text key

• a numeric key.

The Sort(), InsertIsqL(), Find() and FindIsqL() member functions of the CArrayVarFlat and CArrayVarSeg class hierarchies need a TKeyArrayVar object as an argument to define the location and type of key within an array element.

A TKeyArrayVar object is also required for sorting a packed array. The implementation of the SortL() member function of the CArrayPakFlat class constructs a temporary CArrayVarFlat object which requires the TKeyArrayVar object.

Derivation

TKey Defines the characteristics of a key used to access the elements of an array TKeyArrayVar Defines the characteristics of a key used to access the elements of arrays of variable length objects

Defined in TKeyArrayVar:
TKeyArrayVar()

Inherited from TKey:
At(), Compare(), SetPtr()

See also:

• CArrayVarFlat
• CArrayVarSeg
• CArrayPakFlat

TKeyArrayVar(TInt anOffset,TKeyCmpText aType);

Description

Constructs the characteristics of a descriptor key.

No length value is passed as this is taken from the descriptor type key.

Parameters

TInt anOffset The offset of the key from the start of an array element. TKeyCmpText aType An enumeration which defines the type of comparison to be made between two descriptor keys.

See also:

• TKeyCmpText

TKeyArrayVar(TInt anOffset,TKeyCmpText aType,TInt aLength);

Description

Constructs the characteristics of a text key.

Parameters

TInt anOffset The offset of the key from the start of an array element. TKeyCmpText aType An enumeration which defines the type of comparison to be made between two text keys. TInt aLength The length of the text key.

See also:

• TKeyCmpText

TKeyArrayVar(TInt anOffset,TKeyCmpNumeric aType);

Description

Constructs the characteristics of a numeric key.

Parameters

TInt anOffset The offset of the key from the start of an array element. TKeyCmpNumeric aType An enumeration which defines the type of the numeric key.

See also:

• TKeyCmpNumeric