![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
CBase |
Abstract: CBase behaviour. |
faxstore.h
faxst2.lib
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.
static CReadFaxPages* NewL(CStreamStore& aStore,TStreamId aStreamId);
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.
CStreamStore& aStore |
The store from which fax pages are to be read. |
TStreamId aStreamId |
The root ID of the stream store. |
A pointer to the newly created object. |
~CReadFaxPages();
The destructor closes the stream, and frees all resources owned by the object, prior to its destruction.
TInt NumPages() const;
This function returns the number of pages in the store.
TInt |
The number of fax pages in the store. |
void SetPageL(TInt aNum);
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.
TInt aNum |
The number of the new page. |
TFaxPageInfo CurrentPageInfo() const;
This function returns the information for the current fax page, where the current page was set in a previous call to the SetPageL() function.
The information for the current fax page |
void SeekScanLineL(TInt anIndex);
This function sets the specified scan line as the current scan line.
TInt anIndex |
The index of the scan line. |
TInt GetScanLineL(TDes8& aScanLine);
This function retrieves the raw scan line specified in a previous call to the SeekScanLineL() function.
TDes8& aScanLine |
On return, contains the scan line. |
TInt |
An error code: see System error codes. |
void GetEncodedScanLineL(TDes8& anEncodedScanLine);
This function retrieves the encoded scan line specified in a previous call to the SeekScanLineL() function.
TDes8& anEncodedScanLine |
On return, contains the encoded scan line. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |