EPOC   SDK Home Glossary Indexes Previous Next Up

CReadFaxPages class


Contents


CReadFaxPages class — Read a page from a fax file stream

Section Contents


Overview

Derivation

CBase

Abstract: CBase behaviour.

Defined in

faxstore.h

Link against

faxst2.lib

Description

Objects of this class are created by CReadFaxFile, and used to read 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.

For more information about creating fax files see Reading a fax file and Using CReadFaxFile.


Construction and destruction


NewL() — Static constructor for a CReadFaxPages object

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

Description

This static constructor 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.

Arguments

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.

Notes

~CReadFaxPages() — Destructor

~CReadFaxPages();

Description

The destructor closes the stream, and frees all resources owned by the object, prior to its destruction.


Member functions


NumPages() — Get the number of pages in the fax store

TInt NumPages() const;

Description

This function returns the number of pages in the store.

Return value

TInt

The number of fax pages in the store.


SetPageL() — Set current page

void SetPageL(TInt aNum);

Description

This function sets a selected page to be the current page, and resets the current scan line to the first scan line in the page.

Arguments

TInt aNum

The number of the new page.


CurrentPageInfo() — Get the information for the current fax page

TFaxPageInfo CurrentPageInfo() const;

Description

This function returns 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


SeekScanLineL() — Seek scan line

void SeekScanLineL(TInt anIndex);

Description

This function sets the specified scan line as the current scan line.

Arguments

TInt anIndex

The index of the scan line.


GetScanLineL() — Get scan line

TInt GetScanLineL(TDes8& aScanLine);

Description

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

Arguments

TDes8& aScanLine

On return, contains the scan line.

Return value

TInt

An error code: see System error codes.

Note

GetEncodedScanLineL() — Get encoded scan line

void GetEncodedScanLineL(TDes8& anEncodedScanLine);

Description

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

Arguments

TDes8& anEncodedScanLine

On return, contains the encoded scan line.

EPOC       SDK Home Glossary Indexes Previous Next Up