Class CReadFaxPages

CReadFaxPages

Support

Supported from 5.0

Description

Reads individual pages from a fax file.

The class provides functions to get the number of fax pages in a fax store, the number of scan lines per page, information about the scan line compression and resolution, and the sender Id. It is then possible to iterate through the store by page and by scan line to obtain the fax page.

In pre-v5.1 releases of Symbian OS, the import library was faxst2.lib.

Derivation

CBase Base class for all classes to be instantiated on the heap CReadFaxPages Reads individual pages from a fax file

Defined in CReadFaxPages:
CurrentPageInfo(), GetEncodedScanLineL(), GetScanLineL(), NewL(), NumPages(), SeekScanLineL(), SetPageL(), ~CReadFaxPages()

Inherited from CBase:
operator new()

See also:

• Using CReadFaxFile

static CReadFaxPages* NewL(CStreamStore& aStore,TStreamId aStreamId);

Description

Creates a CReadFaxPages object, which offers the public API for reading fax pages from a stream store.

This function is called by CReadFaxFile when opening a fax file.

Parameters

CStreamStore& aStore The store from which fax pages are to be read. TStreamId aStreamId The root ID of the stream store.

Return value

CReadFaxPages* A pointer to the newly created object.

Leave codes

KErrNoMemory There is insufficient memory to perform the operation.

~CReadFaxPages();

Description

Destructor

Closes the stream, and frees all resources owned by the object, prior to its destruction.

TInt NumPages() const;

Description

Gets the number of pages in the store.

Return value

TInt The number of fax pages in the store.

void SetPageL(TInt aNum);

Description

Sets a selected page to be the current page, and resets the current scan line to the first scan line in the page.

Parameters

TInt aNum The number of the new page.

TFaxPageInfo CurrentPageInfo() const;

Description

Gets the information for the current fax page, where the current page was set in a previous call to the SetPageL() function.

Return value

TFaxPageInfo The information for the current fax page

void SeekScanLineL(TInt anIndex);

Description

Sets the specified scan line as the current scan line.

Parameters

TInt anIndex The index of the scan line.

TInt GetScanLineL(TDes8& aScanLine);

Description

Gets the raw scan line specified in a previous call to the SeekScanLineL() function.

Parameters

TDes8& aScanLine On return, contains the scan line.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

Notes:

• The scan line is stored in compressed form, but is retrieved by this function in raw form — for viewing.

void GetEncodedScanLineL(TDes8& anEncodedScanLine);

Description

Gets the encoded scan line specified in a previous call to the SeekScanLineL() function.

Parameters

TDes8& anEncodedScanLine On return, contains the encoded scan line.