Collapse all Symbian^3 Application Developer Library

MCatalogsSession Class Reference

class MCatalogsSession

Interface to session on server side. Used for example for receiver object registration.

Message is passed to a certain object within a session based on an object handle passed along with the message. A handle is generated when an object is registered as a message receiver. This interface gives access for example to functions to register objects as message receiver and to later remove these registered receivers.

?library

Since: S60 ?S60_version *** for example, S60 v3.0

Public Member Functions
TInt	AddObjectL ( CObject *)
MCatalogsContext &	Context ()
const MCatalogsContext *	ContextPtr ()
void	RemoveObject ( TInt )

Member Functions Documentation

AddObjectL(CObject *)

TInt

AddObjectL

(

CObject *

aObject

)

[pure virtual]

Adds an object to the related session's receivers. Calls Open() once for the given CObject . NOTICE: After construction the reference count of the CObject is one, and after adding it to the receivers, with this method, it is two.

Since: S60 ?S60_version

Parameters

CObject * aObject

The object to be added. Notice that aObject has to be closed (destroyed) by user if a leave occurs. It is not done by this function.

Context()

MCatalogsContext &

Context

(

)

[pure virtual]

Get context information of the session. Not a const-method to allow possible altering of the context through the interface although it is probably never needed.

Since: S60 ?S60_version

ContextPtr()

const MCatalogsContext *

ContextPtr

(

)

const [pure virtual]

RemoveObject(TInt)

void

RemoveObject

(

TInt

aHandle

)

[pure virtual]

Removes an object reference from the related session's receivers.

Since: S60 ?S60_version

Parameters

TInt aHandle

a handle to the object reference to be removed