Class TDbSeekKey

TDbSeekKey

Support

Supported from 5.0

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.

Defined in TDbSeekKey:
Add(), TDbSeekKey()

See also:

• TDbSeekMultiKey
• RDbTable

TDbSeekKey();

Description

Constructs an empty key value.

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

TDbSeekKey(TInt aKey);

Description

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

Parameters

TInt aKey The key value to lookup.

TDbSeekKey(TUint aKey);

Description

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

Parameters

TUint aKey The key value to lookup.

TDbSeekKey(TInt64 aKey);

Description

Constructs a key value for a TInt64 column.

Parameters

TInt64 aKey The key value to lookup.

TDbSeekKey(TReal32 aKey);

Description

Constructs a key value for a TReal32 column.

Parameters

TReal32 aKey The key value to lookup.

TDbSeekKey(TReal64 aKey);

Description

Construct a key value for a TReal64 column.

Parameters

TReal64 aKey The key value to lookup.

TDbSeekKey(TTime aKey);

Description

Constructs a key value for a TDateTime column.

Parameters

TTime aKey The key value to lookup.

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.

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.

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.

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.

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.

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.

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.

TDbSeekKey& Add(TTime aKey);

Description

Appends a key value for a DateTime column.

Parameters

TTime aKey The key value to lookup.

Return value

TDbSeekKey& A reference to this database key value object.

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.

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.