Collapse all Symbian^3 Application Developer Library

CDcfRep Class Reference

class CDcfRep : public CBase

CDcfRep Client of DCF Repository

?library

Since: Series 60 3.0

Inherits from

CDcfRep
- CBase

Public Member Functions
	~CDcfRep ()
IMPORT_C void	GetFileHandleL (const TDesC8 &, RFile &, RFs &)
IMPORT_C void	GetTtidL ( RArray < TPair > &)
IMPORT_C CDcfRep *	NewL ()
IMPORT_C CDcfEntry *	NextL ()
IMPORT_C void	NotifyServerIdle ( TRequestStatus &)
IMPORT_C void	OrderListL (void)
IMPORT_C void	OrderListL (const TDesC8 &)
IMPORT_C void	RefreshDcf ( TRequestStatus &)
IMPORT_C void	RefreshDcf ( RPointerArray < HBufC8 > &, TRequestStatus &)
IMPORT_C void	RemoveDcfFromDbL (const TDesC &)
IMPORT_C void	SetTtid ( RArray < TPair > &, TRequestStatus &, TBool )
IMPORT_C void	UpdateL (const CDcfEntry *)

Private Member Functions
	CDcfRep ()
	CDcfRep (const CDcfRep &)
void	ConstructL ()
void	DoGetFileHandleL (const TDesC8 &, RFile &, RFs &)
void	GetCidL (const TDesC16 &, RPointerArray < HBufC8 > &)
void	GetFilenameL (const TDesC8 &, RPointerArray < HBufC > &)
void	GetTtidL (const TDesC8 &, HBufC8 *&)
void	OpenDatabaseL ()
TInt	SetName (const TDesC8 &, const TDesC16 &)
CDcfRep &	operator= (const CDcfRep &)

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

Public Attributes
RDcfRepCli	iClient
RDbNamedDatabase	iDb
RDbs	iDbs
RDbView	iView

Constructor & Destructor Documentation

CDcfRep()

CDcfRep

(

)

[private]

From ?base_class ?member_description C++ default constructor.

CDcfRep(const CDcfRep &)

CDcfRep

(

const CDcfRep &

)

[private]

Parameters

const CDcfRep &

~CDcfRep()

IMPORT_C

~CDcfRep

(

)

[virtual]

Destructor.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

DoGetFileHandleL(const TDesC8 &, RFile &, RFs &)

void	DoGetFileHandleL	(	const TDesC8 &	aCid,
			RFile &	aFile,
			RFs &	aFs
		)	[private]

Parameters

const TDesC8 & aCid
RFile & aFile
RFs & aFs

GetCidL(const TDesC16 &, RPointerArray< HBufC8 > &)

void	GetCidL	(	const TDesC16 &	aName,
			RPointerArray < HBufC8 > &	aList
		)	[private]

Parameters

const TDesC16 & aName
RPointerArray < HBufC8 > & aList

GetFileHandleL(const TDesC8 &, RFile &, RFs &)

IMPORT_C void	GetFileHandleL	(	const TDesC8 &	aCid,
			RFile &	aFile,
			RFs &	aFs
		)

GetFileHandleL The function get file info from database and return read-only file handle back

Since: Series 60 3.0

Parameters

const TDesC8 & aCid	a content ID
RFile & aFile	a file handle
RFs & aFs	file server session that is connected with server.

GetFilenameL(const TDesC8 &, RPointerArray< HBufC > &)

void	GetFilenameL	(	const TDesC8 &	aCid,
			RPointerArray < HBufC > &	aList
		)	[private]

Parameters

const TDesC8 & aCid
RPointerArray < HBufC > & aList

GetTtidL(RArray< TPair > &)

IMPORT_C void

GetTtidL

(

RArray < TPair > &

aList

)

GetTtidL The function will go through database to get transaction IDs for every specific CID

Since: Series 60 3.0

Parameters

RArray < TPair > & aList

contain content IDs and transaction ID will be filled afterwards TPair.iCid must be filled by user. TPair.iTtid must be NULL

GetTtidL(const TDesC8 &, HBufC8 *&)

void	GetTtidL	(	const TDesC8 &	aCid,
			HBufC8 *&	aTtid
		)	[private]

Parameters

const TDesC8 & aCid
HBufC8 *& aTtid

NewL()

IMPORT_C CDcfRep *

NewL

(

)

[static]

Two-phased constructor.

NextL()

IMPORT_C CDcfEntry *

NextL

(

)

NextL After a list is ordered, the function will return entries as iteration. Caller must call OrderListL before calling this function.

Since: Series 60 3.0

NotifyServerIdle(TRequestStatus &)

IMPORT_C void

NotifyServerIdle

(

TRequestStatus &

aStatus

)

NotifyServerIdle the function will complete the status when DCF Repository server becomes idle if the server is in ilde status right now, then the status will get completed right now. Note. if CDcfRep is destructed, the status will not be completed afterwards even server becomes idle.

Since: Series 60 3.0

Parameters

TRequestStatus & aStatus

a status for this request

OpenDatabaseL()

void

OpenDatabaseL

(

)

[private]

Open database

OrderListL(void)

IMPORT_C void

OrderListL

(

void

)

OrderListL Order all entries from DB, NextL will be used after this function call in order to get entries.

Since: Series 60 3.0 with KErrNotFound if there is no entries

Parameters

void

OrderListL(const TDesC8 &)

IMPORT_C void

OrderListL

(

const TDesC8 &

aCid

)

OrderListL Order all entries with specific CID from DB, if the CID cannot be found as a CID then DB will search for it as a Group ID NextL will be used after this function call in order to get entries.

Since: Series 60 3.0

Parameters

const TDesC8 & aCid

a content ID with KErrNotFound if there is no entries for the CID

RefreshDcf(TRequestStatus &)

IMPORT_C void

RefreshDcf

(

TRequestStatus &

aStatus

)

RefreshDcf the function will refresh the DCF list for both OMA 1 and OMA 2(.odf) DCFs and save it into DB. Note. if CDcfRep is destructed, the status will not be completed afterwards even server becomes idle.

Since: Series 60 3.0

Parameters

TRequestStatus & aStatus

a status for this request

RefreshDcf(RPointerArray< HBufC8 > &, TRequestStatus &)

IMPORT_C void	RefreshDcf	(	RPointerArray < HBufC8 > &	aList,
			TRequestStatus &	aStatus
		)

RefreshDcf the function will refresh the DCF list for both OMA 1 and OMA 2(.odf) DCFs and save it into DB. the function will complete when every single Cid has found at least one corresponding DCFs in the file system Note. if CDcfRep is destructed, the status will not be completed afterwards even server becomes idle.

Since: Series 60 3.0

Parameters

RPointerArray < HBufC8 > & aList	contain content IDs which info need to be refreshed
TRequestStatus & aStatus	a status for this request

RemoveDcfFromDbL(const TDesC &)

IMPORT_C void

RemoveDcfFromDbL

(

const TDesC &

aFileName

)

RemoveDcfFromDbL

the function will remove all the entries that have the filename in database.

Since: Series 60 3.0

Parameters

const TDesC & aFileName

file name of Dcf to be removed

SetName(const TDesC8 &, const TDesC16 &)

TInt	SetName	(	const TDesC8 &	aCid,
			const TDesC16 &	aName
		)	[private]

Parameters

const TDesC8 & aCid
const TDesC16 & aName

SetTtid(RArray< TPair > &, TRequestStatus &, TBool)

IMPORT_C void	SetTtid	(	RArray < TPair > &	aList,
			TRequestStatus &	aStatus,
			TBool	aRefresh = ETrue
		)

SetTtid the function will scan whole file system, whenever a .odf with a specifed CID is found, server will reset the TTID for the .odf with the value in TPair.iTtid and also update info in database. Note. if CDcfRep is destructed, the status will not be completed afterwards even server becomes idle.

Since: Series 60 3.0

Parameters

RArray < TPair > & aList	a list of CID and TTID pairs, Caller owns TPair.iCid and TPair.iTtid. CID and TTID must be filled by caller, no default value is given.
TRequestStatus & aStatus	a status for this request
TBool aRefresh = ETrue	ETrue by default, EFalse is not supported in this version

UpdateL(const CDcfEntry *)

IMPORT_C void

UpdateL

(

const CDcfEntry *

aEntry

)

UpdateL the function will add the entry into database. in 3.0 file info will be added

Since: Series 60 3.0

Parameters

const CDcfEntry * aEntry

protected file entry to database, either filename or content ID field shall be filled, if filename is filled, the file is added into DCF DB and also rights DB, domain RO is added into the file if content ID is filled, domain RO are added into all files(registered in DCF DB) that are linked with this content ID if both are filled, then content ID is ignored. if none is filled, then KErrArgument is returned server will obtain other info from the file or DCF DB. with KErrNotSupported if file is not protected file