Class CStoreableOverrideSettings

class CStoreableOverrideSettings : public CCommDbOverrideSettings;

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

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

Inherited from CBase:
operator new()

Inherited from CCommDbOverrideSettings:
CheckL(), Compare(), EBoolValue, EDes16Value, EDes8Value, EIntValue, ELongDesValue, EParamListFull, EParamListPartial, EUnknownType, FindOverride(), GetBoolOverride(), GetConnectionPreferenceOverride(), GetDesOverride(), GetIntOverride(), GetLongDesOverride(), GetLongDesOverrideLength(), IllegalOverride(), IsOverridden(), MatchIapOverride(), PartialFull(), SetBoolOverride(), SetConnectionPreferenceOverride(), SetDesOverride(), SetIntOverride(), SetLongDesOverride(), TParamList, TValueType, Type(), iDb, iIapOverrides, iOverrides, iPartialFull

static CStoreableOverrideSettings* NewL(TParamList aParamList);

Support

Supported from 7.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

Return value

Notes:

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

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

Support

Supported from 6.0
Withdrawn in 7.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

Return value

~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

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises override settings to a stream.

Parameters

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

void RestoreL(HBufC8* aBuf);

Description

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

Parameters

CBufStore* GetStore() const;

Description

This member function has been depricated in release 7.0. Gets a pointer to the memory store object.

Return value

protected: virtual void ConstructL();

Description

This member is internal and not intended for use.

protected: CStoreableOverrideSettings(TParamList aParamList);

Description

This member is internal and not intended for use.

private: CBufStore* iStore;

Description

This member is internal and not intended for use.