TDbSeekKey Class Reference

#include <d32dbms.h>

Link against: edbms.lib

class TDbSeekKey
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)

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

See also: TDbSeekMultiKey RDbTable

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(TIntaKey)[inline]

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

ParameterDescription
aKeyThe key value to lookup.

TDbSeekKey ( TUint )

TDbSeekKey(TUintaKey)[inline]

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

ParameterDescription
aKeyThe key value to lookup.

TDbSeekKey ( TInt64 )

TDbSeekKey(TInt64aKey)[inline]

TDbSeekKey ( TReal32 )

TDbSeekKey(TReal32aKey)[inline]

Constructs a key value for a TReal32 column.

ParameterDescription
aKeyThe key value to lookup.

TDbSeekKey ( TReal64 )

TDbSeekKey(TReal64aKey)[inline]

Construct a key value for a TReal64 column.

ParameterDescription
aKeyThe key value to lookup.

TDbSeekKey ( TTime )

TDbSeekKey(TTimeaKey)[inline]

Constructs a key value for a TDateTime column.

ParameterDescription
aKeyThe 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.

ParameterDescription
aKeyThe 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.

ParameterDescription
aKeyThe key value to lookup.

TDbSeekKey ( TInt, TInt )

TDbSeekKey(TIntaKeys,
TInt
)[protected, inline]

Member Function Documentation

Add ( TInt )

IMPORT_C TDbSeekKey &Add(TIntaKey)

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

ParameterDescription
aKeyThe key value to lookup.

Returns: A reference to this database key value object.

Add ( TUint )

IMPORT_C TDbSeekKey &Add(TUintaKey)

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

ParameterDescription
aKeyThe key value to lookup.

Returns: A reference to this database key value object.

Add ( TInt64 )

IMPORT_C TDbSeekKey &Add(TInt64aKey)

Appends a key value for an TInt64 column.

ParameterDescription
aKeyThe key value to lookup.

Returns: A reference to this database key value object.

Add ( TReal32 )

IMPORT_C TDbSeekKey &Add(TReal32aKey)

Appends a key value for a TReal32 column.

ParameterDescription
aKeyThe key value to lookup.

Returns: A reference to this database key value object.

Add ( TReal64 )

IMPORT_C TDbSeekKey &Add(TReal64aKey)

Appends a key value for a TReal64 column.

ParameterDescription
aKeyThe key value to lookup.

Returns: A reference to this database key value object.

Add ( TTime )

IMPORT_C TDbSeekKey &Add(TTimeaKey)

Appends a key value for a DateTime column.

ParameterDescription
aKeyThe 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.

Returns: A reference to this database key value object.

Add ( const TDesC8 & )

IMPORT_C TDbSeekKey &Add(const TDesC8 &aKey)

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.

ParameterDescription
aKeyThe key value to lookup.

Returns: A reference to this database key value object.

Add ( const TDesC16 & )

IMPORT_C TDbSeekKey &Add(const TDesC16 &aKey)

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.

ParameterDescription
aKeyThe key value to lookup.

Returns: A reference to this database key value object.