RFavouritesFile Class Reference
API published in: S60 1st Ed
Link against: favouritesengine.lib
Capability Information
Required Capabilities
ReadUserData WriteUserData
#include <favouritesfile.h>
Inherits RFavouritesHandle.
Detailed Description
RFavouritesFile is a class derived from RFavouritesHandle.
Each favourites item or folder can have an associated file with arbitrary content.
|
Public Member Functions
|
| |
RFavouritesFile ()
|
| |
Constructor.
|
| IMPORT_C void |
Close ()
|
| |
Close this object.
|
| IMPORT_C TInt |
Open (RFavouritesDb &aDb, TInt aUid)
|
| |
Open existing file with shared read-access.
|
| IMPORT_C TInt |
Replace (RFavouritesDb &aDb, TInt aUid)
|
| |
Create new file / replace existing with exclusive write-access.
|
| IMPORT_C TInt |
Read (TDes8 &aDes) const
|
| |
Read from file.
|
| IMPORT_C TInt |
Write (const TDesC8 &aDes)
|
| |
Writes to file.
|
| IMPORT_C TInt |
Size (TInt &aSize) const
|
| |
Get the size of the file.
|
Constructor & Destructor Documentation
| RFavouritesFile::RFavouritesFile |
( |
|
) |
[inline] |
|
Member Function Documentation
| IMPORT_C void RFavouritesFile::Close |
( |
|
) |
|
|
| IMPORT_C TInt RFavouritesFile::Open |
( |
RFavouritesDb &
|
aDb,
|
|
|
TInt |
aUid |
|
) |
|
|
|
|
Open existing file with shared read-access.
- Parameters:
-
|
aDb
|
Database handle. |
|
aUid
|
Uid of item. |
- Returns:
- Error code.
|
| IMPORT_C TInt RFavouritesFile::Read |
( |
TDes8 & |
aDes
|
) |
const |
|
|
|
Read from file.
- 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.
|
- Returns:
- Error code.
|
| IMPORT_C TInt RFavouritesFile::Replace |
( |
RFavouritesDb &
|
aDb,
|
|
|
TInt |
aUid |
|
) |
|
|
|
|
Create new file / replace existing with exclusive write-access.
Existing content of the file, if any, is lost.
- Parameters:
-
|
aDb
|
Database handle. |
|
aUid
|
Uid of item. |
- Returns:
- Error code.
|
| IMPORT_C TInt RFavouritesFile::Size |
( |
TInt & |
aSize
|
) |
const |
|
|
|
Get the size of the file.
- Parameters:
-
|
aSize
|
Gives back the size of the file. |
- Returns:
- Error code.
|
| IMPORT_C TInt RFavouritesFile::Write |
( |
const TDesC8 & |
aDes
|
) |
|
|
|
|
Writes to file.
- Parameters:
-
|
aDes
|
Descriptor from which binary data is written. |
- Returns:
- Error code.
|
The documentation for this class was generated from the following file:
