Class CSendAsMessageTypes

class CSendAsMessageTypes : public CBase;

Description

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap

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

Members

Defined in CSendAsMessageTypes:
AppendMessageTypeL(), AvailableMessageTypes(), Count(), MessageTypeUid(), NameFromUidL(), NewL(), RemoveMessageType(), Reset(), Size(), UidFromNameL(), ~CSendAsMessageTypes()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CSendAsMessageTypes *NewL();

Description

Create a new CSendAsMessageTypes.

Return value

CSendAsMessageTypes * If the function succeeds, this is a pointer to a newly allocated and initialised object.

virtual IMPORT_C ~CSendAsMessageTypes();

Description

Destructor.

IMPORT_C const MDesC16Array &AvailableMessageTypes() const;

Description

The names of the available message types.

Return value

const MDesC16Array & An array of names for the available message types.

IMPORT_C TUid MessageTypeUid(TInt aIndex) const;

Description

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

Parameters

TInt aIndex The index of the specified message type.

Return value

TUid The UID of the specified message type.

IMPORT_C TPtrC NameFromUidL(const TUid aUid) const;

Description

The name associated with the given message type.

Parameters

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

Return value

TPtrC A descriptor holding the associated name.

IMPORT_C TUid UidFromNameL(const TDesC &aName) const;

Description

The message type associated with the given name.

Parameters

const TDesC &aName The associated name of the message type whose UID is to be returned.

Return value

TUid The message type UID for the given name.

IMPORT_C TInt Count() const;

Description

The number of message types.

Return value

TInt The number of message types.

IMPORT_C void Reset();

Description

Deletes all elements from the array.

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

Description

Appends a new message type and associated name pair.

Parameters

const TDesC &aMessageTypeName The human readable name with which to associate with the given message type. TUid aMessageTypeUid The message type to add.

IMPORT_C void RemoveMessageType(TInt aIndex);

Description

Removes an existing message type and associated name pair.

Parameters

TInt aIndex The index of the entry to remove.

IMPORT_C TInt Size() const;

Description

Gives the size of the message types collection.

Return value

TInt The size of the message types collection.