Collapse all Symbian^3 Application Developer Library

TDbSeekKey Class Reference

class TDbSeekKey

Database key value.

The class encapsulates a key value which is passed to RDbTable::SeekL() , for lookup in the currently active index on that rowset.

An instance of this class can store a key value of any type.

Note that the class can only hold a single-column key. Use TDbSeekMultiKey for multi-column keys.

TDbSeekMultiKey RDbTable

Public Member Functions
	TDbSeekKey ()
	TDbSeekKey ( TInt )
	TDbSeekKey ( TUint )
	TDbSeekKey ( TInt64 )
	TDbSeekKey ( TReal32 )
	TDbSeekKey ( TReal64 )
	TDbSeekKey ( TTime )
	TDbSeekKey (const TDesC8 &)
	TDbSeekKey (const TDesC16 &)
IMPORT_C TDbSeekKey &	Add ( TInt )
IMPORT_C TDbSeekKey &	Add ( TUint )
IMPORT_C TDbSeekKey &	Add ( TInt64 )
IMPORT_C TDbSeekKey &	Add ( TReal32 )
IMPORT_C TDbSeekKey &	Add ( TReal64 )
IMPORT_C TDbSeekKey &	Add ( TTime )
IMPORT_C TDbSeekKey &	Add (const TDesC8 &)
IMPORT_C TDbSeekKey &	Add (const TDesC16 &)

Protected Member Functions
	TDbSeekKey ( TInt , TInt )

Private Member Functions
TDbLookupKey &	Check ()

Private Attributes
TDbLookupKey	iKey
TInt	iMaxKeys

Constructor & Destructor Documentation

TDbSeekKey()

TDbSeekKey

(

)

[inline]

Constructs an empty key value.

Add() should be called before the key value is used for lookup.

TDbSeekKey(TInt)

TDbSeekKey

(

TInt

aKey

)

[inline]

Constructs a key value for an TInt8, TInt16 or TInt32 column.

Parameters

TInt aKey

The key value to lookup.

TDbSeekKey(TUint)

TDbSeekKey

(

TUint

aKey

)

[inline]

Constructs a key value for a Bit, TUint8, TUint16 or TUint32 column.

Parameters

TUint aKey

The key value to lookup.

TDbSeekKey(TInt64)

TDbSeekKey

(

TInt64

aKey

)

[inline]

Parameters

TInt64 aKey

TDbSeekKey(TReal32)

TDbSeekKey

(

TReal32

aKey

)

[inline]

Constructs a key value for a TReal32 column.

Parameters

TReal32 aKey

The key value to lookup.

TDbSeekKey(TReal64)

TDbSeekKey

(

TReal64

aKey

)

[inline]

Construct a key value for a TReal64 column.

Parameters

TReal64 aKey

The key value to lookup.

TDbSeekKey(TTime)

TDbSeekKey

(

TTime

aKey

)

[inline]

Constructs a key value for a TDateTime column.

Parameters

TTime aKey

The key value to lookup.

TDbSeekKey(const TDesC8 &)

TDbSeekKey

(

const TDesC8 &

aKey

)

[inline]

Constructs a key value for a non-Unicode text column.

Note that the seek key does not copy the text data contained by the descriptor. This needs to be retained until the seek key is no longer required.

Parameters

const TDesC8 & aKey

The key value to lookup.

TDbSeekKey(const TDesC16 &)

TDbSeekKey

(

const TDesC16 &

aKey

)

[inline]

Constructs a key value for a Unicode text column.

Note that the seek key does not copy the text data contained by the descriptor. This needs to be retained until the seek key is no longer required.

Parameters

const TDesC16 & aKey

The key value to lookup.

TDbSeekKey(TInt, TInt)

TDbSeekKey	(	TInt	aKeys,
		TInt
	)	[protected, inline]

Parameters

TInt aKeys
TInt

Member Functions Documentation

Add(TInt)

IMPORT_C TDbSeekKey &

Add

(

TInt

aKey

)

Appends a key value for an TInt8, TInt16 or TInt32 column.

Parameters

TInt aKey

The key value to lookup.

Add(TUint)

IMPORT_C TDbSeekKey &

Add

(

TUint

aKey

)

Parameters

TUint aKey

Add(TInt64)

IMPORT_C TDbSeekKey &

Add

(

TInt64

aKey

)

Parameters

TInt64 aKey

Add(TReal32)

IMPORT_C TDbSeekKey &

Add

(

TReal32

aKey

)

Parameters

TReal32 aKey

Add(TReal64)

IMPORT_C TDbSeekKey &

Add

(

TReal64

aKey

)

Parameters

TReal64 aKey

Add(TTime)

IMPORT_C TDbSeekKey &

Add

(

TTime

aKey

)

Parameters

TTime aKey

Add(const TDesC8 &)

IMPORT_C TDbSeekKey &

Add

(

const TDesC8 &

aKey

)

Parameters

const TDesC8 & aKey

Add(const TDesC16 &)

IMPORT_C TDbSeekKey &

Add

(

const TDesC16 &

aKey

)

Parameters

const TDesC16 & aKey

Check()

TDbLookupKey &

Check

(

)

[private]

Member Data Documentation

TDbLookupKey iKey

TDbLookupKey

iKey

[private]

TInt iMaxKeys

TInt

iMaxKeys

[private]