Class CDictionaryFileStore

class CDictionaryFileStore : public CDictionaryStore;

Description

File based dictionary store.

A dictionary store is a store where a stream is accessed by UID, rather than directly by stream ID. A dictionary store contains streams in the usual way but, in addition, the root stream is a stream dictionary, i.e. a CStreamDictionary type.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CDictionaryStore - Dictionary store interface.

• CDictionaryFileStore - File based dictionary store.

Members

Defined in CDictionaryFileStore:

• OpenL(RFs &,const TDesC &,TUid)Creates a file based dictionary store object.
• OpenLC(RFs &,const TDesC &,TUid)Creates a file based dictionary store object and puts the pointer onto the clean...
• SystemL(RFs &)Opens the system dictionary file store.
• SystemLC(RFs &)Opens the system dictionary file store and puts the pointer to the file store ob...

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CDictionaryStore:

• Commit()Commits changes.
• CommitL()Commits changes and leaves if unsuccessful.
• ConstructL()
• IsNullL()constTests whether the dictionary stores stream dictionary is empty.
• IsPresentL(TUid)constTests whether the specified UID has an associated stream within this dictionary ...
• Remove(TUid)Removes the stream associated with the specified UID from the dictionary store.
• RemoveL(TUid)Removes the stream associated with the specified UID from the dictionary store a...
• Revert()Rolls the dictionary store back to its state at the last commit point.
• RevertL()Rolls the dictionary store back to its state at the last commit point and leaves...
• iStore

IMPORT_C static CDictionaryFileStore* SystemL(RFs &aFs);

Description

Opens the system dictionary file store.

Parameters

RFs &aFs Handle to a file server session.

Return value

CDictionaryFileStore * A pointer to the system file based dictionary store object.

IMPORT_C static CDictionaryFileStore* SystemLC(RFs &aFs);

Description

Opens the system dictionary file store and puts the pointer to the file store object onto the cleanup stack.

Parameters

RFs &aFs Handle to a file server session.

Return value

CDictionaryFileStore * A pointer to the system file based dictionary store object.

IMPORT_C static CDictionaryFileStore* OpenL(RFs &aFs, const TDesC &aName, TUid aUid3);

Description

Creates a file based dictionary store object.

If the file with the specified full path name exists, then an attempt is made to open an existing file store contained within this file. Any existing file store must satisfy the following conditions:

it must be a valid dictionary store

the third UID component of the file store type must match the specified UID; this UID serves to differentiate between dictionary stores

otherwise the function leaves with KErrCorrupt.

If the file with the specified full path name does not exist, then an attempt is made to create a new file and to create a file based dictionary within it. The third UID component of the file store type is set to the specified UID value.

Note that the file is opened in exclusive access mode.

Parameters

RFs &aFs Handle to a file server session. const TDesC16 &aName The full path name of the file. TUid aUid3 The UID used to differentiate between dictionary stores.

Return value

CDictionaryFileStore * A pointer to the file based dictionary store object.

See also:

• TUidA globally unique 32-bit number.
• TUidType...

IMPORT_C static CDictionaryFileStore* OpenLC(RFs &aFs, const TDesC &aName, TUid aUid3);

Description

Creates a file based dictionary store object and puts the pointer onto the cleanup stack.

If the file with the specified full path name exists, then an attempt is made to open an existing file store contained within this file. Any existing file store must satisfy the following conditions:

it must be a valid dictionary store

the third UID component of the file store type must match the specified UID; this UID serves to differentiate between dictionary stores

otherwise the function leaves with KErrCorrupt.

If the file with the specified full path name does not exist, then an attempt is made to create a new file and to create a file based dictionary within it. The third UID component of the file store type is set to the specified UID value.

Note that the file is opened in exclusive access mode.

Parameters

RFs &aFs Handle to a file server session. const TDesC16 &aName The full path name of the file. TUid aUid3 The UID used to differentiate between dictionary stores.

Return value

CDictionaryFileStore * A pointer to the file based dictionary store object.

See also:

• TUidA globally unique 32-bit number.
• TUidType...