Class CStoreableOverrideSettings

CStoreableOverrideSettings

Support

Supported from 5.0

Description

Creates override settings for the columns of specific tables and streams this object to a buffer. The buffer is a convenient way of passing this information across thread or process boundaries.

The class also provides behaviour which allows the settings to be streamed in.

The CCommDbOverrideSettings base class provide the member functions for setting and fetching override values.

Derivation

CBase Base class for all classes to be instantiated on the heap CCommDbOverrideSettings Repository of override settings for columns in tables CStoreableOverrideSettings Creates override settings for the columns of specific tables and streams this object to a buffer

Defined in CStoreableOverrideSettings:
ExternalizeL(), GetStore(), InternalizeL(), NewL(), RestoreL(), StoreLC(), ~CStoreableOverrideSettings()

Inherited from CBase:
operator new()

Inherited from CCommDbOverrideSettings:
EParamListFull, EParamListPartial, GetBoolOverride(), GetConnectionPreferenceOverride(), GetDesOverride(), GetIntOverride(), GetLongDesOverride(), GetLongDesOverrideLength(), IsOverridden(), PartialFull(), SetBoolOverride(), SetConnectionPreferenceOverride(), SetDesOverride(), SetIntOverride(), SetLongDesOverride(), TParamList, Type()

static CStoreableOverrideSettings* NewL(TParamList aParamList, TCommDbDatabaseType aType);

Support

Supported from 6.0

Description

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

Parameters

TParamList aParamList An enumerator which indicates whether the override settings are partial or full. TCommDbDatabaseType aType Type of database

Return value

CStoreableOverrideSettings* A pointer to the override settings object.

static CStoreableOverrideSettings* NewL(TParamList aParamList);

Support

Withdrawn in 6.0

Description

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

Parameters

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

Return value

CStoreableOverrideSettings* A pointer to the override settings object.

~CStoreableOverrideSettings;

Description

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

Specifically, it deletes the memory store.

void InternalizeL(RReadStream& aStream);

Description

Internalises the override settings from a stream.

Parameters

RReadStream& aStream The stream to read from

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises override settings to a stream.

Parameters

RWriteStream& aStream The stream to write to

CBufFlat* StoreLC();

Description

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.

Return value

CBufFlat* A pointer to a flat buffer in which this object is stored.

void RestoreL(HBufC8* aBuf);

Description

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.

CBufStore* GetStore() const;

Description

Gets a pointer to the memory store object.

Return value

CBufStore* The pointer to the memory store object