Collapse all Symbian^3 Product Developer Library

CDbKey Class Reference

class CDbKey : public CBase

Represents the definition of an index. The key may be unique or primary, it can specify the sort of comparison which is made for Text columns, and it has a list of columns which make up the key. The class is used to construct and interrogate index keys.

This class is not intended for user derivation.

Inherits from

CDbKey
- CBase

Public Member Functions
	CDbKey()
	~CDbKey()
IMPORT_C CDbKey &	AddL(const TDbKeyCol &)
IMPORT_C void	Clear()
TDbTextComparison	Comparison()
TInt	Count()
TBool	IsPrimary()
TBool	IsUnique()
void	MakePrimary()
void	MakeUnique()
IMPORT_C CDbKey *	NewL()
IMPORT_C CDbKey *	NewLC()
IMPORT_C void	Remove(const TDesC &)
void	SetComparison(TDbTextComparison)
const TDbKeyCol &	operator[](TInt)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
TInt	iAttributes
TDbTextComparison	iComparison
CArrayPakFlat< TDbKeyCol >	iKeys

Constructor & Destructor Documentation

CDbKey()

IMPORT_C

CDbKey

(

)

~CDbKey()

IMPORT_C

~CDbKey

(

)

Member Functions Documentation

AddL(const TDbKeyCol &)

IMPORT_C CDbKey &

AddL

(

const TDbKeyCol &

aKeyCol

)

Parameters

const TDbKeyCol & aKeyCol

Clear()

IMPORT_C void

Clear

(

)

Comparison()

TDbTextComparison

Comparison

(

)

const [inline]

Returns the method used to compare Text columns in this key.

Count()

TInt

Count

(

)

const [inline]

IsPrimary()

TBool

IsPrimary

(

)

const [inline]

Tests whether the key is the primary key.

IsUnique()

TBool

IsUnique

(

)

const [inline]

Tests whether the key is unique.

MakePrimary()

void

MakePrimary

(

)

[inline]

MakeUnique()

void

MakeUnique

(

)

[inline]

Makes the key unique. This ensures that every key value in the index is distinct from every other.

NewL()

IMPORT_C CDbKey *

NewL

(

)

[static]

NewLC()

IMPORT_C CDbKey *

NewLC

(

)

[static]

Remove(const TDesC &)

IMPORT_C void

Remove

(

const TDesC &

aColName

)

Parameters

const TDesC & aColName

SetComparison(TDbTextComparison)

void

SetComparison

(

TDbTextComparison

aComparison

)

[inline]

Sets the way in which Text columns are compared for the key. All Text columns in the key are compared in the same way.

Parameters

TDbTextComparison aComparison

The comparison type to use.

operator[](TInt)

const TDbKeyCol &

operator[]

(

TInt

aCol

)

const [inline]

Returns a key column by its position in the key.

Parameters

TInt aCol

The position of the column in the key. These are numbered from 0 to Count()-1.

Member Data Documentation

TInt iAttributes

TInt

iAttributes

[private]

TDbTextComparison iComparison

TDbTextComparison

iComparison

[private]

CArrayPakFlat< TDbKeyCol > iKeys

CArrayPakFlat< TDbKeyCol >

iKeys

[private]