CFileBase Class Reference

#include <f32file.h>

class CFileBase : public CBase

Inherits from

CFileBase
- CBase

Protected Attributes
TInt	iCurrentEntry
CDir *	iDirList
TFileManError	iErrorInfo
RThread	iFManThread
RFs	iFs
RFs	iFsOld
TInt	iLastError
TUint	iMatchEntry
TInt	iNumberOfFilesProcessed
MFileManObserver *	iObserver
CDirScan *	iScanner
HBufC *	iSessionPath
TParse	iSrcFile
TRequestStatus *	iStatus
TUint	iSwitches
RSemaphore	iSynchronizer

Public Member Functions
IMPORT_C TPtrC	AbbreviatedPath()
IMPORT_C const TEntry &	CurrentEntry()
IMPORT_C TPtrC	FullPath()
IMPORT_C TInt	GetLastError()
IMPORT_C TFileManError	GetMoreInfoAboutError()
IMPORT_C void	SetObserver(MFileManObserver *)

Protected Member Functions
	CFileBase(RFs &)
	~CFileBase()
virtual void	CompleteOperationL()
IMPORT_C void	ConstructL()
pure virtual void	DoOperationL()
IMPORT_C void	RunInSeparateThreadL(TThreadFunction)
IMPORT_C void	RunL()

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()

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.

Member Attribute Documentation

iCurrentEntry

TInt

iCurrentEntry

[protected]

iDirList

CDir *

iDirList

[protected]

iErrorInfo

TFileManError

iErrorInfo

[protected]

iFManThread

RThread

iFManThread

[protected]

iFs

RFs

iFs

[protected]

iFsOld

RFs

iFsOld

[protected]

iLastError

TInt

iLastError

[protected]

iMatchEntry

TUint

iMatchEntry

[protected]

iNumberOfFilesProcessed

TInt

iNumberOfFilesProcessed

[protected]

iObserver

MFileManObserver *

iObserver

[protected]

iScanner

CDirScan *

iScanner

[protected]

iSessionPath

HBufC *

iSessionPath

[protected]

iSrcFile

TParse

iSrcFile

[protected]

iStatus

TRequestStatus *

iStatus

[protected]

iSwitches

TUint

iSwitches

[protected]

iSynchronizer

RSemaphore

iSynchronizer

[protected]

Constructor & Destructor Documentation

CFileBase ( RFs & )

IMPORT_C

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.

~CFileBase ( )

IMPORT_C

~CFileBase

(

)

[protected]

Destructor.

Frees resources prior to destruction of the object.

Member Function Documentation

AbbreviatedPath ( )

IMPORT_C TPtrC

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.

Return Value: The abbreviated path.

CompleteOperationL ( )

void

CompleteOperationL

(

)

[protected, inline, virtual]

Called from RunL to perform tidy up after an operation.

ConstructL ( )

IMPORT_C void

ConstructL

(

)

[protected]

Second phase constructor.

CurrentEntry ( )

IMPORT_C const TEntry &

CurrentEntry

(

)

Gets the entry currently being processed.

Return Value: Contains the current entry.

DoOperationL ( )

void

DoOperationL

(

)

[protected, pure virtual]

Called from RunL to perform the requested operation.

FullPath ( )

IMPORT_C TPtrC

FullPath

(

)

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

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

Return Value: The full path.

GetLastError ( )

IMPORT_C TInt

GetLastError

(

)

Gets the latest error code returned during a CFileMan operation.

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

Return Value: KErrNone, or another error code that might have been returned by a CFileMan operation.

GetMoreInfoAboutError ( )

IMPORT_C TFileManError

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().

See also: CFileMan CFileBase::GetLastError()

Return Value: The extra information about the last CFileMan error.

RunInSeparateThreadL ( TThreadFunction )

IMPORT_C void

RunInSeparateThreadL

(

TThreadFunction

aThreadFunction

)

[protected]

Creates a separate thread to run the command.

Parameters
aThreadFunction	The thread function.

RunL ( )

IMPORT_C void

RunL

(

)

[protected]

Executes a command.

Capability
Dependent	the capabilities required by this method, of the abstract class

SetObserver ( MFileManObserver * )

IMPORT_C void

SetObserver

(

MFileManObserver *

anObserver

)

Sets the observer.

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