CStoreableOverrideSettings Class Reference

class CStoreableOverrideSettings : public CCommDbOverrideSettings

Creates override settings for the columns of specific tables, and stores and retrieves the override sets to and from both streams and buffers.

The buffer is a convenient way of passing this information across thread or process boundaries.

The CCommDbOverrideSettings base class provides the member functions for setting and fetching override values. Overrides are deprecated from v9.1

Inherits from

Public Member Functions
~CStoreableOverrideSettings ()
IMPORT_C void ExternalizeL ( RWriteStream &)
CBufStore * GetStore ()
IMPORT_C void InternalizeL ( RReadStream &)
IMPORT_C CStoreableOverrideSettings * NewL ( TParamList )
IMPORT_C CStoreableOverrideSettings * NewL ( TParamList , TCommDbDatabaseType )
IMPORT_C void RestoreL ( HBufC8 *)
IMPORT_C CBufFlat * StoreLC ()
Protected Member Functions
CStoreableOverrideSettings ( TParamList )
void ConstructL ()
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()
CCommDbOverrideSettings::CCommDbOverrideSettings(TParamList)
CCommDbOverrideSettings::CheckL(const TDesC &,const TDesC &,TValueType)const
CCommDbOverrideSettings::Compare(CCommDbOverrideSettings *)const
CCommDbOverrideSettings::FindOverride(const TDesC &,const TDesC &,TValueType)const
CCommDbOverrideSettings::GetBoolOverride(const TDesC &,const TDesC &,TBool &)
CCommDbOverrideSettings::GetConnectionPreferenceOverride(CCommsDbConnectionPrefTableView::TCommDbIapConnectionPref &)
CCommDbOverrideSettings::GetConnectionPreferenceOverride(CCommsDbConnectionPrefTableView::TCommDbIspConnectionPref &)
CCommDbOverrideSettings::GetDesOverride(const TDesC &,const TDesC &,TDes16 &)
CCommDbOverrideSettings::GetDesOverride(const TDesC &,const TDesC &,TDes8 &)
CCommDbOverrideSettings::GetIntOverride(const TDesC &,const TDesC &,TUint32 &)
CCommDbOverrideSettings::GetLongDesOverride(const TDesC &,const TDesC &,TDes &)
CCommDbOverrideSettings::GetLongDesOverrideLength(const TDesC &,const TDesC &,TInt &)
CCommDbOverrideSettings::IllegalOverride(const TDesC &,const TDesC &)const
CCommDbOverrideSettings::IsOverridden(const TDesC &,const TDesC &,TValueType)
CCommDbOverrideSettings::MatchIapOverride(const TCommDbIapConnectionPrefOverride &,const TCommDbIapConnectionPrefOverride &)
CCommDbOverrideSettings::PartialFull()const
CCommDbOverrideSettings::SetBoolOverride(const TDesC &,const TDesC &,TBool)
CCommDbOverrideSettings::SetConnectionPreferenceOverride(const CCommsDbConnectionPrefTableView::TCommDbIapConnectionPref &)
CCommDbOverrideSettings::SetConnectionPreferenceOverride(const CCommsDbConnectionPrefTableView::TCommDbIspConnectionPref &)
CCommDbOverrideSettings::SetDesOverride(const TDesC &,const TDesC &,const TDesC16 &)
CCommDbOverrideSettings::SetDesOverride(const TDesC &,const TDesC &,const TDesC8 &)
CCommDbOverrideSettings::SetIntOverride(const TDesC &,const TDesC &,TUint32)
CCommDbOverrideSettings::SetLongDesOverride(const TDesC &,const TDesC &,const TDesC &)
CCommDbOverrideSettings::~CCommDbOverrideSettings()
Inherited Enumerations
CCommDbOverrideSettings:TParamList
CCommDbOverrideSettings:TValueType
Private Attributes
CBufStore * iStore
Inherited Attributes
CCommDbOverrideSettings::iDb
CCommDbOverrideSettings::iIapOverrides
CCommDbOverrideSettings::iOverrides
CCommDbOverrideSettings::iPartialFull

Constructor & Destructor Documentation

CStoreableOverrideSettings(TParamList)

CStoreableOverrideSettings ( TParamList aParamList ) [protected]

Constructor

Parameters

TParamList aParamList

~CStoreableOverrideSettings()

IMPORT_C ~CStoreableOverrideSettings ( )

Frees all resources owned by this object, prior to its destruction.

Specifically, it deletes the memory store.

Member Functions Documentation

ConstructL()

void ConstructL ( ) [protected, virtual]

ExternalizeL(RWriteStream &)

IMPORT_C void ExternalizeL ( RWriteStream & aStream ) const

Externalises override settings to a stream.

Parameters

RWriteStream & aStream The stream to write to.

GetStore()

CBufStore * GetStore ( ) const [inline]

Accesses the buffer store. 7.0 There is no need for this store - none of the above functions use this store. If a client needs a store it should create its own.

InternalizeL(RReadStream &)

IMPORT_C void InternalizeL ( RReadStream & aStream )

Internalises the override settings from a stream.

Parameters

RReadStream & aStream The stream to read from.

NewL(TParamList)

IMPORT_C CStoreableOverrideSettings * NewL ( TParamList aParamList ) [static]

Allocates and constructs a storable override settings object.

The construction process automatically opens the communications database and connects to the DBMS. The database is closed and the connection to the DBMS severed when this override object is destroyed

This member function was withdrawn in release 6.0, but re-introduced in 7.0

Parameters

TParamList aParamList An enumerator which indicates whether the override settings are partial or full.

NewL(TParamList, TCommDbDatabaseType)

IMPORT_C CStoreableOverrideSettings * NewL ( TParamList aParamList,
TCommDbDatabaseType aDbType
) [static]

Allocates and constructs a storable override settings object.

The construction process automatically opens the communications database and connects to the DBMS. The database is closed and the connection to the DBMS severed when this override object is destroyed

Re-instated override variant of NewL function in order to maintain BC with 6.1. Disgards a TCommDbDatabaseType value and calls NewL(TParamList aParamList) .

Parameters

TParamList aParamList
TCommDbDatabaseType aDbType Whether Database is IAP or ISP version. All Db's are IAP type now.

RestoreL(HBufC8 *)

IMPORT_C void RestoreL ( HBufC8 * aBuf )

Restores the override settings from the buffer memory store hosted by the specified 8-bit descriptor.

Parameters

HBufC8 * aBuf A pointer to an 8 bit memory descriptor containing the data to be restored.

StoreLC()

IMPORT_C CBufFlat * StoreLC ( )

Constructs a flat buffer and stores the override settings in it.

The function returns a pointer to the buffer; the pointer to this object is placed on the cleanup stack.

Member Data Documentation

CBufStore * iStore

CBufStore * iStore [private]

in v7.0. There is no need for this store