A handle to a session with the extended notifier server that provides support for plug-in notifiers. More...

#include <e32std.h>

Inheritance diagram for RNotifier:

Public Member Functions
IMPORT_C	RNotifier ()
	Default constructor.

IMPORT_C TInt	Connect ()
	Connects to the extended notifier server, creating a session with that server.

IMPORT_C void	Close ()
	Closes the notifier.

IMPORT_C TInt	StartNotifier (TUid aNotifierUid, const TDesC8 &aBuffer)
	Requests the extended notifier server to start the notifier identified by the specified UID.

IMPORT_C TInt	StartNotifier (TUid aNotifierUid, const TDesC8 &aBuffer, TDes8 &aResponse)
	Requests the extended notifier server to start the notifier identified by the specified UID.

IMPORT_C TInt	StartNotifier (TUid aNotifierDllUid, TUid aNotifierUid, const TDesC8 &aBuffer, TDes8 &aResponse)

IMPORT_C TInt	CancelNotifier (TUid aNotifierUid)
	Requests the extended notifier server to cancel the notifier identified by the specified UID.

IMPORT_C TInt	UpdateNotifier (TUid aNotifierUid, const TDesC8 &aBuffer, TDes8 &aResponse)
	Requests the extended notifier server to update the active notifier identified by the specified UID.

IMPORT_C void	UpdateNotifierAndGetResponse (TRequestStatus &aRs, TUid aNotifierUid, const TDesC8 &aBuffer, TDes8 &aResponse)
	Requests the extended notifier server to update the active notifier identified by the specified UID.

IMPORT_C void	StartNotifierAndGetResponse (TRequestStatus &aRs, TUid aNotifierUid, const TDesC8 &aBuffer, TDes8 &aResponse)
	Requests the extended notifier server to start the notifier identified by the specified UID.

IMPORT_C void	StartNotifierAndGetResponse (TRequestStatus &aRs, TUid aNotifierDllUid, TUid aNotifierUid, const TDesC8 &aBuffer, TDes8 &aResponse)
	This function has never been implemented on any Symbian OS version.

IMPORT_C TInt	UnloadNotifiers (TUid aNotifierUid)
	This function has never been implemented on any Symbian OS version.

IMPORT_C TInt	LoadNotifiers (TUid aNotifierUid)
	This function has never been implemented on any Symbian OS version.

IMPORT_C void	Notify (const TDesC &aLine1, const TDesC &aLine2, const TDesC &aBut1, const TDesC &aBut2, TInt &aButtonVal, TRequestStatus &aStatus)
	Launches a simple two line dialog that displays two lines of text.

IMPORT_C void	NotifyCancel ()
	Not implemented by the server.

IMPORT_C TInt	InfoPrint (const TDesC &aDes)

Public Member Functions inherited from RSessionBase
TInt	ShareAuto ()
	Creates a session that can be shared by other threads in the current process.

TInt	ShareProtected ()
	Creates a session handle that can be be passed via IPC to another process as well as being shared by other threads in the current process.

IMPORT_C TInt	Open (RMessagePtr2 aMessage, TInt aParam, TOwnerType aType=EOwnerProcess)
	Opens a handle to a session using a handle number sent by a client to a server.

IMPORT_C TInt	Open (RMessagePtr2 aMessage, TInt aParam, const TSecurityPolicy &aServerPolicy, TOwnerType aType=EOwnerProcess)
	Opens a handle to a session using a handle number sent by a client to a server, and validate that the session's server passes a given security policy.

IMPORT_C TInt	Open (TInt aArgumentIndex, TOwnerType aType=EOwnerProcess)
	Opens a handle to a session using a handle number passed as an environment data item to the child process during the creation of that child process.

IMPORT_C TInt	Open (TInt aArgumentIndex, const TSecurityPolicy &aServerPolicy, TOwnerType aType=EOwnerProcess)
	Opens a handle to a session using a handle number passed as an environment data item to the child process during the creation of that child process, after validating that the session's server passes the given security policy.

TInt	SetReturnedHandle (TInt aHandleOrError)
	Sets the handle-number of this handle to the specified value.

IMPORT_C TInt	SetReturnedHandle (TInt aHandleOrError, const TSecurityPolicy &aServerPolicy)
	Sets the handle-number of this session handle to the specified value after validating that the session's server passes a given security policy.

Public Member Functions inherited from RHandleBase
	RHandleBase ()
	Default constructor.

TInt	Handle () const
	Retrieves the handle-number of the object associated with this handle.

void	SetHandle (TInt aHandle)
	Sets the handle-number of this handle to the specified value.

TInt	SetReturnedHandle (TInt aHandleOrError)
	Sets the handle-number of this handle to the specified value.

IMPORT_C void	Close ()
	Closes the handle.

IMPORT_C TName	Name () const
	Gets the name of the handle.

IMPORT_C TFullName	FullName () const
	Gets the full name of the handle.

IMPORT_C void	FullName (TDes &aName) const
	Gets the full name of the handle.

IMPORT_C void	SetHandleNC (TInt aHandle)
	Sets the handle-number of this handle to the specified value, and marks it as not closable.

IMPORT_C TInt	Duplicate (const RThread &aSrc, TOwnerType aType=EOwnerProcess)
	Creates a valid handle to the kernel object for which the specified thread already has a handle.

IMPORT_C void	HandleInfo (THandleInfo *anInfo)
	Gets information about the handle.

IMPORT_C TUint	Attributes () const

IMPORT_C TInt	BTraceId () const
	Returns a unique object identifier for use with BTrace.

IMPORT_C void	NotifyDestruction (TRequestStatus &aStatus)
	Internal technology API.

Additional Inherited Members
Public Types inherited from RSessionBase
enum	TAttachMode { EExplicitAttach , EAutoAttach }
	Indicates whether or not threads in the process are automatically attached to the session when passed as a parameter to the Share() function. More...

Public Types inherited from RHandleBase
enum	TAttributes { EReadAccess =0x1 , EWriteAccess =0x2 , EDirectReadAccess =0x4 , EDirectWriteAccess =0x8 }
	Read/Write attributes for the handle. More...

Static Public Member Functions inherited from RHandleBase
static void	DoExtendedClose ()

Protected Member Functions inherited from RSessionBase
TInt	CreateSession (const TDesC &aServer, const TVersion &aVersion)
	Creates a session with a server, specifying no message slots.

IMPORT_C TInt	CreateSession (const TDesC &aServer, const TVersion &aVersion, TInt aAsyncMessageSlots)
	Creates a session with a server.

IMPORT_C TInt	CreateSession (const TDesC &aServer, const TVersion &aVersion, TInt aAsyncMessageSlots, TIpcSessionType aType, const TSecurityPolicy aPolicy=0, TRequestStatus aStatus=0)
	Creates a session with a server.

TInt	CreateSession (RServer2 aServer, const TVersion &aVersion)
	Creates a session with a server, specifying no message slots.

IMPORT_C TInt	CreateSession (RServer2 aServer, const TVersion &aVersion, TInt aAsyncMessageSlots)
	Creates a session with a server.

IMPORT_C TInt	CreateSession (RServer2 aServer, const TVersion &aVersion, TInt aAsyncMessageSlots, TIpcSessionType aType, const TSecurityPolicy aPolicy=0, TRequestStatus aStatus=0)
	Creates a session with a server.

TInt	CreateSession (const TDesC &aServer, const TVersion &aVersion, TInt aAsyncMessageSlots, TRequestStatus *aStatus)

TInt	Send (TInt aFunction, const TIpcArgs &aArgs) const
	Issues a blind request to the server with the specified function number, and arguments.

void	SendReceive (TInt aFunction, const TIpcArgs &aArgs, TRequestStatus &aStatus) const
	Issues an asynchronous request to the server with the specified function number and arguments.

TInt	SendReceive (TInt aFunction, const TIpcArgs &aArgs) const
	Issues a synchronous request to the server with the specified function number and arguments.

TInt	Send (TInt aFunction) const
	Issues a blind request to the server with the specified function number, but with no arguments.

void	SendReceive (TInt aFunction, TRequestStatus &aStatus) const
	Issues an asynchronous request to the server with the specified function number, but with no arguments.

TInt	SendReceive (TInt aFunction) const
	Issues a synchronous request to the server with the specified function number, but with no arguments.

Protected Member Functions inherited from RHandleBase
	RHandleBase (TInt aHandle)
	Copy constructor.

IMPORT_C TInt	Open (const TFindHandleBase &aHandle, TOwnerType aType)
	Opens a handle to a kernel side object found using a find-handle object.

TInt	OpenByName (const TDesC &aName, TOwnerType aOwnerType, TInt aObjectType)
	Implementation for RXxxxx::Open/OpenGlocbal(const TDesC &aName,,TOwnerType aType) functions.

Static Protected Member Functions inherited from RSessionBase
static TInt	SetReturnedHandle (TInt aHandleOrError, RHandleBase &aHandle)

Static Protected Member Functions inherited from RHandleBase
static TInt	SetReturnedHandle (TInt aHandleOrError, RHandleBase &aHandle)

Protected Attributes inherited from RHandleBase
TInt	iHandle

Detailed Description

A handle to a session with the extended notifier server that provides support for plug-in notifiers.

The interface allows engines or other low level components to communicate with the UI.

API status: Published to all clients. Released API.

Definition at line 4876 of file e32std.h.

Constructor & Destructor Documentation

◆ RNotifier()

IMPORT_C RNotifier::RNotifier ( )

Default constructor.

(generated from Symbian Developer Library)

Member Function Documentation

◆ CancelNotifier()

IMPORT_C TInt RNotifier::CancelNotifier ( TUid aNotifierUid )

Requests the extended notifier server to cancel the notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

Any notifier that was queued pending the completion of aNotifierUid will be automatically started.

Parameters

aNotifierUid The UID identifying the notifier.

(generated from Symbian Developer Library)

◆ Close()

IMPORT_C void RNotifier::Close ( )

Closes the notifier.

(generated from Symbian Developer Library)

◆ Connect()

IMPORT_C TInt RNotifier::Connect ( )

Connects to the extended notifier server, creating a session with that server.

Note: Notifier server is started during window server start-up sequence.

The function must be called before any other function.

(generated from Symbian Developer Library)

◆ InfoPrint()

IMPORT_C TInt RNotifier::InfoPrint ( const TDesC & aDes )

◆ LoadNotifiers()

IMPORT_C TInt RNotifier::LoadNotifiers ( TUid aNotifierUid )

This function has never been implemented on any Symbian OS version.

It always returns KErrNotSupported.

(generated from Symbian Developer Library)

◆ Notify()

IMPORT_C void RNotifier::Notify	(	const TDesC &	aLine1,
		const TDesC &	aLine2,
		const TDesC &	aBut1,
		const TDesC &	aBut2,
		TInt &	aButtonVal,
		TRequestStatus &	aStatus
	)

Launches a simple two line dialog that displays two lines of text.

This is an asynchronous request that completes when the dialog exits.

Parameters

aLine1	A descriptor containing the first line of text to be displayed.
aLine2	A descriptor containing the second line of text to be displayed.
aBut1	A descriptor containing text to be displayed in the first button.
aBut2	A descriptor containing text to be displayed in the (optional) second button.
aButtonVal	An integer value which is set when the dialog exits. It is set to: 0, if the first button is selected; 1, if the second button is selected.
aStatus	The request status object. If the request completes normally, this is set to KErrNone.

(generated from Symbian Developer Library)

◆ NotifyCancel()

IMPORT_C void RNotifier::NotifyCancel ( )

Not implemented by the server.

(generated from Symbian Developer Library)

◆ StartNotifier() [1/3]

IMPORT_C TInt RNotifier::StartNotifier	(	TUid	aNotifierDllUid,
		TUid	aNotifierUid,
		const TDesC8 &	aBuffer,
		TDes8 &	aResponse
	)

◆ StartNotifier() [2/3]

IMPORT_C TInt RNotifier::StartNotifier	(	TUid	aNotifierUid,
		const TDesC8 &	aBuffer
	)

Requests the extended notifier server to start the notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

The notifier may not be started immediately if a higher priority notifier is already active. In this case, the notifier is queued until it has the highest priority outstanding request for the channel(s) it operates on.

CServer

Parameters

aNotifierUid	The UID identifying the notifier.
aBuffer	Data that can be passed to the notifier; the format and meaning of this depends on the notifier.

(generated from Symbian Developer Library)

◆ StartNotifier() [3/3]

IMPORT_C TInt RNotifier::StartNotifier	(	TUid	aNotifierUid,
		const TDesC8 &	aBuffer,
		TDes8 &	aResponse
	)

Requests the extended notifier server to start the notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

The notifier may not start immediately if a higher priority notifier is already active. In this case, the notifier is queued until it has the highest priority outstanding request for the channel(s) it operates on. This can also cause unexpected behaviour: the function can return before the notifier has been started with the added consequence that no response data is written.

For this reason, this function has been deprecated. Instead, use RNotifier::StartNotifierAndGetResponse(), or if there is no need to wait for a response, use the two argument overload of RNotifier::StartNotifier().

CServeruse RNotifier::StartNotifierAndGetResponse(), or if there is no need to wait for a response, use the two argument overload of RNotifier::StartNotifier()

Parameters

aNotifierUid	The UID identifying the notifier.
aBuffer	Data that can be passed to the notifier; the format and meaning of this depends on the notifier.
aResponse	Response data; the format and meaning of this depends on the notifier.

(generated from Symbian Developer Library)

◆ StartNotifierAndGetResponse() [1/2]

IMPORT_C void RNotifier::StartNotifierAndGetResponse	(	TRequestStatus &	aRs,
		TUid	aNotifierDllUid,
		TUid	aNotifierUid,
		const TDesC8 &	aBuffer,
		TDes8 &	aResponse
	)

This function has never been implemented on any Symbian OS version.

The request always completes with KErrNotSupported.

(generated from Symbian Developer Library)

◆ StartNotifierAndGetResponse() [2/2]

IMPORT_C void RNotifier::StartNotifierAndGetResponse	(	TRequestStatus &	aRs,
		TUid	aNotifierUid,
		const TDesC8 &	aBuffer,
		TDes8 &	aResponse
	)

Requests the extended notifier server to start the notifier identified by the specified UID.

This is an asynchronous request.It may be called multiple times for some notifier implementations; see specific notifier documentation for exact details.

Parameters

aRs	The request status. On request completion, contains: KErrNone, if successful; otherwise, one of the other system wide error codes.
aNotifierUid	The UID identifying the notifier.
aBuffer	Data that can be passed to the notifier; the format and meaning of this depends on the notifier.
aResponse	Response data; the format and meaning of this depends on the notifier.

(generated from Symbian Developer Library)

◆ UnloadNotifiers()

IMPORT_C TInt RNotifier::UnloadNotifiers ( TUid aNotifierUid )

This function has never been implemented on any Symbian OS version.

It always returns KErrNotSupported.

(generated from Symbian Developer Library)

◆ UpdateNotifier()

IMPORT_C TInt RNotifier::UpdateNotifier	(	TUid	aNotifierUid,
		const TDesC8 &	aBuffer,
		TDes8 &	aResponse
	)

Requests the extended notifier server to update the active notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

Parameters

aNotifierUid	The UID identifying the notifier.
aBuffer	Data that can be passed to the notifier; the format and meaning of this depends on the notifier.
aResponse	Reserved for future use.

(generated from Symbian Developer Library)

◆ UpdateNotifierAndGetResponse()

IMPORT_C void RNotifier::UpdateNotifierAndGetResponse	(	TRequestStatus &	aRs,
		TUid	aNotifierUid,
		const TDesC8 &	aBuffer,
		TDes8 &	aResponse
	)

Requests the extended notifier server to update the active notifier identified by the specified UID.

This is an asynchronous request.It may be called multiple times for some notifier implementations; see specific notifier documentation for exact details.

Parameters

aRs	The request status. On request completion, contains: KErrNone, if successful; otherwise, one of the other system wide error codes.
aNotifierUid	The UID identifying the notifier.
aBuffer	Data that can be passed to the notifier; the format and meaning of this depends on the notifier.
aResponse	Reserved for future use.

(generated from Symbian Developer Library)

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RNotifier()

Member Function Documentation

◆ CancelNotifier()

◆ Close()

◆ Connect()

◆ InfoPrint()

◆ LoadNotifiers()

◆ Notify()

◆ NotifyCancel()

◆ StartNotifier() [1/3]

◆ StartNotifier() [2/3]

◆ StartNotifier() [3/3]

◆ StartNotifierAndGetResponse() [1/2]

◆ StartNotifierAndGetResponse() [2/2]

◆ UnloadNotifiers()

◆ UpdateNotifier()

◆ UpdateNotifierAndGetResponse()