Symbian
 Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]



Location: faxset.h
Link against: faxcli.lib

Class TFaxSettings

TFaxSettings

Support

Supported from 5.0

Description

Fax configuration information

Contains persistent information applicable to all fax sessions.

Defined in TFaxSettings:
ExternalizeL(), InternalizeL(), iFaxClass, iFaxId, iFaxOnDemandDelay, iMaxSpeed, iMinSpeed, iPreferredCompression, iPreferredECM, iPreferredResolution, iVerbose, operator=()


Stream persistence

Description

Provides ExternalizeL() and InternalizeL() functions to implement stream-level persistence. These may be used in their explicit form or through templated insertion operators << or >>.


ExternalizeL()

void ExternalizeL(RWriteStream &aStream) const;

Description

Externalise

Externalises the TFaxSettings object to a write stream. The presence of this function means that the standard templated operator<<() (defined in s32strm.h) is available to externalise objects of this class.

Parameters

RWriteStream &aStream

The stream to which the object should be externalised.


InternalizeL()

void InternalizeL(RReadStream &aStream);

Description

Internalise

Internalises the TFaxSettings object from a read stream. The presence of this function means that the standard templated operator>>() (defined in s32strm.h) is available to internalise objects of this class.

Parameters

RReadStream &aStream

The stream from which the object should be internalised.

Notes:

[Top]


Assignment operator


operator=()

TFaxSettings& operator=(const TFaxSettings& aFaxSettings);

Description

Assignment operator

Copies the content of one TFaxSettings into another, replacing the existing content.

Parameters

const TFaxSettings& aFaxSettings

A reference to the TFaxSettings to be copied.

Return value

TFaxSettings&

A reference to this TFaxSettings.

[Top]


Data members

Description

Note that 2D compression and ECM are not available in the v5 fax engine.


iFaxClass

TFaxClass iFaxClass

Description

The fax class.


iFaxId

TBuf8<20> iFaxId

Description

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.


iFaxOnDemandDelay

TInt iFaxOnDemandDelay

Description

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


iMaxSpeed

TInt iMaxSpeed

Description

Maximum speed of fax session in bps.


iMinSpeed

TInt iMinSpeed

Description

Minimum speed of fax session in bps.


iPreferredCompression

TFaxCompression iPreferredCompression

Description

Preferred compression.


iPreferredECM

TInt iPreferredECM

Description

If 1, use error correction mode (ECM), else 0


iPreferredResolution

TFaxResolution iPreferredResolution

Description

Preferred resolution


iVerbose

TInt iVerbose

Description

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