Class TDbSeekKey

class TDbSeekKey;

Description

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.

Members

Defined in TDbSeekKey:
Add(), Add(), Add(), Add(), Add(), Add(), Add(), Add(), TDbSeekKey(), TDbSeekKey(), TDbSeekKey(), TDbSeekKey(), TDbSeekKey(), TDbSeekKey(), TDbSeekKey(), TDbSeekKey(), TDbSeekKey(), TDbSeekKey()

See also:

• TDbSeekMultiKey
• RDbTable

inline TDbSeekKey();

Description

Constructs an empty key value.

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

inline TDbSeekKey(TInt aKey);

Description

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

Parameters

TInt aKey The key value to lookup.

inline TDbSeekKey(TUint aKey);

Description

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

Parameters

TUint aKey The key value to lookup.

inline TDbSeekKey(TInt64 aKey);

Description

Parameters

TInt64 aKey

inline TDbSeekKey(TReal32 aKey);

Description

Constructs a key value for a TReal32 column.

Parameters

TReal32 aKey The key value to lookup.

inline TDbSeekKey(TReal64 aKey);

Description

Construct a key value for a TReal64 column.

Parameters

TReal64 aKey The key value to lookup.

inline TDbSeekKey(TTime aKey);

Description

Constructs a key value for a TDateTime column.

Parameters

TTime aKey The key value to lookup.

inline TDbSeekKey(const TDesC8 &aKey);

Description

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.

inline TDbSeekKey(const TDesC16 &aKey);

Description

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.

protected: inline TDbSeekKey(TInt aKeys, TInt);

Description

Parameters

TInt aKeys TInt

IMPORT_C TDbSeekKey &Add(TInt aKey);

Description

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

Parameters

TInt aKey The key value to lookup.

Return value

TDbSeekKey & A reference to this database key value object.

IMPORT_C TDbSeekKey &Add(TUint aKey);

Description

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

Parameters

TUint aKey The key value to lookup.

Return value

TDbSeekKey & A reference to this database key value object.

IMPORT_C TDbSeekKey &Add(TInt64 aKey);

Description

Appends a key value for an TInt64 column.

Parameters

TInt64 aKey The key value to lookup.

Return value

TDbSeekKey & A reference to this database key value object.

IMPORT_C TDbSeekKey &Add(TReal32 aKey);

Description

Appends a key value for a TReal32 column.

Parameters

TReal32 aKey The key value to lookup.

Return value

TDbSeekKey & A reference to this database key value object.

IMPORT_C TDbSeekKey &Add(TReal64 aKey);

Description

Appends a key value for a TReal64 column.

Parameters

TReal64 aKey The key value to lookup.

Return value

TDbSeekKey & A reference to this database key value object.

IMPORT_C TDbSeekKey &Add(TTime aKey);

Description

Appends a key value for a DateTime column.

Parameters

TTime aKey The key value to lookup. TTime may be either local time or universal time. DBMS doesn't interpret the value of TTime, it is left up to the user to decide which should be used.

Return value

TDbSeekKey & A reference to this database key value object.

IMPORT_C TDbSeekKey &Add(const TDesC8 &aKey);

Description

Appends 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.

Return value

TDbSeekKey & A reference to this database key value object.

IMPORT_C TDbSeekKey &Add(const TDesC16 &aKey);

Description

Appends 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.

Return value

TDbSeekKey & A reference to this database key value object.