
DEVELOPER LIBRARY

» Developer Library » API Reference » C++ API reference » Fax Client MTM » CFaxRecipient

Location: FXUT.h
Link against: fxcm.lib

Class `CFaxRecipient`

class CFaxRecipient

Support

Supported from 6.0

Description

Encapsulates recipient information for a fax message.

Recipient information is stored as part of a fax headers, CFaxHeader, object.

Derivation

`CBase`	Base class for all classes to be instantiated on the heap
`CFaxRecipient`	Encapsulates recipient information for a fax message
`CMsvRecipient`	Base class for information relating to a message recipient

Defined in CFaxRecipient:
CFaxRecipient(), ExternalizeL(), InternalizeL(), Name(), Number(), SendingPage(), SetNameL(), SetNumberL(), SetSendingPage(), iAttachmentResolution, iName, iNumber, iSendingPage, ~CFaxRecipient()

Inherited from CBase:
operator new()

Inherited from CMsvRecipient:
EFailedToSend, ENotYetSent, ESentSuccessfully, Error(), IncreaseRetries(), ResetRetries(), Retries(), SetError(), SetStatus(), Status(), TRecipientStatus, Time()

Construction and destruction

`CFaxRecipient()`

CFaxRecipient();

Description

Default constructor.

`~CFaxRecipient()`

~CFaxRecipient();

Description

Destructor.

Member Functions

`ExternalizeL()`

void ExternalizeL(RWriteStream& aWriteStream) const;

Description

Externalises the object to a write stream.

Parameters

RWriteStream& aWriteStream

Stream to which the object should be externalised.

`InternalizeL()`

void InternalizeL(RReadStream& aReadStream);

Description

Internalises the object from a read stream.

Parameters

RReadStream& aReadStream

Stream from which the object should be internalised.

`Name()`

TPtrC Name() const;

Description

Gets the recipient's name.

Return value


TPtrC

Recipient's name

`SetNameL()`

void SetNameL(const TDesC&);

Description

Sets the recipient's name.

Parameters

const TDesC&

Recipient's name

`Number()`

TPtrC8 Number() const;

Description

Gets the recipient's number.

Return value


TPtrC8

Recipient's number

`SetNumberL()`

void SetNumberL(const TDesC8&);

Description

Sets the recipient's number.

Parameters

const TDesC8&

Recipient's number

`SendingPage()`

inline TInt16 SendingPage() const;

Description

Gets the number of the page being currently sent.

Return value


TInt16

Number of the page being currently sent

`SetSendingPage()`

inline void SetSendingPage(TInt16 aPage);

Description

Sets the number of the page being currently sent.

Parameters

TInt16 aPage

Number of the page being currently sent