Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <MSVRCPT.H>
Link against: msgs.lib
Link against: msgs_autoshutdown.lib

Class CMsvRecipient

class CMsvRecipient : public CBase;

Description

Base class for information relating to a message recipient.

Derivation

Members

Defined in CMsvRecipient:

Inherited from CBase:


Construction and destruction


CMsvRecipient()

protected: IMPORT_C CMsvRecipient();

Description

Protected base class default constructor.

[Top]


Member functions


InternalizeL(RReadStream &)

IMPORT_C virtual void InternalizeL(RReadStream &aStream);

Description

Internalises the object from a read stream.

Parameters

RReadStream &aStream

The stream from which the object should be internalised.


ExternalizeL(RWriteStream &)const

IMPORT_C virtual void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the object to a write stream.

Parameters

RWriteStream &aStream

Stream to which the object should be externalised.


Status()const

inline TRecipientStatus Status() const;

Description

Gets the message sending status for the recipient.

Return value

CMsvRecipient::TRecipientStatus

Message sending status for the recipient


SetStatus(TRecipientStatus)

inline void SetStatus(TRecipientStatus aStatus);

Description

Sets the message sending status for the recipient.

Parameters

CMsvRecipient::TRecipientStatus aStatus

Message sending status for the recipient


Error()const

inline TInt Error() const;

Description

Gets any error code for message sending to the recipient.

Return value

TInt

System wide error code


SetError(TInt)

inline void SetError(TInt aError);

Description

Sets any error code for message sending to the recipient.

Parameters

TInt aError

System wide error code


Time()const

inline const TTime& Time() const;

Description

Gets the (const) time for message sending to the recipient.

Return value

const TTime &

Time for message sending to the recipient


Time()

inline TTime& Time();

Description

Gets the (writable) time for message sending to the recipient.

Return value

TTime &

Time for message sending to the recipient


Retries()const

inline TInt Retries() const;

Description

Gets the number of retries for message sending to the recipient.

Return value

TInt

Number of retries


IncreaseRetries()

inline void IncreaseRetries();

Description

Increments the number of retries for message sending to the recipient.


ResetRetries()

inline void ResetRetries();

Description

Resets the number of retries for message sending to the recipient to zero.

[Top]


Member enumerations


Enum TRecipientStatus

TRecipientStatus

Description

Message sending status for a recipient.

ENotYetSent

Message is not sent.

ESentSuccessfully

Message has been sent.

EFailedToSend

Message sending failed.