CDictionaryFileStore Class Reference

#include <s32file.h>

class CDictionaryFileStore : public CDictionaryStore

Inherits from

CDictionaryFileStore
- CDictionaryStore

Public Member Functions
IMPORT_C CDictionaryFileStore *	OpenL(RFs &, const TDesC &, TUid)
IMPORT_C CDictionaryFileStore *	OpenLC(RFs &, const TDesC &, TUid)
IMPORT_C CDictionaryFileStore *	SystemL(RFs &)
IMPORT_C CDictionaryFileStore *	SystemLC(RFs &)

Inherited Attributes
	CDictionaryStore::iStore

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()
	CDictionaryStore::Commit()
	CDictionaryStore::CommitL()
	CDictionaryStore::ConstructL()
	CDictionaryStore::IsNullL()const
	CDictionaryStore::IsPresentL(TUid)const
	CDictionaryStore::Remove(TUid)
	CDictionaryStore::RemoveL(TUid)
	CDictionaryStore::Revert()
	CDictionaryStore::RevertL()
	CDictionaryStore::~CDictionaryStore()

Detailed 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.

Member Function Documentation

OpenL ( RFs &, const TDesC &, TUid )

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

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.

OpenLC ( RFs &, const TDesC &, TUid )

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

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.

Note that the file is opened in exclusive access mode.

SystemL ( RFs & )

IMPORT_C CDictionaryFileStore *

SystemL

(

RFs &

aFs

)

[static]

Opens the system dictionary file store.

Parameter	Description
aFs	Handle to a file server session.

Returns: A pointer to the system file based dictionary store object.

SystemLC ( RFs & )

IMPORT_C CDictionaryFileStore *

SystemLC

(

RFs &

aFs

)

[static]

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

Parameter	Description
aFs	Handle to a file server session.

Returns: A pointer to the system file based dictionary store object.

Parameter	Description
aFs	Handle to a file server session.
aName	The full path name of the file.
aUid3	The UID used to differentiate between dictionary stores.