Collapse all Symbian^3 Application Developer Library

TDbKeyCol Class Reference

class TDbKeyCol

Defines a key column in an index.

The data members are public as this is really a structure to group the attributes of the key column together. Two non-default constructors are provided for convenience.

Public Member Functions
	TDbKeyCol ()
	TDbKeyCol (const TDbKeyCol &)
	TDbKeyCol (const TDesC &, TOrder )
	TDbKeyCol (const TDesC &, TInt , TOrder )
TDbKeyCol &	operator= (const TDbKeyCol &)

Public Member Enumerations
enum	TOrder { EAsc , EDesc }

Public Attributes
TInt	iLength
TDbColNameC	iName
TOrder	iOrder

Constructor & Destructor Documentation

TDbKeyCol()

TDbKeyCol

(

)

[inline]

Constructs an uninitialised object. Default constructor. It is necessary because there are also non-default constructors in this class.

TDbKeyCol(const TDbKeyCol &)

TDbKeyCol

(

const TDbKeyCol &

)

[inline]

TDbKeyCol copy constructor.

Parameters

const TDbKeyCol &

This TDbKeyCol object will be constructed as an exact copy of aSrcKeyCol object.

TDbKeyCol(const TDesC &, TOrder)

IMPORT_C	TDbKeyCol	(	const TDesC &	aName,
			TOrder	anOrder = EAsc
		)

Parameters

const TDesC & aName
TOrder anOrder = EAsc

TDbKeyCol(const TDesC &, TInt, TOrder)

IMPORT_C	TDbKeyCol	(	const TDesC &	aName,
			TInt	aLength,
			TOrder	anOrder = EAsc
		)

Parameters

const TDesC & aName
TInt aLength
TOrder anOrder = EAsc

Member Functions Documentation

operator=(const TDbKeyCol &)

TDbKeyCol &

operator=

(

const TDbKeyCol &

)

[inline]

TDbKeyCol "=" operator.

Parameters

const TDbKeyCol &

This TDbKeyCol object will be made to be an exact copy of aSrcKeyCol object.

Member Enumerations Documentation

Enum TOrder

Specifies whether a key column in an index should be sorted in ascending or descending order.

Enumerators

EAsc	Use ascending order.
EDesc	Use descending order.

Member Data Documentation

TInt iLength

TInt

iLength

The maximum number of characters used to index Text or LongText columns. If equal to KDbUndefinedLength (the default), all the characters in the defined column will be used.

TDbColNameC iName

TDbColNameC

iName

The column name for the key.

TOrder iOrder

TOrder

iOrder

The ordering of the key.