RFavouritesHandle Class Reference
API published in: S60 1st Ed
Link against: favouritesengine.lib
Capability Information
Required Capabilities
ReadUserData WriteUserData
#include <favouriteshandle.h>
Inherited by RFavouritesDb, RFavouritesDbIncremental, RFavouritesDbNotifier, and RFavouritesFile.
Detailed Description
RFavouritesHandle is the favourite object handle.
|
Public Member Functions
|
| |
RFavouritesHandle ()
|
| |
Constructor.
|
| IMPORT_C void |
Close ()
|
| |
Close the object.
|
| TInt |
Handle () const
|
| |
Get handle number.
|
Protected Member Functions
|
| TInt |
Open (RFavouritesSession &aSess, TInt aFunction, const TIpcArgs &aArgs)
|
| |
Open the object.
|
| TInt |
Open (RFavouritesHandle &aHandle, TInt aFunction, const TIpcArgs &aArgs)
|
| |
Open this object using other object.
|
| void |
SendReceive (TInt aFunction, const TIpcArgs &aArgs, TRequestStatus &aStatus) const
|
| |
Message passing routine.
|
| TInt |
SendReceive (TInt aFunction, const TIpcArgs &aArgs) const
|
| |
Message passing routine.
|
| TInt |
SendReceive (TInt aFunction) const
|
| |
Message passing routine.
|
Protected Attributes
|
| RFavouritesSession
|
iSess |
| |
Session handle.
|
| TInt |
iHandle |
| |
Handle number.
|
Constructor & Destructor Documentation
| RFavouritesHandle::RFavouritesHandle |
( |
|
) |
[inline] |
|
Member Function Documentation
| IMPORT_C void RFavouritesHandle::Close |
( |
|
) |
|
|
| TInt RFavouritesHandle::Handle |
( |
|
) |
const [inline] |
|
|
|
Get handle number.
- Returns:
- Handle number.
|
| TInt RFavouritesHandle::Open |
( |
RFavouritesHandle &
|
aHandle,
|
|
|
TInt |
aFunction,
|
|
|
const TIpcArgs & |
aArgs |
|
) |
[protected] |
|
|
|
Open this object using other object.
- Parameters:
-
|
aHandle
|
Handle used to open this object. |
|
aFunction
|
Function. |
|
aArgs
|
Arguments. |
- Returns:
- Error code.
|
| TInt RFavouritesHandle::Open |
( |
RFavouritesSession &
|
aSess,
|
|
|
TInt |
aFunction,
|
|
|
const TIpcArgs & |
aArgs |
|
) |
[protected] |
|
|
|
Open the object.
- Parameters:
-
|
aSess
|
Session to be used. |
|
aFunction
|
Function. |
|
aArgs
|
Arguments. |
- Returns:
- Error code.
|
| TInt RFavouritesHandle::SendReceive |
( |
TInt |
aFunction
|
) |
const [protected] |
|
|
|
Message passing routine.
- Parameters:
-
- Returns:
- Error code.
|
| TInt RFavouritesHandle::SendReceive |
( |
TInt |
aFunction,
|
|
|
const TIpcArgs & |
aArgs |
|
) |
const [protected] |
|
|
|
Message passing routine.
- Parameters:
-
|
aFunction
|
Function. |
|
aArgs
|
Arguments. |
- Returns:
- Error code.
|
| void RFavouritesHandle::SendReceive |
( |
TInt |
aFunction,
|
|
|
const TIpcArgs & |
aArgs,
|
|
|
TRequestStatus & |
aStatus |
|
) |
const [protected] |
|
|
|
Message passing routine.
- Parameters:
-
|
aFunction
|
Function. |
|
aArgs
|
Arguments. |
|
aStatus
|
Request status. |
|
Field Documentation
The documentation for this class was generated from the following file:
