CSendAsAccounts Class Reference

#include <mw/csendasaccounts.h>

Link against: sendas2.lib

class CSendAsAccounts : public CBase

Inherits from

CSendAsAccounts
- CBase

Public Member Functions
virtual	~CSendAsAccounts()
IMPORT_C TSendAsAccount	Account(TInt)
IMPORT_C TSendAsAccount	AccountFromNameL(const TDesC &)
IMPORT_C const MDesCArray &	AccountNames()
IMPORT_C void	AppendAccountL(const TDesC &, TSendAsAccount)
IMPORT_C TInt	Count()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TUid	MessageType()
IMPORT_C TPtrC	NameFromAccountL(const TSendAsAccount)
IMPORT_C CSendAsAccounts *	NewL()
IMPORT_C void	RemoveAccount(TInt)
IMPORT_C void	Reset()
IMPORT_C void	SetMessageType(TUid)
IMPORT_C TInt	Size()

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 IDs for the list of accounts for a given message type.

Constructor & Destructor Documentation

~CSendAsAccounts ( )

IMPORT_C

~CSendAsAccounts

(

)

[virtual]

Destructor.

Member Function Documentation

Account ( TInt )

IMPORT_C TSendAsAccount

Account

(

TInt

aIndex

)

const

The account specified by the index argument.

Parameters
aIndex	The index of the specified account.

Return Value: The account specified by the index argument.

AccountFromNameL ( const TDesC & )

IMPORT_C TSendAsAccount

AccountFromNameL

(

const TDesC &

aName

)

const

The account associated with the given name.

Parameters
aName	The associated name for the account to be returned.

Return Value: An account for the associated name.

Leave Codes
KErrNotFound	An account with the given name cannot be found.

AccountNames ( )

IMPORT_C const MDesCArray &

AccountNames

(

)

const

The array of names of accounts for this message type.

Return Value: An array of name of accounts.

AppendAccountL ( const TDesC &, TSendAsAccount )

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

Appends a new account and associated name pair.

Parameters
aAccountName	The human readable name with which to associate with the given account.
aAccount	The account to add.

Count ( )

IMPORT_C TInt

Count

(

)

const

The number of accounts for this message type.

Return Value: The number of accounts.

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.

MessageType ( )

IMPORT_C TUid

MessageType

(

)

const

The UID of the message type.

Return Value: The UID of the message type.

NameFromAccountL ( const TSendAsAccount )

IMPORT_C TPtrC

NameFromAccountL

(

const TSendAsAccount

aAccount

)

const

The name associated with the given account.

Parameters
aAccount	The account whose associated name is to be returned.

Return Value: A descriptor holding the associated name.

NewL ( )

IMPORT_C CSendAsAccounts *

NewL

(

)

[static]

Create a new CSendAsAccount.

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

RemoveAccount ( TInt )

IMPORT_C void

RemoveAccount

(

TInt

aIndex

)

Removes an existing account and associated name pair.

Parameters
aIndex	The index of the entry to remove.

Reset ( )

IMPORT_C void

Reset

(

)

Deletes all elements from the array.

SetMessageType ( TUid )

IMPORT_C void

SetMessageType

(

TUid

aMessageType

)

Sets UID of the message type.

Parameters
aMessageType	The UID of the message type.

Size ( )

IMPORT_C TInt

Size

(

)

const

Gives the size of the accounts collection.

Return Value: The size of the accounts collection.