Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <cmsvrecipientlist.h>
Link against: msgs.lib
Link against: msgs_autoshutdown.lib

Class CMsvRecipientList

class CMsvRecipientList : public CBase;

Description

Derivation

Members

Defined in CMsvRecipientList:

Inherited from CBase:


Construction and destruction


~CMsvRecipientList()

virtual ~CMsvRecipientList();

Description

Destructor.

[Top]


Member functions


Reset()

IMPORT_C void Reset();

Description

Deletes all elements from the array.


Count()const

IMPORT_C TInt Count() const;

Description

The number of accounts for this message type.

Return value

TInt

The number of accounts.


AppendL(const TDesC &)

IMPORT_C void AppendL(const TDesC &aPtr);

Description

Appends a new address as a 'to' recipient.

Parameters

const TDesC16 &aPtr

The address to add.


AppendL(TMsvRecipientType,const TDesC &)

IMPORT_C void AppendL(TMsvRecipientType aValue, const TDesC &aPtr);

Description

Appends a new address a the given recipient type.

Parameters

TMsvRecipientType aValue

The type of addressee. Possible types are EMtmRecipientTo, EMtmRecipientCc and EMtmRecipientBcc

const TDesC16 &aPtr

The address to add.


Delete(TInt)

IMPORT_C void Delete(TInt aPos);

Description

Deletes an existing address.

Parameters

TInt aPos

The index of the address to delete.


Delete(TInt,TInt)

IMPORT_C void Delete(TInt aPos, TInt aCount);

Description

Deletes number of existing addresses.

Parameters

TInt aPos

The start index of the addresses to delete.

TInt aCount

The number of sequential addresses to delete.


Type(TInt)const

IMPORT_C TMsvRecipientType Type(TInt aPos) const;

Description

Returns the address type specified by the index given.

Parameters

TInt aPos

Return value

TMsvRecipientType


operator[](TInt)const

IMPORT_C const TDesC& operator[](TInt aIndex) const;

Description

Returns the address specified by the index given.

Parameters

TInt aIndex

The index of the address to return.

Return value

const TDesC16 &


RecipientList()const

IMPORT_C const MDesC16Array& RecipientList() const;

Description

Return value

const MDesC16Array &