EPOC   SDK Home Glossary Indexes Previous Next Up

TFaxSettings class


Contents


TFaxSettings class — Fax configuration information

Section Contents


Overview

Defined in

faxset.h

Link against

faxcli.lib

Description

This class contains persistent information applicable to all fax sessions.


Stream persistence

The TFaxSettings class provides ExternalizeL() and InternalizeL() functions to implement stream-level persistence. These may be used in their explicit form or through templated insertion operators << or >>. These functions and operators should be used as described in Externalising and internalising.


ExternalizeL() — Externalise

void ExternalizeL(RWriteStream &aStream) const;

Description

This function externalises the TFaxSettings object to a write stream. See Externalising for the standard ExternalizeL() protocol. The presence of this function means that the standard templated operator<<() (defined in s32strm.h) is available to externalise objects of this class.

Arguments

RwriteStream &aStream

The stream to which the object should be externalised.

Leave considerations

This function may leave, if the write action causes an out of memory error.


InternalizeL() — Internalise

void InternalizeL(RReadStream &aStream);

Description

This function to internalises the TFaxSettings object from a read stream. See Internalising for the standard InternalizeL() protocol. The presence of this function means that the standard templated operator>>() (defined in s32strm.h) is available to internalise objects of this class.

Arguments

RReadStream &aStream

The stream from which the object should be internalised.

Notes

Assignment operator


operator=() — Assignment to a TFaxSettings

TFaxSettings& operator=(const TFaxSettings& aFaxSettings);

Description

This assignment operator copies the content of one TFaxSettings into another, replacing the existing content.

Arguments

const TFaxSettings& aFaxSettings

A reference to the TFaxSettings to be copied.

Return value

TFaxSettings&

A reference to this TFaxSettings.


Data members

TFaxClass iFaxClass

The fax class.

TBuf8 < 20 > iFaxId

The local Fax ID string, which must be exactly 20 characters, with only 0-9, space, and + permissible for exact conformance with ITU T.30.

TInt iFaxOnDemandDelay

The delay between dialling and receiving from a faxback service (seconds).

TInt iMaxSpeed

Maximum speed of fax session in bps.

TInt iMinSpeed

Minimum speed of fax session in bps.

TFaxCompression iPreferredCompression

Preferred compression.

TInt iPreferredECM

Preferred error correction mode. Reserved for future use.

TFaxResolution iPreferredResolution

Preferred resolution

TInt iVerbose

Switches fax logging on or off. This must be left on.

EPOC       SDK Home Glossary Indexes Previous Next Up