Collapse all Symbian^3 Application Developer Library

CReadFaxFile Class Reference

class CReadFaxFile : public CBase

Opens 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.

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

Inherits from

CReadFaxFile
- CBase

Public Member Functions
	~CReadFaxFile ()
IMPORT_C void	Close ()
IMPORT_C CReadFaxFile *	NewL ()
IMPORT_C void	OpenL (const TDesC &)

Protected Member Functions
	CReadFaxFile ()
void	ConstructL ()
void	DoOpenL (const TDesC &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Attributes
CReadFaxPages *	iReadFaxPages

Private Attributes
CDirectFileStore *	iFileStore
RFs	iFs

Constructor & Destructor Documentation

CReadFaxFile()

CReadFaxFile

(

)

[protected]

~CReadFaxFile()

IMPORT_C

~CReadFaxFile

(

)

Destructor.

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

Member Functions Documentation

Close()

IMPORT_C void

(

)

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.

capability: None

ConstructL()

void

ConstructL

(

)

[protected]

DoOpenL(const TDesC &)

void

DoOpenL

(

const TDesC &

aFileName

)

[protected]

Parameters

const TDesC & aFileName

NewL()

IMPORT_C CReadFaxFile *

NewL

(

)

[static]

Constructs a CReadFaxFile object, which offers the public API for opening a fax file for reading.

As part of the construction process, the object starts a session with the file server.

capability: None

OpenL(const TDesC &)

IMPORT_C void

OpenL

(

const TDesC &

aFileName

)

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.

capability: None

Parameters

const TDesC & aFileName

The name of the fax file.

Member Data Documentation

CDirectFileStore * iFileStore

CDirectFileStore *

iFileStore

[private]

RFs iFs

RFs

iFs

[private]

CReadFaxPages * iReadFaxPages

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.