EPOC   SDK Home Glossary Indexes Previous Next Up

CReadFaxFile class


Contents


CReadFaxFile class — Open a fax file for reading

Section Contents


Overview

Derivation

CBase

Abstract: CBase behaviour.

Defined in

faxstore.h

Link against

faxst2.lib

Description

This class is used to open a fax file for reading.

The class provides the functionality to open and close a fax file. The ability to read individual fax pages is provided by the CReadFaxPages data member, which is created when the file is opened.

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


Construction and destruction


NewL() — Static constructor for a CReadFaxFile object

static CReadFaxFile* NewL();

Description

This function constructs a CReadFaxFile object, which offers the public API for opening a fax file for reading.

Return value

CReadFaxFile*

A pointer to the newly created object.

Note

~CReadFaxFile() — Destructor

~CReadFaxFile();

Description

The destructor closes the session with the file server, and frees all resources owned by the object, prior to its destruction.


Member functions


OpenL() — Open a fax file for reading

void OpenL(const TDesC& aFileName);

Description

This function opens a fax file for reading.

The function also allocates memory to create a CReadFaxPages object — which is pointed to by the iReadFaxPages class data member. This class defines the API for reading individual pages from the file store.

Fax files which have been opened should be paired with a Close() function.

Arguments

const TDesC& aFileName

The name of the fax file.


Close() — Close fax file

void Close();

Description

This function closes the fax file, and deletes the resources owned by the object.

Although this function is called in the destructor, it is good programming practice to invoke it manually to pair previous OpenL() calls.


Data members

CReadFaxPages* iReadFaxPages

A pointer to the object which can be used to access the fax pages stored in the file. Memory is allocated for the object when the fax file is opened.

EPOC       SDK Home Glossary Indexes Previous Next Up