REcmt Class Reference

API published in: S60 3rd Ed

Link against: ecmtclient.lib

#include <ecmtclient.h>

Detailed Description

A handle to a session with Ecmt server.

This class provides methods for sending textual data to the System Output Diagnostic view on the connected PC.


Public Member Functions
IMPORT_C	REcmt ()
	Constructor.
IMPORT_C	~REcmt ()
	Destructor.
IMPORT_C TInt	Connect ()
	Connects the client process to the Ecmt server.
IMPORT_C void	Close ()
	Closes the session and frees any allocated resources.
IMPORT_C void	SetServerObserverL (MEcmtServerObserver *aObserver)
	This member is internal and not intended for use.
IMPORT_C void	Write (const TDesC16 &aText)
	Writes text data to the System Output Diagnostic view on the connected PC.
IMPORT_C void	WriteFormat (TRefByValue< const TDesC16 > aFmt,...)
	Writes text data to the System Output Diagnostic view on the connected PC.
IMPORT_C void	Send (const TUint uid, const TDesC8 &aText)
	This member is internal and not intended for use.
IMPORT_C void	SetServerObserverL (TUid aUid, MEcmtServerObserver *aObserver)
	This member is internal and not intended for use.
Static Public Member Functions
static IMPORT_C void	SWrite (const TDesC16 &aText)
	Writes text data to the System Output Diagnostic view on the connected PC.
static IMPORT_C void	SWriteFormat (TRefByValue< const TDesC16 > aFmt,...)
	Writes text data to the System Output Diagnostic view on the connected PC.
static IMPORT_C void	SClose ()
	Closes the REcmt session used by SWrite() and SWriteFormat().
Friends
class	CEcmtServerListener

Constructor & Destructor Documentation

IMPORT_C REcmt::REcmt

(

)

Constructor.

IMPORT_C REcmt::~REcmt

(

)

Destructor.

Member Function Documentation

IMPORT_C void REcmt::Close

(

)

Closes the session and frees any allocated resources.

IMPORT_C TInt REcmt::Connect

(

)

Connects the client process to the Ecmt server.

To end the session, use the Close() method.

Returns:: KErrNone if succesfull otherwise one of the system-wide error codes.

static IMPORT_C void REcmt::SClose ( ) [static]

Closes the REcmt session used by SWrite() and SWriteFormat().

If those funcions are called, also SClose() must be called in order to avoid memory allocation errors.

IMPORT_C void REcmt::Send	(	const TUint	uid,
		const TDesC8 &	aText
	)

This member is internal and not intended for use.

Sends a binary message to the specified UID (plugin, core).

IMPORT_C void REcmt::SetServerObserverL	(	TUid	aUid,
		MEcmtServerObserver *	aObserver
	)

This member is internal and not intended for use.

Sets this client as a recipient for messages.

IMPORT_C void REcmt::SetServerObserverL

(

MEcmtServerObserver *

aObserver

)

This member is internal and not intended for use.

This member leaves immediately with KErrNotSupported.

Deprecated:

static IMPORT_C void REcmt::SWrite ( const TDesC16 & aText ) [static]

Writes text data to the System Output Diagnostic view on the connected PC.

Unlike Write(), doesn't require Connect() before or Close() after calling this.

Parameters:

aText

Text to be written.

static IMPORT_C void REcmt::SWriteFormat	(	TRefByValue< const TDesC16 >	aFmt,
			...
	)	`[static]`

Writes text data to the System Output Diagnostic view on the connected PC.

The text can include formatting directives (%d, %c, ...) which are then filled with the following parameters. The maximum length of the message after formatting is defined by KFormatMazSize. Unlike WriteFormat(), doesn't require Connect() before or Close() after calling this.

Parameters:

	aText	Text to be written.
	...	Values used for formatting.

IMPORT_C void REcmt::Write

(

const TDesC16 &

aText

)

Writes text data to the System Output Diagnostic view on the connected PC.

Parameters:

aText

Text to be written.

IMPORT_C void REcmt::WriteFormat	(	TRefByValue< const TDesC16 >	aFmt,
			...
	)

Writes text data to the System Output Diagnostic view on the connected PC.

The text can include formatting directives (%d, %c, ...) which are then filled with the following parameters. The maximum length of the message after formatting is defined by KFormatMazSize.

Parameters:

	aText	Text to be written.
	...	Values used for formatting.

Friends And Related Function Documentation

friend class CEcmtServerListener [friend]

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

ecmtclient.h

REcmt Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation