Class CFileMan

class CFileMan : public CFileBase;

Description

Offers file management services which accept the use of wildcards; synchronous and asynchronous.

It also provides enquiry functions, which, like those provided by the base class CFileBase, may be used by an observer class object to provide the user with information about the progress of the operation.

All of the file management functions provided by this class accept the use of wildcards, and may operate either synchronously or asynchronously. When CFileMan is operating asynchronously, the operation takes place in a separate thread from the calling code.

A file notification observer (an instance of a class deriving from MFileManObserver) may optionally be used by CFileMan when operating synchronously or asynchronously. If provided, the appropriate notification function is called before or after each entry has been processed, or during a file copy or move. This notification can be used to provide information about the state of the operation, such as the number of bytes transferred during a large-scale file copy. It can also be used to allow the user to cancel, retry or continue processing an entry, or to abort the whole operation. If such notification is required, specify an object deriving from MFileManObserver class in the constructor, or call SetObserver(), defined in the base class, CFileBase.

All of the file manipulation functions except Rename() may operate recursively, and all can operate non-recursively. When operating recursively, these functions will act on all matching files located throughout the source directory’s hierarchy. When operating non-recursively, these functions act upon files contained in the single top level source directory only. Recursion is set or unset using the switch parameter to these functions.

This class is not intended for user derivation.

Derivation

• CBase - Base class for all classes to be instantiated on the heap
• CFileBase - Abstract base class for file management
• CFileMan - Offers file management services which accept the use of wildcards; synchronous and asynchronous

Members

Defined in CFileMan:
Attribs(), Attribs(), BytesTransferredByCopyStep(), Copy(), Copy(), Copy(), Copy(), CurrentAction(), Delete(), Delete(), EAttribs, ECopy, ECopyFromHandle, EDelete, EMove, ENone, EOverWrite, ERecurse, ERename, ERenameInvalidEntry, ERmDir, GetCurrentSource(), GetCurrentTarget(), Move(), Move(), NewL(), NewL(), Rename(), Rename(), RmDir(), RmDir(), TAction, TSwitch

Inherited from CBase:
Extension_(), operator new()

Inherited from CFileBase:
AbbreviatedPath(), CompleteOperationL(), ConstructL(), CurrentEntry(), DoOperationL(), FullPath(), GetLastError(), GetMoreInfoAboutError(), RunInSeparateThreadL(), RunL(), SetObserver(), iCurrentEntry, iDirList, iErrorInfo, iFManThread, iFs, iFsOld, iLastError, iMatchEntry, iNumberOfFilesProcessed, iObserver, iScanner, iSessionPath, iSrcFile, iStatus, iSwitches, iSynchronizer

See also:

• MFileManObserver

static IMPORT_C CFileMan *NewL(RFs &aFs);

Description

Constructs and allocates memory for a new CFileMan object.

Parameters

RFs &aFs File server session.

Return value

CFileMan * Newly created CFileMan object.

static IMPORT_C CFileMan *NewL(RFs &aFs, MFileManObserver *anObserver);

Description

Constructs and allocates memory for a new CFileMan object with an observer.

Parameters

RFs &aFs File server session. MFileManObserver *anObserver File management observer.

Return value

CFileMan * Newly created CFileMan object.

IMPORT_C TAction CurrentAction();

Description

Gets the action which CFileMan is currently carrying out.

Return value

TAction The action which CFileMan is carrying out.

IMPORT_C void GetCurrentTarget(TFileName &aFile);

Description

Gets the name of the target file for the CFileMan operation currently being carried out.

This function is relevant when copying, moving or renaming files.

Parameters

TFileName &aFile The full path and filename of the target file for the current CFileMan operation

IMPORT_C void GetCurrentSource(TFileName &aFile);

Description

Gets the name of the source file or directory for the CFileMan operation currently being carried out.

The source is the file or directory which is being copied, moved or deleted.

Parameters

TFileName &aFile The full path and filename of the source file for the current CFileMan operation.

IMPORT_C TInt BytesTransferredByCopyStep();

Description

Gets the number of bytes transferred during a copy or move operation.

Large files are copied and moved in stages. After each portion of the source file has been copied to the target, the number of bytes transferred is updated. This function may be called from MFileManObserver::NotifyFileManOperation() and may be used to support the increment of progress bars.

Return value

TInt The number of bytes transferred.

Capability:

Dependent

If aName is /Sys then Tcb capability is required. If aName begins with /Private and does not match this process' SID then AllFiles capability is required. If aName is /Resource then Tcb capability is required.

IMPORT_C TInt Attribs(const TDesC &aName, TUint aSetMask, TUint aClearMask, const TTime &aTime, TUint aSwitch=0);

Description

Sets or clears attributes for one or more files using two bitmasks

This is a synchronous function.

The first bitmask specifies the attributes to be set. The second specifies the attributes to be cleared. The date and time of the files' last modification can also be changed.

The function can operate recursively or non-recursively. When operating non-recursively, only the matching files located in the directory specified in aName are affected. When operating recursively, all matching files in the directory hierarchy below the directory specified in aName will be affected.

Notes:

1. A panic is raised if any attribute is specified in both bitmasks.

2. Attempting to change the attributes for an open file results in an error for that file, as retrieved by CFileBase::GetLastError().

3. An attempt to set or clear the KEntryAttDir or KEntryAttVolume attribute for a file or directory will have no effect.

Parameters

const TDesC &aName Path indicating the file(s) whose attributes are to be changed. Any path components which are not specified here will be taken from the session path. Use wildcards to specify more than one file. TUint aSetMask Bitmask indicating the attributes to be set. TUint aClearMask Bitmask indicating the attributes to be cleared. For more information, see KEntryAttNormal and the other file/directory attributes. const TTime &aTime Contains the new modification date and time for the files, in UTC. To preserve the file's timestamps, specify a TTime value of 0. TUint aSwitch Specify zero for no recursion; CFileMan::ERecurse for recursion. By default, the synchronous variant of this function operates non-recursively.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

Capability:

Dependent

If aName is /Sys then Tcb capability is required. If aName begins with /Private and does not match this process' SID then AllFiles capability is required. If aName is /Resource then Tcb capability is required.

IMPORT_C TInt Attribs(const TDesC &aName, TUint aSetMask, TUint aClearMask, const TTime &aTime, TUint aSwitch, TRequestStatus &aStatus);

Description

Sets or clears attributes for one or more files using two bitmasks.

This is an asycnhronous function. Its behaviour is the same as the synchronous overload.

Parameters

const TDesC &aName Path indicating the file(s) whose attributes are to be changed. Any path components which are not specified here will be taken from the session path. Use wildcards to specify more than one file. TUint aSetMask Bitmask indicating the attributes to be set. TUint aClearMask Bitmask indicating the attributes to be cleared. For more information, see KEntryAttNormal and the other file/directory attributes. const TTime &aTime Contains the new modification date and time for the files, in UTC. To preserve the file's timestamps, specify a TTime value of 0. TUint aSwitch Specify zero for no recursion; CFileMan::ERecurse for recursion. By default, the synchronous variant of this function operates non-recursively. TRequestStatus &aStatus The request status object. On request completion, indicates how the request completed: KErrNone, if successful, otherwise one of the other system-wide error codes.

Return value

TInt

Capability:	Dependent	If the path for anOld begins with /Sys then Tcb capability is required. If the path for anOld begins with /Resource then Tcb capability is required.
Capability:	AllFiles

IMPORT_C TInt Copy(const TDesC &anOld, const TDesC &aNew, TUint aSwitch=EOverWrite);

Description

Copies one or more files.

This is a synchronous function.

Optionally, this function can be set to overwrite any files with the same name which exist in the target directory. If the flag is set for no overwriting, then any files with the same name will not be overwritten, and an error (KErrAlreadyExists) will be returned for that file. Error codes may be retrieved using CFileBase::GetLastError().

If recursive operation is set, all intermediate directories will be created, including any directories in the path specified by aNew which do not already exist.

If recursive operation is not set, only the matching files located in the single directory specified in anOld are copied. No intermediate directories will be created; if any directories in the destination path do not exist, no files will be copied, and this function will return KErrPathNotFound.

Notes:

1. Files can be copied across drives.

2. Open files can be copied if they have been opened using the EFileShareReadersOnly file share mode.

3. Read-only, hidden and system files can be copied and the source file's attributes are preserved in the target file.

Parameters

const TDesC &anOld Path indicating the file(s) to be copied. Any path components which are not specified here will be taken from the session path. const TDesC &aNew Path indicating the directory into which the file(s) are to be copied. TUint aSwitch Specify zero for no overwriting and no recursion; CFileMan::EOverWrite to overwrite files with the same name; CFileMan::ERecurse for recursion. By default, the synchronous variant of this function operates non-recursively and with overwriting.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

See also:

• CFileBase::GetLastError

Capability:	Dependent	If the path for aNew begins with /Sys then Tcb capability is required. If the path for aNew begins with /Resource then Tcb capability is required.
Capability:	AllFiles

IMPORT_C TInt Copy(const TDesC &anOld, const TDesC &aNew, TUint aSwitch, TRequestStatus &aStatus);

Description

Copies one or more files.

This is an asycnhronous function. Its behaviour is the same as the synchronous overload.

Parameters

const TDesC &anOld Path indicating the file(s) to be copied. Any path components which are not specified here will be taken from the session path. const TDesC &aNew Path indicating the directory into which the file(s) are to be copied. TUint aSwitch Specify zero for no overwriting and no recursion; CFileMan::EOverWrite to overwrite files with the same name; CFileMan::ERecurse for recursion. By default, the synchronous variant of this function operates non-recursively and with overwriting. TRequestStatus &aStatus The request status object. On request completion, indicates how the request completed: KErrNone, if successful, otherwise one of the other system-wide error codes.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

Capability:

Dependent

If aName is /Sys then Tcb capability is required. If aName begins with /Private and does not match this process' SID then AllFiles capability is required. If aName is /Resource then Tcb capability is required.

IMPORT_C TInt Delete(const TDesC &aName, TUint aSwitch=0);

Description

Deletes one or more files.

This is a synchronous function.

This function can operate recursively or non-recursively. When operating non-recursively, only the matching files located in the directory specified in aName are affected. When operating recursively, all matching files in the directory hierarchy below the directory specified in aName will be deleted.

Note that read-only and open files may not be deleted. Attempting to do so will return an error for that file. Error codes may be retrieved using CFileBase::GetLastError().

Parameters

const TDesC &aName Path indicating the file(s) to be deleted. May either be a full path, or relative to the session path. Use wildcards to specify more than one file. TUint aSwitch Specify: zero for no recursion; CFileMan::ERecurse for recursion. By default, the synchronous variant of this function operates non-recursively.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

See also:

• CFileBase::GetLastError

Capability:

Dependent

If aName is /Sys then Tcb capability is required. If aName begins with /Private and does not match this process' SID then AllFiles capability is required. If aName is /Resource then Tcb capability is required.

IMPORT_C TInt Delete(const TDesC &aName, TUint aSwitch, TRequestStatus &aStatus);

Description

Deletes one or more files.

This is an asycnhronous function. Its behaviour is the same as the synchronous overload.

Parameters

const TDesC &aName Path indicating the file(s) to be deleted. May either be a full path, or relative to the session path. Use wildcards to specify more than one file. TUint aSwitch Specify: zero for no recursion; CFileMan::ERecurse for recursion. By default, the synchronous variant of this function operates non-recursively. TRequestStatus &aStatus The request status object. On request completion, indicates how the request completed: KErrNone, if successful, otherwise one of the other system-wide error codes.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

Capability:	Dependent	If the path in aNew starts with /Sys then capability Tcb is required If the path in aNew starts with /Resource then capability Tcb is required If the path in anOld starts with /Sys then Tcb capability is required. If the path in anOld starts with /Resource then Tcb capability is required.
Capability:	AllFiles

IMPORT_C TInt Move(const TDesC &anOld, const TDesC &aNew, TUint aSwitch=EOverWrite);

Description

Moves one or more files.

This is a synchronous function.

Optionally, this function can be set to overwrite any files with the same name which exist in the target directory. If the flag is set for no overwriting, then any files with the same name will not be overwritten, and an error (KErrAlreadyExists) will be returned for that file. Error codes may be retrieved using CFileBase::GetLastError(). By default, when the function is operating synchronously, files are overwritten.

When this function is operating recursively, all intermediate directories will be created, including all directories in the destination path specified by aNew which do not already exist.

If recursive operation is not set, only the matching files located in the single directory specified in anOld are moved. No intermediate directories will be created; if any directories in the destination path do not exist, no files will be moved, and this function will return KErrPathNotFound.

Notes:

1. Read-only, hidden and system files can be moved and the source file's attributes are preserved in the target file, but open files cannot be moved. Attempting to move an open file will return an error for that file, as retrieved by CFileBase::GetLastError().

Parameters

const TDesC &anOld Path indicating the files to be moved. May be either a full path, or relative to the session path. const TDesC &aNew Path indicating the directory into which the file(s) are to be moved. TUint aSwitch Specify zero for no overwriting and no recursion; CFileMan::EOverWrite to overwrite files with the same name; CFileMan::ERecurse for recursion. By default, the synchronous variant of this function operates non-recursively and with overwriting.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

See also:

• CFileBase::GetLastError

Capability:	Dependent	If the path in aNew starts with /Sys then capability Tcb is required If the path in aNew starts with /Resource then capability Tcb is required If the path in anOld starts with /Sys then Tcb capability is required. If the path in anOld starts with /Resource then Tcb capability is required.
Capability:	AllFiles

IMPORT_C TInt Move(const TDesC &anOld, const TDesC &aNew, TUint aSwitch, TRequestStatus &aStatus);

Description

Moves one or more files.

This is an asycnhronous function. Its behaviour is the same as the synchronous overload.

Parameters

const TDesC &anOld Path indicating the files to be moved. May be either a full path, or relative to the session path. const TDesC &aNew Path indicating the directory into which the file(s) are to be moved. TUint aSwitch Specify zero for no overwriting and no recursion; CFileMan::EOverWrite to overwrite files with the same name; CFileMan::ERecurse for recursion. By default, the synchronous variant of this function operates non-recursively and with overwriting. TRequestStatus &aStatus The request status object. On request completion, indicates how the request completed: KErrNone, if successful, otherwise one of the other system-wide error codes.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

Capability:

Dependent

If either aName or aNewName is /Sys then Tcb capability is required. If either aName or aNewName begins with /Private and does not match this process' SID then AllFiles capability is required. If either aName or aNewName is /Resource then Tcb capability is required.

IMPORT_C TInt Rename(const TDesC &anOld, const TDesC &aNew, TUint aSwitch=EOverWrite);

Description

Renames one or more files.

This is a synchronous function.

The function can also be used to move files by specifying different destination and source directories. Note that the destination and source directories must be on the same drive.

If this function is being used to move files, an option is provided to allow the user to overwrite any files with the same name which may exist in the target directory. If the flag is set for no overwriting, any files with the same name will not be overwritten, and an error (KErrAlreadyExists) will be returned for that file, as retrieved by CFileBase::GetLastError().

This function can only operate non-recursively, so that only the matching files located in the single directory specified by anOld may be renamed.

Notes:

1. Read-only, hidden and system files can be moved and the source file's attributes are preserved in the target file, but open files cannot be moved. Attempting to move an open file will return an error for that file, as retrieved by CFileBase::GetLastError().

Parameters

const TDesC &anOld Path specifying the file(s) to be renamed. const TDesC &aNew Path specifying the new name for the files and/or the new directory. Any directories specified in this path that do not exist, will be created. TUint aSwitch Specify zero for no overwriting; CFileMan::EOverWrite to overwrite files with the same name. This function cannot operate recursively.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

See also:

• CFileBase::GetLastError

Capability:

Dependent

If either aName or aNewName is /Sys then Tcb capability is required. If either aName or aNewName begins with /Private and does not match this process' SID then AllFiles capability is required. If either aName or aNewName is /Resource then Tcb capability is required.

IMPORT_C TInt Rename(const TDesC &anOld, const TDesC &aNew, TUint aSwitch, TRequestStatus &aStatus);

Description

Renames one or more files.

This is an asycnhronous function. Its behaviour is the same as the synchronous overload.

Parameters

const TDesC &anOld Path specifying the file(s) to be renamed. const TDesC &aNew Path specifying the new name for the files and/or the new directory. Any directories specified in this path that do not exist, will be created. TUint aSwitch Specify zero for no overwriting; CFileMan::EOverWrite to overwrite files with the same name. This function cannot operate recursively. TRequestStatus &aStatus The request status object. On request completion, indicates how the request completed: KErrNone, if successful, otherwise one of the other system-wide error codes.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

Capability:

Dependent

If aDirName starts with /Sys then Tcb capability is required. If aDirName begins with /Private and does not match this process' SID then AllFiles capability is required. If aDirName starts with /Resource then Tcb capability is required.

IMPORT_C TInt RmDir(const TDesC &aDirName);

Description

Deletes a directory and all files and directories contained in the directory structure below it.

This is a synchronous function.

The function cannot be used non-recursively. For a non-recursive directory deletion, use RFs::RmDir().

Note:

1. All files in the directory hierarchy to be deleted must be closed and none may have the read-only attribute. Otherwise, not all of the hierarchy will be deleted, and this function will return KErrInUse.

Parameters

const TDesC &aDirName Path specifying the directory to be deleted.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

Capability:

Dependent

If aDirName starts with /Sys then Tcb capability is required. If aDirName begins with /Private and does not match this process' SID then AllFiles capability is required. If aDirName starts with /Resource then Tcb capability is required.

IMPORT_C TInt RmDir(const TDesC &aDirName, TRequestStatus &aStatus);

Description

Deletes a directory and all files and directories contained in the directory structure below it.

Other than being asynchronous, the behaviour of this function is the same as is documented in its synchronous overload.

Parameters

const TDesC &aDirName Path specifying the directory to be deleted. TRequestStatus &aStatus The request status object. On request completion, indicates how the request completed: KErrNone if successful, otherwise one of the other system-wide error codes.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

Capability:

Dependent

If the path for aNew begins with /Sys then Tcb capability is required. If the path for aNew begins with /Private and does not match this process' SID then AllFiles capability is required. If the path for aNew begins with /Resource then Tcb capability is required.

IMPORT_C TInt Copy(const RFile &anOld, const TDesC &aNew, TUint aSwitches=EOverWrite);

Description

Copies from an open file handle to a destination file name.

This is a synchronous function.

Optionally, this function can be set to overwrite the target file. If the flag is set for no overwriting and the target file already exists, then the target file will not be overwritten, and an error (KErrAlreadyExists) will be returned. Error codes may be retrieved using CFileBase::GetLastError().

Notes:

1. The file can be copied across drives.

2. Read-only, hidden and system files can be copied and the source file's attributes are preserved in the target file.

Parameters

const RFile &anOld Open file handle indicating the file to be copied. const TDesC &aNew Path indicating the directory (and optionally the filename) into which the file is to be copied. TUint aSwitches Specify zero for no overwriting; CFileMan::EOverWrite to overwrite files with the same name; Any other flags are illegal By default, the synchronous variant of this function operates with overwriting.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

See also:

• CFileBase::GetLastError

Capability:

Dependent

If the path for aNew begins with /Sys then Tcb capability is required. If the path for aNew begins with /Private and does not match this process' SID then AllFiles capability is required. If the path for aNew begins with /Resource then Tcb capability is required.

IMPORT_C TInt Copy(const RFile &anOld, const TDesC &aNew, TUint aSwitches, TRequestStatus &aStatus);

Description

Copies from an open file handle to a destination file name.

This is an asycnhronous function. Its behaviour is the same as the synchronous overload.

Parameters

const RFile &anOld Open file handle indicating the file to be copied. const TDesC &aNew Path indicating the directory (and optionally the filename) into which the file is to be copied. TUint aSwitches Specify zero for no overwriting; CFileMan::EOverWrite to overwrite files with the same name; Any other flags are illegal. TRequestStatus &aStatus The request status object. On request completion, indicates how the request completed: KErrNone, if successful, otherwise one of the other system-wide error codes.

Return value

TInt KErrNone if successful, otherwise one of the other system-wide error codes.

See also:

• CFileBase::GetLastError

TAction

Description

An enumeration that identifies CFileMan tasks. This enumeration is used by CurrentAction() to identify which task currently being carried out.

See also:

• CFileMan::CurrentAction

ENone Inactive EAttribs Setting attributes ECopy Copying files EDelete Deleting files EMove Moving files ERename Renaming files ERmDir Deleting a directory and all contents ERenameInvalidEntry Renaming component to VFAT short name (guaranteed to be unique) ECopyFromHandle Copying file from open file handle

TSwitch

Description

Overwriting and recursion switch.

Used in CFileMan functions to set whether operations are applied to the specified directory and all directories below it, or the specified directory only.

EOverWrite Any files in the destination directory that have the same name as the source files in a rename, move or copy operation, will be overwritten. ERecurse Recursive operation.