RFavouritesDbIncremental Class Reference

API published in: S60 1st Ed

Link against: favouritesengine.lib

Capability Information

Required Capabilities

ReadUserData WriteUserData


#include <favouritesdbincremental.h>

Inherits RFavouritesHandle.


Detailed Description

Incremental object for Favourites Engine.

This class provides incremental database administration (recovery, compaction). Usually client does not need to use this class.


Public Member Functions

IMPORT_C TInt  Recover (RFavouritesDb &aDb, TInt &aStep)
  Start incremental recovery on the given database.
IMPORT_C TInt  Compact (RFavouritesDb &aDb, TInt &aStep)
  Start incremental compaction on the given database.
IMPORT_C TInt  Next (TInt &aStep)
  Perform next step of incremental operation.

Member Function Documentation

IMPORT_C TInt RFavouritesDbIncremental::Compact RFavouritesDb aDb,
TInt &  aStep
 

Start incremental compaction on the given database.

Parameters:
aDb  The database to be compacted.
aStep  Placeholder for the step counter to be returned.
Returns:
Error code.
IMPORT_C TInt RFavouritesDbIncremental::Next TInt &  aStep  ) 
 

Perform next step of incremental operation.

Parameters:
aStep  Step counter.
Returns:
Error code.
IMPORT_C TInt RFavouritesDbIncremental::Recover RFavouritesDb aDb,
TInt &  aStep
 

Start incremental recovery on the given database.

Parameters:
aDb  The database to be recovered.
aStep  Placeholder for the step counter to be returned.
Returns:
Error code.

The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2008
Back to top