Checks the integrity of the file system on the volume and returns an appropriate error value. The default implementation must be overridden by a derived class.

The same as original CheckDisk(), but with some parameters.

Check is this file system can be mounted on the drive at all. The file system implementation may, for example, read and validate the boot region without real mounting overhead.

Clears a password from a media that supports write protection.

The default implementation must be overridden in a derived class.

Low-level control IO

Unlocks the mount by decrementing the internal lock counter.

The mount becomes locked on formatting or on the opening of a resource (a file or a directory) or raw disk subsession. A format, resource or raw disk subsession can only be opened if the mount is not locked.

Deletes the specified file from the mount.

The function can assume that the file is closed.

    \\dirA\\dirB\\dirC\\file.ext

The extension is optional.

The function should leave on error detection, with an appropriate error code.

Customises the opening of a directory on the mount.

The function is called internally, and the directory will have been created and initialised by the calling function. Any customisation specific to a file system should be implemented in this function.

    \\dirA\\dirB\\dirC\\file.ext

where \dirA\dirB\dirC\ is the directory to be opened and file.ext is an optional entry name and extension.

After successful completion of the function, the directory control block pointer will be added to the file server global directories container.

The function should leave with a suitable error code if it cannot complete successfully for any reason.

Carries out any clean-up necessary for a volume dismount.

Dismounting a volume will always succeed, so the function does not need to return an error value. Any cached information should be discarded and no attempt should be made to access the volume. For removable media it may be that the media has already been removed. This function is called when a media change is detected.

Gets a reference to the object representing the drive on which the volume is mounted.

Gets the entry details for the specified file or directory.

    \\dirA\\dirB\\dirC\\entry.

Note that anEntry.iType (the entry UID) should only be set for a file whose size is greater than or equal to sizeof(TCheckedUid).

The function should leave with an appropriate error code if it cannot complete successfully for any reason.

Erase a password from a media that supports write protection.

The default implementation must be overridden in a derived class.

Customises the opening of a new or existing file on the mount.

The function is called internally (via TDrive::FileOpen()) as a result of a call by the client, and the file is created, if necessary, and opened by the calling function. However this function implements any replacement functionality, as well as any other behaviour particular to the file system.

If anOpen specifies EFileReplace (rather than EFileCreate or EFileOpen) then, if replacement functionality is required, the data contained in the file should be discarded, the archive attribute should be set, and the size of the file should be set to zero. Note that it can be assumed that if anOpen specifies EFileReplace then the file already exists.

After successful completion of the function, the file control block pointer will be added to the file server's global files container.

The function should leave with a suitable error code if it cannot be completed successfully.

Legacy method: finalise the mount and put it to the consistent state.

finalise the mount and put it to the consistent state.

Corresponds to EMountVolParamQuery. A request to obtain the _current_ amount of free space on the volume asynchronously, without blocking. Some mounts implementations can count volume free space in the background.

Return a pointer to a specified interface extension - to allow future extension of this class without breaking binary compatibility.

Gets the long name of the file or directory associated with the given short name.

This function is used in circumstances where a file system mangles Symbian OS natural names in order to be able to store them on a file system that is not entirely compatible.

The function should leave with a suitable error code if it cannot complete successfully for any reason.

Get Maximum file size, which is supported by the file system that has produced this mount.

Tests whether the client is notified of any read or write failures.

The notification status is a property of the current session with the file server, the value of which is stored in CSessionFs::iNotifyUser. If set to true, the client will receive notifications from the file system.

Typically, this function might be used to save the current notification state prior to temporarily disabling notifiers. This allows the original notification state to be restored.

Note that GetNotifyUser() is only available once the drive has been set for the mount control block (using SetDrive()), since the notification status is held by the session and accessed via the drive.

Gets the short name of the file or directory with the given full name.

This function is used in circumstances where a file system mangles Symbian OS natural names, in order to be able to store them on a file system that is not entirely compatible.

The function should leave with a suitable error code if it cannot complete successfully for any reason.

Locks the mount by incrementing the internal lock counter.

The mount becomes locked on formatting or on the opening of a resource (a file or a directory) or raw disk subsession. A format, resource or raw disk subsession can only be opened if the mount is not locked.

Tests whether the mount control block represents the current mount on the associated drive.

A drive has only one mount which is accessible: the current mount. Any mount other than the current mount relates to a partition (i.e. volume) that was present on a removable media which has since been removed. The reason the mount has persisted is because resources (i.e. files/directories) are still open on it.

This function is only available when the drive has been set for the mount control block (using SetDrive()), since the current mount is held by the drive.

Returns ETrue if the mount is flagged as dismounted.

Query if the mount is finalised, corresponds to the EMountStateQuery control code only.

Returns whether the mount (and any extensions) support file caching

Retrieves TBusLocalDrive object associated with the mount

Locks a media which supports password protection and replaces the old password with a new one.

If aStore is set to ETrue, then the new password should be saved to the password store file, KMediaPWrdFile, using the exported file server function WriteToDisk().

The password file is used to initialise the password store on boot up, so the user does not need to be prompted for the password again if it is saved here.

The default implementation must be overridden in a derived class.

Gets the current lock status.

It delivers the current lock status by returning the internal lock counter.

Tests whether the mount is currently locked.

A mount is locked when the internal lock counter is greater than zero. On creation, the lock counter is set to zero.

The mount becomes locked on formatting or on the opening of a resource (a file or a directory) or raw disk subsession. A format, resource or raw disk subsession can only be opened if the mount is not locked.

Creates a new directory on the mount.

    \\dirA\\dirB\\dirC\\dirD

The function should leave, on error detection, with an appropriate error code.

Generic mount control method.

Attempts to set the mount control block properties using the current mount (i.e. volume) on the associated drive.

The function should set the volume name (iVolumeName), the unique ID (iUniqueID) and the volume size (iSize) by reading and processing the current mount.

When aForceMount is set to ETrue, the properties of a corrupt volume should be forcibly stored. The classic case of when this is desirable is when a corrupt volume needs to be formatted.

The function should leave, on error detection, with an appropriate error code.

Returns the unique mount number

Corresponds to EMountVolParamQuery. A request to obtain size of the mounted volume without blocking (CMountCB::VolumeL() can block).

Retrieves CProxyDrive object associated with the mount

Reads the specified length of data from the specified position on the volume directly into the client thread.

It can be assumed that if this function is called, then there has been a successful mount.

This function should leave with an appropriate error code when an error is detected.

Writes a specified length of data from the client thread to the volume at the specified position.

It can be assumed that if this function is called, then there has been a successful mount.

This function should leave with an appropriate error code when an error is detected.

Checks whether the mount control block represents the current mount on the associated drive.

The function should read mount information from the current volume, and check it against the mount information from this mount - typically iVolumeName and iUniqueID. If the mount information matches, the function should return KErrNone, otherwise it should return KErrGeneral.

Called by the associated TDrive object when the drive has no current mounts, which is the case on first access to the drive and following a volume change on a drive associated with removable media. In this circumstance, this function is called systematically on every mount control block owned by the drive. If ReMount() calls for all existing mount control blocks fail, the drive creates a new mount control block and calls CMountCB::MountL() on that object; the new object is added to the list of mount control blocks owned by the drive.

Reads a specified section of the file, regardless of the file's lock state.

The function should leave with a suitable error code if it cannot complete successfully for any reason.

Renames or moves a single file or directory on the mount.

    \\dirA\\dirB\\dirC\\oldEntryName

and

    \\dirE\\dirF\\dirG\\newEntryName

If oldEntryName is a file, it can be assumed that it is closed. If oldEntryName is a directory, it can be assumed that there are no open files in this directory. Furthermore, if newEntryName specifies a directory, it can be assumed that it is not a subdirectory of oldEntryName.

The function should leave with an appropriate error code if it cannot complete successfully for any reason.

Replaces one file on the mount with another.

The function can assume that both anOldName and, if it exists, anNewName contain the full file names of files, and that these files are not open.

If the file aNewName does not exist it should be created.

The file anOldName should have its contents, attributes, and the universal date and time of its last modification, copied to the file aNewName, overwriting any existing contents and attribute details. Finally anOldName should be deleted.

The function should leave with an appropriate error code if it cannot complete successfully for any reason.

Corresponds to EMountVolParamQuery. Request a certain amount of free space on the volume. If _current_ amount of free space is >= than required or it is not being updated in background by the mount, returns immediately; If mount is still counting free space and If _current_ amount of free space is < than required, the caller will be blocked until mount finds enough free space or reports that the _final_ amount of free space is less than required.

Removes the directory specified by aName (its full name) from the volume.

    \\dirA\\dirB\\dirC\\dirD

The function can assume that the directory exists and is not read-only.

The function should leave with a suitable error code if it cannot complete successfully for any reason.

Scans through and corrects errors found in the volume.

The default implementation must be overridden by a derived class.

The same as original ScanDrive(), but with some parameters.

Set the mount to be dismounted

Sets a pointer to the object representing the drive on which the volume is mounted.

Sets entry details for a specified file or directory.

The entry identfied by the full name descriptor aName should have its modification time and its attributes mask updated as required.

The entry receives a new universal modified time from aTime. The entry attributes are set with aSetAttMask and cleared with aClearAttMask: the bits that are set in aSetAttMask should be set in the entry attribute mask; the bits that are set in aClearAttMask should be cleared from the entry attribute mask.

The function can assume that aSetAttMask and aClearAttMask do not change the type of attribute (i.e. volume or directory). Furthermore, if aName specifies a file, it can be assumed that this file is closed.

The function should leave with an appropriate error code on error detection.

Sets the volume name for the mount, thus writing the new volume name to the corresponding volume.

This function should leave on error detection.

Sets a pointer to a heap descriptor containing the name of the mounted volume.

Unlocks a media which supports password protection.

If aStore is set to ETrue then the password should be saved to the password store file specified by KMediaPWrdFile using the exported file server function WriteToDisk().

The password file is used to initialise the password store on boot up, so the user does not need to be prompted for the password again if it is saved here.

The default implementation must be overridden in a derived class.

Gets volume information.

The only information that the function has to supply is the free space, TVolumeInfo::iFree, since the remaining members have already been set by the calling function.

The function should leave, on error detection, with an appropriate error code.

Gets a reference to a heap descriptor containing the name of the mounted volume.

Enumeration of the aInterfaceIDs used in GetInterface.

Mount Control levels or operations to perform

Mount Control options that makes sense only for certain control codes, see TMntCtlLevel

A list of all open files on that mount. Set by the TDrive object representing the drive of which the mount resides.