Class CFileBase

class CFileBase : public CBase;

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.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CFileBase - Abstract base class for file management

Members

Defined in CFileBase:

• AbbreviatedPath()Gets the abbreviated path of the file or directory currently being processed
• CFileBase()Protected default constructor
• CompleteOperationL()Called from RunL to perform tidy up after an operation
• ConstructL()Second phase constructor
• CurrentEntry()Gets the entry currently being processed
• DoOperationL()Called from RunL to perform the requested operation
• FullPath()Gets the full path of the file or directory currently being processed
• GetLastError()Gets the latest error code returned during a CFileMan operation
• GetMoreInfoAboutError()Gets additional information about the latest error returned during a CFileMan operation
• RunInSeparateThreadL()Creates a separate thread to run the command
• RunL()Executes a command
• SetObserver()Sets the observer
• iCurrentEntry
• iDirList
• iErrorInfo
• iFManThread
• iFs
• iFsOld
• iLastError
• iMatchEntry
• iNumberOfFilesProcessed
• iObserver
• iScanner
• iSessionPath
• iSrcFile
• iStatus
• iSwitches
• iSynchronizer
• ~CFileBase()Destructor

Inherited from CBase:

• Delete()Deletes the specified object
• Extension_()Extension function
• operator new()Initialises the object to binary zeroes

See also:

• CFileManOffers file management services which accept the use of wildcards; synchronous and asynchronous

protected: IMPORT_C CFileBase(RFs &anFs);

Description

Protected default constructor.

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

Parameters

protected: IMPORT_C void ConstructL();

Description

Second phase constructor.

protected: IMPORT_C ~CFileBase();

Description

Destructor.

Frees resources prior to destruction of the object.

IMPORT_C void SetObserver(MFileManObserver *anObserver);

Description

Sets the observer.

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

Parameters

See also:

• CFileManOffers file management services which accept the use of wildcards; synchronous and asynchronous
• MFileManObserverProvides notification of the progress of synchronous or asynchronous file management operations

IMPORT_C const TEntry &CurrentEntry();

Description

Gets the entry currently being processed.

Return value

IMPORT_C TPtrC AbbreviatedPath();

Description

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

IMPORT_C TPtrC FullPath();

Description

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

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

Return value

IMPORT_C TInt GetLastError();

Description

Gets the latest error code returned during a CFileMan operation.

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

Return value

IMPORT_C TFileManError GetMoreInfoAboutError();

Description

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

Return value

See also:

• CFileManOffers file management services which accept the use of wildcards; synchronous and asynchronous
• CFileBase::GetLastError()Gets the latest error code returned during a CFileMan operation

protected: IMPORT_C void RunL();

Description

Executes a command.

protected: IMPORT_C void RunInSeparateThreadL(TThreadFunction aThreadFunction);

Description

Creates a separate thread to run the command.

Parameters

protected: inline virtual void CompleteOperationL();

Description

Called from RunL to perform tidy up after an operation.

See also:

• CFileManOffers file management services which accept the use of wildcards; synchronous and asynchronous

protected: virtual void DoOperationL()=0;

Description

Called from RunL to perform the requested operation.

See also:

• CFileManOffers file management services which accept the use of wildcards; synchronous and asynchronous

protected: RFs iFs;

Description

protected: RFs iFsOld;

Description

protected: RThread iFManThread;

Description

protected: RSemaphore iSynchronizer;

Description

protected: CDirScan * iScanner;

Description

protected: CDir * iDirList;

Description

protected: TInt iCurrentEntry;

Description

protected: TUint iMatchEntry;

Description

protected: TUint iSwitches;

Description

protected: TParse iSrcFile;

Description

protected: MFileManObserver * iObserver;

Description

protected: TInt iLastError;

Description

protected: TFileManError iErrorInfo;

Description

protected: TRequestStatus * iStatus;

Description

protected: HBufC * iSessionPath;

Description

protected: TInt iNumberOfFilesProcessed;

Description