Symbian^3 Product Developer Library >

RFavouritesFile Class Reference

class RFavouritesFile : public RFavouritesHandle

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

Inherits from

Public Member Functions
RFavouritesFile()
IMPORT_C voidClose()
IMPORT_C TIntOpen(RFavouritesDb &, TInt)
IMPORT_C TIntRead(TDes8 &)
IMPORT_C TIntReplace(RFavouritesDb &, TInt)
IMPORT_C TIntSize(TInt &)
IMPORT_C TIntWrite(const TDesC8 &)
Private Member Functions
TInt DoOpen(RFavouritesDb &, TInt, TInt)
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
Private Attributes
CFavouritesFileImpl *iImpl
Inherited Attributes
RFavouritesHandle::iHandle
RFavouritesHandle::iSess

Constructor & Destructor Documentation

RFavouritesFile()

RFavouritesFile()[inline]
Constructor.
Since
0.9
Implementation of RFavouritesFile::RFavouritesFile
Since
0.9

Member Functions Documentation

Close()

IMPORT_C voidClose()
Close this object.
Since
0.9

DoOpen(RFavouritesDb &, TInt, TInt)

TInt DoOpen(RFavouritesDb &aDb,
TIntaUid,
TIntaFunction
)[private]
Implementation of Open functions.
Since
0.9

Parameters

RFavouritesDb & aDbDatabase handle.
TInt aUidUid of item.
TInt aFunctionFunction.

Open(RFavouritesDb &, TInt)

IMPORT_C TIntOpen(RFavouritesDb &aDb,
TIntaUid
)
Open existing file with shared read-access.
Since
0.9

Parameters

RFavouritesDb & aDbDatabase handle.
TInt aUidUid of item.

Read(TDes8 &)

IMPORT_C TIntRead(TDes8 &aDes)const
Read from file.
Since
0.9

Parameters

TDes8 & aDesDescriptor into which binary data is read. Any existing contents are overwritten. On return, its length is set to the number of bytes read.

Replace(RFavouritesDb &, TInt)

IMPORT_C TIntReplace(RFavouritesDb &aDb,
TIntaUid
)
Create new file / replace existing with exclusive write-access. Existing content of the file, if any, is lost.
Since
0.9

Parameters

RFavouritesDb & aDbDatabase handle.
TInt aUidUid of item.

Size(TInt &)

IMPORT_C TIntSize(TInt &aSize)const
Get the size of the file.
Since
0.9

Parameters

TInt & aSizeGives back the size of the file.

Write(const TDesC8 &)

IMPORT_C TIntWrite(const TDesC8 &aDes)
Writes to file.
Since
0.9

Parameters

const TDesC8 & aDesDescriptor from which binary data is written.

Member Data Documentation

CFavouritesFileImpl * iImpl

CFavouritesFileImpl *iImpl[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.