RFavouritesFile Class Reference

#include <mw/favouritesfile.h>

class RFavouritesFile : public RFavouritesHandle

Inherits from

RFavouritesFile
- RFavouritesHandle

Public Member Functions
	RFavouritesFile()
IMPORT_C void	Close()
IMPORT_C TInt	Open(RFavouritesDb &, TInt)
IMPORT_C TInt	Read(TDes8 &)
IMPORT_C TInt	Replace(RFavouritesDb &, TInt)
IMPORT_C TInt	Size(TInt &)
IMPORT_C TInt	Write(const TDesC8 &)

Inherited Attributes
	RFavouritesHandle::iHandle
	RFavouritesHandle::iSess

Inherited Functions
	RFavouritesHandle::Handle()const
	RFavouritesHandle::Open(RFavouritesHandle &,TInt,const TIpcArgs &)
	RFavouritesHandle::Open(RFavouritesSession &,TInt,const TIpcArgs &)
	RFavouritesHandle::RFavouritesHandle()
	RFavouritesHandle::SendReceive(TInt)const
	RFavouritesHandle::SendReceive(TInt,const TIpcArgs &)const
	RFavouritesHandle::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const

Detailed Description

RFavouritesFile is a class derived from RFavouritesHandle. Each favourites item or folder can have an associated file with arbitrary content.

Constructor & Destructor Documentation

RFavouritesFile ( )

RFavouritesFile

(

)

[inline]

Constructor.

Since: 0.9

Implementation of RFavouritesFile::RFavouritesFile

Since: 0.9

Member Function Documentation

Close ( )

IMPORT_C void

(

)

Reimplemented from RFavouritesHandle::Close()

Close this object.

Since: 0.9

Return Value: void

Open ( RFavouritesDb &, TInt )

IMPORT_C TInt	Open	(	RFavouritesDb &	aDb,
			TInt	aUid
		)

Open existing file with shared read-access.

Since: 0.9

Parameters
aDb	Database handle.
aUid	Uid of item.

Return Value: Error code.

Read ( TDes8 & )

IMPORT_C TInt

Read

(

TDes8 &

aDes

)

const

Read from file.

Since: 0.9

Parameters
aDes	Descriptor into which binary data is read. Any existing contents are overwritten. On return, its length is set to the number of bytes read.

Return Value: Error code.

Replace ( RFavouritesDb &, TInt )

IMPORT_C TInt	Replace	(	RFavouritesDb &	aDb,
			TInt	aUid
		)

Create new file / replace existing with exclusive write-access. Existing content of the file, if any, is lost.

Since: 0.9

Parameters
aDb	Database handle.
aUid	Uid of item.

Return Value: Error code.

Size ( TInt & )

IMPORT_C TInt

Size

(

TInt &

aSize

)

const

Get the size of the file.

Since: 0.9

Parameters
aSize	Gives back the size of the file.

Return Value: Error code.

Write ( const TDesC8 & )

IMPORT_C TInt

Write

(

const TDesC8 &

aDes

)

Writes to file.

Since: 0.9

Parameters
aDes	Descriptor from which binary data is written.

Return Value: Error code.