EPOC   SDK Home Glossary Indexes Previous   Up

CStoreableOverrideSettings class


Contents


CStoreableOverrideSettings class — Storable override settings

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

CBase

Abstract: CBase behavior

CCommDbOverrideSettings

Override settings

CStoreableOverrideSettings

Storable override settings

Defined in

cdbstore.h

Link against

commdb.lib

Description

Use an object of this type to make override settings for the columns of specific tables and stream this object to a buffer. The buffer is a convenient way of passing this information across thread or process boundaries.

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

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


Allocation and construction


NewL() — Create a storable override settings object

static CStoreableOverrideSettings * NewL(TParamList aParamList);

Description

Use this static function to allocate and construct a storeable 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

Arguments

TParamList aParamList

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

Return Value

CStoreableOverrideSettings*

A pointer to the override settings object.


Destruction


~CStoreableOverrideSettings() — Destructor

~CStoreableOverrideSettings;

Description

The destructor frees all resources owned by this object, prior to its destruction.

Specifically, it deletes the memory store.


Streaming


InternalizeL() — Internalize the override settings

void InternalizeL(RReadStream& aStream);

Description

Use this function to internalize the override settings from a stream.

Arguments

RReadStream& aStream

The stream to read from


ExternalizeL() — Externalize the override settings

void ExternalizeL(RWriteStream& aStream) const;

Description

Use this function to externalize override settings to a stream.

Arguments

RWriteStream& aStream

The stream to write to


Storing and restoring


StoreLC() — Store override settings in a flat buffer

CBufFlat* StoreLC();

Description

Use this function to construct a flat buffer and to store the override settings in it.

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

Return value

CBufFlat*

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


RestoreL() — Restore override settings from a buffer

void RestoreL(HBufC8* aBuf);

Description

Use this function to retore the override settings from the buffer memory store hosted by the 8 bit descriptor aBuf.

Arguments

HBufC8* aBuf

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


Information


GetStore() — Fetch pointer to the memory store

CBufStore* GetStore() const;

Description

Uses this function to fetch a pointer to the memory store object.

Return value

CBufStore*

The pointer to the memory store object

EPOC       SDK Home Glossary Indexes Previous   Up