Collapse all Symbian^3 Product Developer Library

CDictionaryFileStore Class Reference

class CDictionaryFileStore : public CDictionaryStore

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.

Inherits from

CDictionaryFileStore
- CDictionaryStore
  - CBase

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

Private Member Functions
void	ConstructL(RFs &, const TDesC &, TUid)
void	CreateStoreL(RFile &, const TUidType &)

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()

Inherited Attributes
	CDictionaryStore::iStore

Member Functions Documentation

ConstructL(RFs &, const TDesC &, TUid)

void	ConstructL	(	RFs &	aFs,
			const TDesC &	aName,
			TUid	aUid3
		)	[private]

Parameters

RFs & aFs
const TDesC & aName
TUid aUid3

CreateStoreL(RFile &, const TUidType &)

void	CreateStoreL	(	RFile &	aFile,
			const TUidType &	aType
		)	[private]

Parameters

RFile & aFile
const TUidType & aType

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.

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.

TUid TUidType

Parameters

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