Class CSendAsAccounts

class CSendAsAccounts : public CBase;

Description

Provides human-readable names and IDs for the list of accounts for a given message type.

Derivation

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

• CSendAsAccounts - Provides human-readable names and IDs for the list of accounts for a given message type

Members

Defined in CSendAsAccounts:
Account(), AccountFromNameL(), AccountNames(), AppendAccountL(), Count(), MessageType(), NameFromAccountL(), NewL(), RemoveAccount(), Reset(), SetMessageType(), Size(), ~CSendAsAccounts()

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

static IMPORT_C CSendAsAccounts *NewL();

Description

Create a new CSendAsAccount.

Return value

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

virtual IMPORT_C ~CSendAsAccounts();

Description

Destructor.

IMPORT_C TUid MessageType() const;

Description

The UID of the message type.

Return value

TUid The UID of the message type.

IMPORT_C void SetMessageType(TUid aMessageType);

Description

Sets UID of the message type.

Parameters

TUid aMessageType The UID of the message type.

IMPORT_C const MDesC16Array &AccountNames() const;

Description

The array of names of accounts for this message type.

Return value

const MDesC16Array & An array of name of accounts.

IMPORT_C TSendAsAccount Account(TInt aIndex) const;

Description

The account specified by the index argument.

Parameters

TInt aIndex The index of the specified account.

Return value

TSendAsAccount The account specified by the index argument.

IMPORT_C TPtrC NameFromAccountL(const TSendAsAccount aAccount) const;

Description

The name associated with the given account.

Parameters

const TSendAsAccount aAccount The account whose associated name is to be returned.

Return value

TPtrC A descriptor holding the associated name.

IMPORT_C TSendAsAccount AccountFromNameL(const TDesC &aName) const;

Description

The account associated with the given name.

Parameters

const TDesC &aName The associated name for the account to be returned.

Return value

TSendAsAccount An account for the associated name.

Leave codes

KErrNotFound An account with the given name cannot be found.

IMPORT_C TInt Count() const;

Description

The number of accounts for this message type.

Return value

TInt The number of accounts.

IMPORT_C void Reset();

Description

Deletes all elements from the array.

IMPORT_C void AppendAccountL(const TDesC &aAccountName, TSendAsAccount aAccount);

Description

Appends a new account and associated name pair.

Parameters

const TDesC &aAccountName The human readable name with which to associate with the given account. TSendAsAccount aAccount The account to add.

IMPORT_C void RemoveAccount(TInt aIndex);

Description

Removes an existing account 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 accounts collection.

Return value

TInt The size of the accounts collection.