Abstract base class for file management. More...

#include <f32file.h>

Inheritance diagram for CFileBase:

Public Member Functions
IMPORT_C void	SetObserver (MFileManObserver *anObserver)
	Sets the observer.

IMPORT_C const TEntry &	CurrentEntry ()
	Gets the entry currently being processed.

IMPORT_C TPtrC	AbbreviatedPath ()
	Gets the abbreviated path of the file or directory currently being processed.

IMPORT_C TPtrC	FullPath ()
	Gets the full path of the file or directory currently being processed.

IMPORT_C TInt	GetLastError ()
	Gets the latest error code returned during a CFileMan operation.

IMPORT_C TFileManError	GetMoreInfoAboutError ()
	Gets additional information about the latest error returned during a CFileMan operation.

Public Member Functions inherited from CBase
	CBase ()
	Default constructor.

virtual IMPORT_C	~CBase ()
	Virtual destructor.

TAny *	operator new (TUint aSize, TAny *aBase) __NO_THROW
	Initialises the object to binary zeroes.

TAny *	operator new (TUint aSize) __NO_THROW
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TLeave)
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TUint aExtraSize) __NO_THROW
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TLeave, TUint aExtraSize)
	Allocates the object from the heap and then initialises its contents to binary zeroes.

Protected Member Functions
IMPORT_C	CFileBase (RFs &anFs)
	Protected default constructor.

IMPORT_C void	ConstructL ()
	Second phase constructor.

IMPORT_C	~CFileBase ()
	Destructor.

IMPORT_C void	RunL ()
	Executes a command.

IMPORT_C void	RunInSeparateThreadL (TThreadFunction aThreadFunction)
	Creates a separate thread to run the command.

virtual void	CompleteOperationL ()
	Called from RunL to perform tidy up after an operation.

virtual void	DoOperationL ()=0
	Called from RunL to perform the requested operation.

Protected Member Functions inherited from CBase
virtual IMPORT_C TInt	Extension_ (TUint aExtensionId, TAny &a0, TAny a1)
	Extension function.

Protected Attributes
RFs	iFs

RFs	iFsOld

RThread	iFManThread

RSemaphore	iSynchronizer

CDirScan *	iScanner

CDir *	iDirList

TInt	iCurrentEntry

TUint	iMatchEntry

TUint	iSwitches

TParse	iSrcFile

MFileManObserver *	iObserver

TInt	iLastError

TFileManError	iErrorInfo

TRequestStatus *	iStatus

HBufC *	iSessionPath

TInt	iNumberOfFilesProcessed

Friends
void	DoFManBaseOperationL (TAny *aPtr)

TInt	FManBaseThreadFunction (TAny *aPtr)

Additional Inherited Members
Static Public Member Functions inherited from CBase
static IMPORT_C void	Delete (CBase *aPtr)
	Deletes the specified object.

Detailed Description

Abstract base class for file management.

It provides functions to set an observer for the derived class CFileMan, and to get information about the entry being processed.

See also: CFileMan

API status: Published to all clients. Released API.

Definition at line 2886 of file f32file.h.

Constructor & Destructor Documentation

◆ CFileBase()

IMPORT_C CFileBase::CFileBase ( RFs & anFs )

protected

Protected default constructor.

Note that the class is intended only as an abstract base for other classes.

Parameters

anFs	File server session.

(generated from Symbian Developer Library)

◆ ~CFileBase()

IMPORT_C CFileBase::~CFileBase ( )

protected

Destructor.

Frees resources prior to destruction of the object.

(generated from Symbian Developer Library)

Member Function Documentation

◆ AbbreviatedPath()

IMPORT_C TPtrC CFileBase::AbbreviatedPath ( )

Gets the abbreviated path of the file or directory currently being processed.

The abbreviated path is its path relative to the top level directory specified in the operation.

(generated from Symbian Developer Library)

◆ CompleteOperationL()

virtual void CFileBase::CompleteOperationL ( )

inlineprotectedvirtual

Called from RunL to perform tidy up after an operation.

See also: CFileMan; CFileBase::RunL

Definition at line 2922 of file f32file.h.

◆ ConstructL()

IMPORT_C void CFileBase::ConstructL ( )

protected

Second phase constructor.

(generated from Symbian Developer Library)

◆ CurrentEntry()

IMPORT_C const TEntry & CFileBase::CurrentEntry ( )

Gets the entry currently being processed.

(generated from Symbian Developer Library)

◆ DoOperationL()

virtual void CFileBase::DoOperationL ( )

protectedpure virtual

Called from RunL to perform the requested operation.

See also: CFileMan; CFileBase::RunL

◆ FullPath()

IMPORT_C TPtrC CFileBase::FullPath ( )

Gets the full path of the file or directory currently being processed.

The full path includes the drive letter, path and filename.

(generated from Symbian Developer Library)

◆ GetLastError()

IMPORT_C TInt CFileBase::GetLastError ( )

Gets the latest error code returned during a CFileMan operation.

This function may be called from MFileManObserver::NotifyFileManEnded().

(generated from Symbian Developer Library)

◆ GetMoreInfoAboutError()

IMPORT_C TFileManError CFileBase::GetMoreInfoAboutError ( )

Gets additional information about the latest error returned during a CFileMan operation.

For example, if a rename fails, this function can be used to report whether the source or target name caused the problem. This information supplements that provided GetLastError().

CFileMan CFileBase::GetLastError()

(generated from Symbian Developer Library)

◆ RunInSeparateThreadL()

IMPORT_C void CFileBase::RunInSeparateThreadL ( TThreadFunction aThreadFunction )

protected

Creates a separate thread to run the command.

Parameters

aThreadFunction The thread function.

(generated from Symbian Developer Library)

◆ RunL()

IMPORT_C void CFileBase::RunL ( )

protected

Executes a command.

capability: Dependent the capabilities required by this method, of the abstract class CFileBase, will be dependent on and provided by the concrete-class implementation of the DoOperationL method

(generated from Symbian Developer Library)

◆ SetObserver()

IMPORT_C void CFileBase::SetObserver ( MFileManObserver * anObserver )

Sets the observer.

Use this function to provide CFileMan with an MFileManObserver, or, if one already exists, to change the observer.

CFileMan MFileManObserver

Parameters

anObserver File management observer.

(generated from Symbian Developer Library)

Friends And Related Symbol Documentation

◆ DoFManBaseOperationL

void DoFManBaseOperationL ( TAny * aPtr )

friend

◆ FManBaseThreadFunction

TInt FManBaseThreadFunction ( TAny * aPtr )

friend

Member Data Documentation

◆ iCurrentEntry

TInt CFileBase::iCurrentEntry

protected

Definition at line 2939 of file f32file.h.

◆ iDirList

CDir* CFileBase::iDirList

protected

Definition at line 2938 of file f32file.h.

◆ iErrorInfo

TFileManError CFileBase::iErrorInfo

protected

Definition at line 2945 of file f32file.h.

◆ iFManThread

RThread CFileBase::iFManThread

protected

Definition at line 2935 of file f32file.h.

◆ iFs

RFs CFileBase::iFs

protected

Definition at line 2933 of file f32file.h.

◆ iFsOld

RFs CFileBase::iFsOld

protected

Definition at line 2934 of file f32file.h.

◆ iLastError

TInt CFileBase::iLastError

protected

Definition at line 2944 of file f32file.h.

◆ iMatchEntry

TUint CFileBase::iMatchEntry

protected

Definition at line 2940 of file f32file.h.

◆ iNumberOfFilesProcessed

TInt CFileBase::iNumberOfFilesProcessed

protected

Definition at line 2948 of file f32file.h.

◆ iObserver

MFileManObserver* CFileBase::iObserver

protected

Definition at line 2943 of file f32file.h.

◆ iScanner

CDirScan* CFileBase::iScanner

protected

Definition at line 2937 of file f32file.h.

◆ iSessionPath

HBufC* CFileBase::iSessionPath

protected

Definition at line 2947 of file f32file.h.

◆ iSrcFile

TParse CFileBase::iSrcFile

protected

Definition at line 2942 of file f32file.h.

◆ iStatus

TRequestStatus* CFileBase::iStatus

protected

Definition at line 2946 of file f32file.h.

◆ iSwitches

TUint CFileBase::iSwitches

protected

Definition at line 2941 of file f32file.h.

◆ iSynchronizer

RSemaphore CFileBase::iSynchronizer

protected

Definition at line 2936 of file f32file.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CFileBase()

◆ ~CFileBase()

Member Function Documentation

◆ AbbreviatedPath()

◆ CompleteOperationL()

◆ ConstructL()

◆ CurrentEntry()

◆ DoOperationL()

◆ FullPath()

◆ GetLastError()

◆ GetMoreInfoAboutError()

◆ RunInSeparateThreadL()

◆ RunL()

◆ SetObserver()

Friends And Related Symbol Documentation

◆ DoFManBaseOperationL

◆ FManBaseThreadFunction

Member Data Documentation

◆ iCurrentEntry

◆ iDirList

◆ iErrorInfo

◆ iFManThread

◆ iFs

◆ iFsOld

◆ iLastError

◆ iMatchEntry

◆ iNumberOfFilesProcessed

◆ iObserver

◆ iScanner

◆ iSessionPath

◆ iSrcFile

◆ iStatus

◆ iSwitches

◆ iSynchronizer