RFavouritesHandle Class Reference

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]
 

Constructor.

Since:
0.9

Member Function Documentation

IMPORT_C void RFavouritesHandle::Close (   ) 
 

Close the object.

Since:
0.9 return void

Reimplemented in RFavouritesFile.

TInt RFavouritesHandle::Handle (   )  const [inline]
 

Get handle number.

Since:
0.9
Returns:
Handle number.
TInt RFavouritesHandle::Open (  RFavouritesHandle &  aHandle,
TInt  aFunction,
const TIpcArgs &  aArgs
)  [protected]
 

Open this object using other object.

Since:
0.9
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.

Since:
0.9
Parameters:
aSess  Session to be used.
aFunction  Function.
aArgs  Arguments.
Returns:
Error code.
TInt RFavouritesHandle::SendReceive (  TInt  aFunction  )  const [protected]
 

Message passing routine.

Since:
0.9
Parameters:
aFunction  Function.
Returns:
Error code.
TInt RFavouritesHandle::SendReceive (  TInt  aFunction,
const TIpcArgs &  aArgs
)  const [protected]
 

Message passing routine.

Since:
0.9
Parameters:
aFunction  Function.
aArgs  Arguments.
Returns:
Error code.
void RFavouritesHandle::SendReceive (  TInt  aFunction,
const TIpcArgs &  aArgs,
TRequestStatus &  aStatus
)  const [protected]
 

Message passing routine.

Since:
0.9
Parameters:
aFunction  Function.
aArgs  Arguments.
aStatus  Request status.

Field Documentation

TInt RFavouritesHandle::iHandle [protected]
 

Handle number.

RFavouritesSession RFavouritesHandle::iSess [protected]
 

Session handle.

The documentation for this class was generated from the following files:
Copyright © Nokia Corporation 2001-2007
Back to top