RFavouritesSession Class Reference

API published in: S60 1st Ed

Link against: favouritesengine.lib

Capability Information

Required Capabilities

ReadUserData WriteUserData

#include <favouritessession.h>

Detailed Description

RFavouritesSession is the Favourites Engine Session.

It represents the connection to the Favourites Engine Server.


Public Member Functions
IMPORT_C TInt	Connect ()
	Connect to Favourites Server.
IMPORT_C void	ResourceMark ()
	Start checking the number of allocated object through this session.
IMPORT_C void	ResourceCheck ()
	Check that the number of allocated object through this session matches the same of when the last call to ResourceMark was made.
IMPORT_C TInt	ResourceCount ()
	Get number of allocated object through this session.
IMPORT_C TInt	DeleteDatabase (const TDesC &aName)
	Delete database.
IMPORT_C void	__DbgSetAllocFail (RAllocator::TAllocFail aType, TInt aRate)
	Simulate a heap allocation failure for server heap.
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.
Static Public Member Functions
static IMPORT_C TVersion	Version ()
	Get version.

Member Function Documentation

IMPORT_C void RFavouritesSession::__DbgSetAllocFail	(	RAllocator::TAllocFail	aType,
		TInt	aRate
	)

Simulate a heap allocation failure for server heap.

Has empty implementation for the UDEB server.

Parameters:

	aType	Type of heap failure simulation.
	aRate	Rate of failure.

Returns:: void

IMPORT_C TInt RFavouritesSession::Connect

Connect to Favourites Server.

Returns:: Error code.

IMPORT_C TInt RFavouritesSession::DeleteDatabase

Delete database.

Parameters:

Returns:: ErrorCode

IMPORT_C void RFavouritesSession::ResourceCheck

Check that the number of allocated object through this session matches the same of when the last call to ResourceMark was made.

Returns:: void

IMPORT_C TInt RFavouritesSession::ResourceCount

Get number of allocated object through this session.

Returns:: void

IMPORT_C void RFavouritesSession::ResourceMark

Start checking the number of allocated object through this session.

Returns:: void

TInt RFavouritesSession::SendReceive ( TInt aFunction ) const [inline]

Message passing routine.

Parameters:

Returns:: Error code.

TInt RFavouritesSession::SendReceive	(	TInt	aFunction,
		const TIpcArgs &	aArgs
	)	const `[inline]`

Message passing routine.

Parameters:

	aFunction	Function.
	aArgs	Arguments.

Returns:: Error code.

void RFavouritesSession::SendReceive	(	TInt	aFunction,
		const TIpcArgs &	aArgs,
		TRequestStatus &	aStatus
	)	const `[inline]`

Message passing routine.

Parameters:

	aFunction	Function.
	aArgs	Arguments.
	aStatus	Request status.

static IMPORT_C TVersion RFavouritesSession::Version ( ) [static]

Get version.

Returns:: Version.

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

favouritessession.h

Copyright © Nokia Corporation 2001-2008