CSendAsMessageTypes Class Reference

#include <mw/csendasmessagetypes.h>

Link against: sendas2.lib

class CSendAsMessageTypes : public CBase

Inherits from

CSendAsMessageTypes
- CBase

Public Member Functions
virtual	~CSendAsMessageTypes()
IMPORT_C void	AppendMessageTypeL(const TDesC &, TUid)
IMPORT_C const MDesCArray &	AvailableMessageTypes()
IMPORT_C TInt	Count()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TUid	MessageTypeUid(TInt)
IMPORT_C TPtrC	NameFromUidL(const TUid)
IMPORT_C CSendAsMessageTypes *	NewL()
IMPORT_C void	RemoveMessageType(TInt)
IMPORT_C void	Reset()
IMPORT_C TInt	Size()
IMPORT_C TUid	UidFromNameL(const TDesC &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Provides human-readable names and UIDs for the filtered list of message types.

Constructor & Destructor Documentation

~CSendAsMessageTypes ( )

IMPORT_C

~CSendAsMessageTypes

(

)

[virtual]

Destructor.

Member Function Documentation

AppendMessageTypeL ( const TDesC &, TUid )

IMPORT_C void	AppendMessageTypeL	(	const TDesC &	aMessageTypeName,
			TUid	aMessageTypeUid
		)

Appends a new message type and associated name pair.

Parameters
aMessageTypeName	The human readable name with which to associate with the given message type.
aMessageTypeUid	The message type to add.

AvailableMessageTypes ( )

IMPORT_C const MDesCArray &

AvailableMessageTypes

(

)

const

The names of the available message types.

Return Value: An array of names for the available message types.

Count ( )

IMPORT_C TInt

Count

(

)

const

The number of message types.

Return Value: The number of message types.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aWriteStream

)

const

Externalizes the object from the specified stream.

Parameters
aWriteStream	The stream to write out to.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aReadStream

)

Internalizes the object from the specified stream.

Parameters
aReadStream	The stream to read from.

MessageTypeUid ( TInt )

IMPORT_C TUid

MessageTypeUid

(

TInt

aIndex

)

const

The UID of the message as specified by the index argument.

Parameters
aIndex	The index of the specified message type.

Return Value: The UID of the specified message type.

NameFromUidL ( const TUid )

IMPORT_C TPtrC

NameFromUidL

(

const TUid

aUid

)

const

The name associated with the given message type.

Parameters
aUid	The message type UID whose associated name is to be retrieved.

Return Value: A descriptor holding the associated name.

NewL ( )

IMPORT_C CSendAsMessageTypes *

NewL

(

)

[static]

Create a new CSendAsMessageTypes.

Return Value: If the function succeeds, this is a pointer to a newly allocated and initialised object.

RemoveMessageType ( TInt )

IMPORT_C void

RemoveMessageType

(

TInt

aIndex

)

Removes an existing message type and associated name pair.

Parameters
aIndex	The index of the entry to remove.

Reset ( )

IMPORT_C void

Reset

(

)

Deletes all elements from the array.

Size ( )

IMPORT_C TInt

Size

(

)

const

Gives the size of the message types collection.

Return Value: The size of the message types collection.

UidFromNameL ( const TDesC & )

IMPORT_C TUid

UidFromNameL

(

const TDesC &

aName

)

const

The message type associated with the given name.

Parameters
aName	The associated name of the message type whose UID is to be returned.

Return Value: The message type UID for the given name.