Collapse all Symbian^3 Product Developer Library

TDrive Class Reference

class TDrive

Represents a drive in the file server.

Note that drives may act as substitutes for paths on other drives, in which case any access to this drive letter will be translated into a reference to the assigned path. In this way drives can act as short cuts to paths on other drives.

Public Member Functions
	TDrive()
TInt	ActiveMounts()
IMPORT_C TUint	Att()
TInt	CheckDisk()
TInt	CheckDisk(TInt, TAny , TAny )
TInt	CheckMount()
TInt	CheckMountAndEntryName(const TDesC &)
TInt	ClampFile(const TDesC &, TAny *)
TBool	ClampFlag()
TInt	ClampsOnDrive()
TInt	ClearDevicePassword(TMediaPassword &)
TInt	ControlIO(const RMessagePtr2 &, TInt, TAny , TAny )
void	CreateL(TInt)
CMountCB &	CurrentMount()
TInt	DeferredDismount()
TInt	Delete(const TDesC &)
TInt	DirOpen(CSessionFs *, TInt &, const TDesC &, TUint, const TUidType &)
IMPORT_C void	Dismount()
TBool	DismountDeferred()
TInt	DismountExtension(CProxyDriveFactory *, TBool)
void	DismountLock()
TInt	DismountLocked()
TInt	DismountProxyDrive()
TInt	DismountUnlock()
void	DriveInfo(TDriveInfo &)
TInt	DriveNumber()
TInt	Entry(const TDesC &, TEntry &)
TInt	EraseDevicePassword()
TDriveExtInfo &	ExtInfo()
TInt	ExtensionName(TDes &, TInt)
CFileSystem &	FSys()
TInt	FileOpen(CFsRequest *, TInt &, const TDesC &, TUint, TFileOpen)
TInt	FileTemp(CFsRequest *, TInt &, const TDesC &, TDes &, TUint)
TInt	FinaliseMount()
TInt	FinaliseMount(TInt, TAny , TAny )
TInt	FlushCachedFileInfo(TBool)
void	FlushCachedFileInfoL()
void	ForceDismount()
TInt	ForceRemountDrive(const TDesC8 *, TInt, TUint)
TInt	ForceUnmountFileSystemForFormatting()
CFormatCB *	FormatOpenL(CFsRequest , TInt &, TFormatMode, const TLDFormatInfo , const TVolFormatParam *)
TInt	FreeDiskSpace(TInt64 &)
CFileSystem *&	GetFSys()
TInt	GetLongName(const TDesC &, TDes &)
IMPORT_C TBool	GetNotifyUser()
TInt	GetReason()
TInt	GetShortName(const TDesC &, TDes &)
TBool	IsChanged()
TBool	IsCurrentMount(CMountCB &)
IMPORT_C TBool	IsCurrentWriteFunction()
TInt	IsFileInRom(const TDesC &, TUint8 *&)
TInt	IsFileOpen(const TDesC &, CFileCB *&)
TBool	IsLocal()
TBool	IsMounted()
TBool	IsRemovable()
TBool	IsRom()
TBool	IsRugged()
TBool	IsSubsted()
TBool	IsSynchronous()
TBool	IsWriteProtected()
IMPORT_C TBool	IsWriteableResource()
void	Lock()
TInt	LockDevice(TMediaPassword &, TMediaPassword &, TBool)
TInt	MkDir(const TDesC &)
CFsObjectCon &	Mount()
TInt	MountControl(TInt, TInt, TAny *)
TInt	MountExtension(CProxyDriveFactory *, TBool)
void	MountFileSystem(TBool, TUint32)
TInt	MountedVolumeSize(TUint64 &)
void	MultiSlotDriveCheck()
void	PurgeDirty(CMountCB &)
TBool	ReMount(CMountCB &)
void	ReactivateMounts()
TInt	ReadFileSection(const TDesC &, TInt, TAny *, TInt, const RMessagePtr2 &)
TInt	ReadFileSection64(const TDesC &, TInt64, TAny *, TInt, const RMessagePtr2 &)
TInt	Rename(const TDesC &, const TDesC &)
TInt	Replace(const TDesC &, const TDesC &)
TInt	RequestFreeSpaceOnMount(TUint64)
TInt	ReservedSpace()
TInt	RmDir(const TDesC &)
TInt	ScanDrive()
TInt	ScanDrive(TInt, TAny , TAny )
void	SetAtt(TUint)
void	SetChanged(TBool)
void	SetClampFlag(TBool)
void	SetDismountDeferred(TBool)
TInt	SetEntry(const TDesC &, const TTime &, TUint, TUint)
void	SetNotifyOff()
void	SetNotifyOn()
void	SetReservedSpace(const TInt)
void	SetRugged(TBool)
void	SetSubst(HBufC *)
void	SetSubstedDrive(TDrive *)
void	SetSynchronous(TBool)
TInt	SetVolume(const TDesC &)
HBufC &	Subst()
TDrive &	SubstedDrive()
void	UnLock()
TInt	UnclampFile(CMountCB , RFileClamp )
TInt	UnlockDevice(TMediaPassword &, TBool)
TInt	Volume(TVolumeInfo &)

Private Member Functions
TInt	CheckAttributes(const TDesC &, TUint &, TUint &)
TInt	CheckDirectories(const TDesC &, const TDesC &)
TInt	CheckMountAndEntryNames(const TDesC &, const TDesC &)
void	DirOpenL(CSessionFs , TInt &, const TDesC &, TUint, const TUidType &, CDirCB &)
void	DoCompleteDismountNotify(TInt)
void	DoDismount()
void	DoEntryL(const TDesC &, TEntry &)
void	DoMountFileSystemL(CMountCB *&, TBool, TUint32)
IMPORT_C void	DriveFault(TBool)
void	FileOpenL(CFsRequest , TInt &, const TDesC &, TUint, TFileOpen, CFileCB &, CFileShare *&)
IMPORT_C TBool	IsDriveThread()
TBool	IsExtensionMounted(CProxyDriveFactory *)
IMPORT_C TBool	IsMainThread()
CFileCache *	LocateClosedFile(const TDesC &, TBool)
CFileCB *	LocateFile(const TDesC &)
CFileCB *	LocateFileByPath(const TDesC &)
TBool	ReMount()
void	ReadSectionL(const TDesC &, TInt64, TAny *, TInt, const RMessagePtr2 &)
void	SetVolumeL(const TDesC &, HBufC *&)
TInt	ValidateShare(CFileCB &, TShare)

Private Member Enumerations
enum	anonymous { ENotifyOff = 0x01, EDismountDeferred = 0x02, ENotRugged = 0x04, EClampPresent = 0x08, EDriveIsSynch = 0x10 }

Private Attributes
TUint	iAtt
TBool	iChanged
CMountCB *	iCurrentMount
TInt	iDismountLock
TInt	iDriveFlags
TInt	iDriveNumber
TDriveExtInfo	iExtInfo
CFileSystem *	iFSys
TInt	iLastMountError
RFastLock	iLock
CFsObjectCon *	iMount
TInt	iMountFailures
TInt	iMountNumber
TInt	iReason
TInt	iReservedSpace
TInt	iSpare1
TInt	iSpare2
HBufC *	iSubst
TDrive *	iSubstedDrive

Constructor & Destructor Documentation

TDrive()

TDrive

(

)

Member Functions Documentation

ActiveMounts()

TInt

ActiveMounts

(

)

const

Att()

IMPORT_C TUint

Att

(

)

CheckAttributes(const TDesC &, TUint &, TUint &)

TInt	CheckAttributes	(	const TDesC &	aName,
			TUint &	aSetAttMask,
			TUint &	aClearAttMask
		)	[private]

Parameters

const TDesC & aName
TUint & aSetAttMask
TUint & aClearAttMask

CheckDirectories(const TDesC &, const TDesC &)

TInt	CheckDirectories	(	const TDesC &	anOldName,
			const TDesC &	aNewName
		)	[private]

Parameters

const TDesC & anOldName
const TDesC & aNewName

CheckDisk()

TInt

CheckDisk

(

)

CheckDisk(TInt, TAny , TAny )

TInt	CheckDisk	(	TInt	aOperation,
			TAny *	aParam1 = NULL,
			TAny *	aParam2 = NULL
		)

Parameters

TInt aOperation
TAny * aParam1 = NULL
TAny * aParam2 = NULL

CheckMount()

TInt

CheckMount

(

)

CheckMountAndEntryName(const TDesC &)

TInt

CheckMountAndEntryName

(

const TDesC &

aName

)

Parameters

const TDesC & aName

CheckMountAndEntryNames(const TDesC &, const TDesC &)

TInt	CheckMountAndEntryNames	(	const TDesC &	anOldName,
			const TDesC &	aNewName
		)	[private]

Parameters

const TDesC & anOldName
const TDesC & aNewName

ClampFile(const TDesC &, TAny *)

TInt	ClampFile	(	const TDesC &	aName,
			TAny *	aHandle
		)

Parameters

const TDesC & aName
TAny * aHandle

ClampFlag()

TBool

ClampFlag

(

)

ClampsOnDrive()

TInt

ClampsOnDrive

(

)

ClearDevicePassword(TMediaPassword &)

TInt

ClearDevicePassword

(

TMediaPassword &

aPassword

)

Parameters

TMediaPassword & aPassword

ControlIO(const RMessagePtr2 &, TInt, TAny , TAny )

TInt	ControlIO	(	const RMessagePtr2 &	aMessage,
			TInt	aCommand,
			TAny *	aParam1,
			TAny *	aParam2
		)

Parameters

const RMessagePtr2 & aMessage
TInt aCommand
TAny * aParam1
TAny * aParam2

CreateL(TInt)

void

CreateL

(

TInt

aDriveNumber

)

Parameters

TInt aDriveNumber

CurrentMount()

CMountCB &

CurrentMount

(

)

const [inline]

Gets a reference to the object representing the current mount.

DeferredDismount()

TInt

DeferredDismount

(

)

Delete(const TDesC &)

TInt

Delete

(

const TDesC &

aName

)

Parameters

const TDesC & aName

DirOpen(CSessionFs *, TInt &, const TDesC &, TUint, const TUidType &)

TInt	DirOpen	(	CSessionFs *	aSession,
			TInt &	aHandle,
			const TDesC &	aName,
			TUint	anAtt,
			const TUidType &	aUidType
		)

Parameters

CSessionFs * aSession
TInt & aHandle
const TDesC & aName
TUint anAtt
const TUidType & aUidType

DirOpenL(CSessionFs , TInt &, const TDesC &, TUint, const TUidType &, CDirCB &)

void	DirOpenL	(	CSessionFs *	aSession,
			TInt &	aHandle,
			const TDesC &	aName,
			TUint	anAtt,
			const TUidType &	aUidType,
			CDirCB *&	aDir
		)	[private]

Parameters

CSessionFs * aSession
TInt & aHandle
const TDesC & aName
TUint anAtt
const TUidType & aUidType
CDirCB *& aDir

Dismount()

IMPORT_C void

Dismount

(

)

DismountDeferred()

TBool

DismountDeferred

(

)

const [inline]

DismountExtension(CProxyDriveFactory *, TBool)

TInt	DismountExtension	(	CProxyDriveFactory *	aFactory,
			TBool	aIsPrimary
		)

Parameters

CProxyDriveFactory * aFactory
TBool aIsPrimary

DismountLock()

void

DismountLock

(

)

DismountLocked()

TInt

DismountLocked

(

)

const

DismountProxyDrive()

TInt

DismountProxyDrive

(

)

DismountUnlock()

TInt

DismountUnlock

(

)

DoCompleteDismountNotify(TInt)

void

DoCompleteDismountNotify

(

TInt

aCompletionCode

)

[private]

Parameters

TInt aCompletionCode

DoDismount()

void

DoDismount

(

)

[private]

DoEntryL(const TDesC &, TEntry &)

void	DoEntryL	(	const TDesC &	aName,
			TEntry &	anEntry
		)	[private]

Parameters

const TDesC & aName
TEntry & anEntry

DoMountFileSystemL(CMountCB *&, TBool, TUint32)

void	DoMountFileSystemL	(	CMountCB *&	apMount,
			TBool	aForceMount,
			TUint32	aFsNameHash
		)	[private]

Parameters

CMountCB *& apMount
TBool aForceMount
TUint32 aFsNameHash

DriveFault(TBool)

IMPORT_C void

DriveFault

(

TBool

aDriveError

)

const [private]

Parameters

TBool aDriveError

DriveInfo(TDriveInfo &)

void

DriveInfo

(

TDriveInfo &

anInfo

)

Parameters

TDriveInfo & anInfo

DriveNumber()

TInt

DriveNumber

(

)

const [inline]

Returns the drive number.

TDriveNumber

Entry(const TDesC &, TEntry &)

TInt	Entry	(	const TDesC &	aName,
			TEntry &	anEntry
		)

Parameters

const TDesC & aName
TEntry & anEntry

EraseDevicePassword()

TInt

EraseDevicePassword

(

)

ExtInfo()

TDriveExtInfo &

ExtInfo

(

)

[inline]

Gets the object representing the TDriveExtInfo.

TDriveExtInfo

ExtensionName(TDes &, TInt)

TInt	ExtensionName	(	TDes &	aExtensionName,
			TInt	aPos
		)

Parameters

TDes & aExtensionName
TInt aPos

FSys()

CFileSystem &

FSys

(

)

[inline]

Gets a reference to the object representing the file system

FileOpen(CFsRequest *, TInt &, const TDesC &, TUint, TFileOpen)

TInt	FileOpen	(	CFsRequest *	aRequest,
			TInt &	aHandle,
			const TDesC &	aName,
			TUint	aMode,
			TFileOpen	anOpen
		)

Parameters

CFsRequest * aRequest
TInt & aHandle
const TDesC & aName
TUint aMode
TFileOpen anOpen

FileOpenL(CFsRequest , TInt &, const TDesC &, TUint, TFileOpen, CFileCB &, CFileShare *&)

void	FileOpenL	(	CFsRequest *	aRequest,
			TInt &	aHandle,
			const TDesC &	aName,
			TUint	aMode,
			TFileOpen	anOpen,
			CFileCB *&	aFileCB,
			CFileShare *&	aFileShare
		)	[private]

Parameters

CFsRequest * aRequest
TInt & aHandle
const TDesC & aName
TUint aMode
TFileOpen anOpen
CFileCB *& aFileCB
CFileShare *& aFileShare

FileTemp(CFsRequest *, TInt &, const TDesC &, TDes &, TUint)

TInt	FileTemp	(	CFsRequest *	aRequest,
			TInt &	aHandle,
			const TDesC &	aPath,
			TDes &	aName,
			TUint	aMode
		)

Parameters

CFsRequest * aRequest
TInt & aHandle
const TDesC & aPath
TDes & aName
TUint aMode

FinaliseMount()

TInt

FinaliseMount

(

)

FinaliseMount(TInt, TAny , TAny )

TInt	FinaliseMount	(	TInt	aOperation,
			TAny *	aParam1 = NULL,
			TAny *	aParam2 = NULL
		)

Parameters

TInt aOperation
TAny * aParam1 = NULL
TAny * aParam2 = NULL

FlushCachedFileInfo(TBool)

TInt

FlushCachedFileInfo

(

TBool

aPurgeCache = EFalse

)

Parameters

TBool aPurgeCache = EFalse

FlushCachedFileInfoL()

void

FlushCachedFileInfoL

(

)

ForceDismount()

void

ForceDismount

(

)

ForceRemountDrive(const TDesC8 *, TInt, TUint)

TInt	ForceRemountDrive	(	const TDesC8 *	aMountInfo,
			TInt	aMountInfoMessageHandle,
			TUint	aFlags
		)

Parameters

const TDesC8 * aMountInfo
TInt aMountInfoMessageHandle
TUint aFlags

ForceUnmountFileSystemForFormatting()

TInt

ForceUnmountFileSystemForFormatting

(

)

FormatOpenL(CFsRequest , TInt &, TFormatMode, const TLDFormatInfo , const TVolFormatParam *)

CFormatCB *	FormatOpenL	(	CFsRequest *	aRequest,
			TInt &	aFmtHandle,
			TFormatMode	aFmtMode,
			const TLDFormatInfo *	apLDFormatInfo,
			const TVolFormatParam *	apVolFormatParam
		)

Parameters

CFsRequest * aRequest
TInt & aFmtHandle
TFormatMode aFmtMode
const TLDFormatInfo * apLDFormatInfo
const TVolFormatParam * apVolFormatParam

FreeDiskSpace(TInt64 &)

TInt

FreeDiskSpace

(

TInt64 &

aFreeDiskSpace

)

Parameters

TInt64 & aFreeDiskSpace

GetFSys()

CFileSystem *&

GetFSys

(

)

[inline]

Gets the object representing the file system

GetLongName(const TDesC &, TDes &)

TInt	GetLongName	(	const TDesC &	aShortName,
			TDes &	aLongName
		)

Parameters

const TDesC & aShortName
TDes & aLongName

GetNotifyUser()

IMPORT_C TBool

GetNotifyUser

(

)

GetReason()

TInt

GetReason

(

)

const [inline]

Gets last error reason.

GetShortName(const TDesC &, TDes &)

TInt	GetShortName	(	const TDesC &	aLongName,
			TDes &	aShortName
		)

Parameters

const TDesC & aLongName
TDes & aShortName

IsChanged()

TBool

IsChanged

(

)

const [inline]

Determines whether the drive content has changed.

IsCurrentMount(CMountCB &)

TBool

IsCurrentMount

(

CMountCB &

aMount

)

const [inline]

Parameters

CMountCB & aMount

IsCurrentWriteFunction()

IMPORT_C TBool

IsCurrentWriteFunction

(

)

const

IsDriveThread()

IMPORT_C TBool

IsDriveThread

(

)

const [private]

IsExtensionMounted(CProxyDriveFactory *)

TBool

IsExtensionMounted

(

CProxyDriveFactory *

aFactory

)

[private]

Parameters

CProxyDriveFactory * aFactory

IsFileInRom(const TDesC &, TUint8 *&)

TInt	IsFileInRom	(	const TDesC &	aFileName,
			TUint8 *&	aFileStart
		)

Parameters

const TDesC & aFileName
TUint8 *& aFileStart

IsFileOpen(const TDesC &, CFileCB *&)

TInt	IsFileOpen	(	const TDesC &	aFileName,
			CFileCB *&	aFileCB
		)

Parameters

const TDesC & aFileName
CFileCB *& aFileCB

IsLocal()

TBool

IsLocal

(

)

const [inline]

Determines whether attribute is set to local.

IsMainThread()

IMPORT_C TBool

IsMainThread

(

)

const [private]

IsMounted()

TBool

IsMounted

(

)

const [inline]

Determines whether the drive is mounted.

IsRemovable()

TBool

IsRemovable

(

)

const [inline]

Determines whether the drive is removable.

IsRom()

TBool

IsRom

(

)

const [inline]

Determines whether the drive is ROM drive.

IsRugged()

TBool

IsRugged

(

)

const [inline]

Returns whether the current drive is running as rugged Fat or not.If IsRugged flag is set then in the event of power failure fat/metadata will be in a valid state if the scandrive utility is run immediately after.

IsSubsted()

TBool

IsSubsted

(

)

const [inline]

Determines whether the drive is substed.

IsSynchronous()

TBool

IsSynchronous

(

)

const [inline]

IsWriteProtected()

TBool

IsWriteProtected

(

)

IsWriteableResource()

IMPORT_C TBool

IsWriteableResource

(

)

const

LocateClosedFile(const TDesC &, TBool)

CFileCache *	LocateClosedFile	(	const TDesC &	aName,
			TBool	aResurrect = ETrue
		)	[private]

Parameters

const TDesC & aName
TBool aResurrect = ETrue

LocateFile(const TDesC &)

CFileCB *

LocateFile

(

const TDesC &

aName

)

[private]

Parameters

const TDesC & aName

LocateFileByPath(const TDesC &)

CFileCB *

LocateFileByPath

(

const TDesC &

aPath

)

[private]

Parameters

const TDesC & aPath

Lock()

void

Lock

(

)

[inline]

Locks the drive.This function acquires iLock mutex.

LockDevice(TMediaPassword &, TMediaPassword &, TBool)

TInt	LockDevice	(	TMediaPassword &	aOld,
			TMediaPassword &	aNew,
			TBool	aStore
		)

Parameters

TMediaPassword & aOld
TMediaPassword & aNew
TBool aStore

MkDir(const TDesC &)

TInt

MkDir

(

const TDesC &

aName

)

Parameters

const TDesC & aName

Mount()

CFsObjectCon &

Mount

(

)

const [inline]

Gets a reference to the object representing the mount on which the file resides.

MountControl(TInt, TInt, TAny *)

TInt	MountControl	(	TInt	aLevel,
			TInt	aOption,
			TAny *	aParam
		)

Parameters

TInt aLevel
TInt aOption
TAny * aParam

MountExtension(CProxyDriveFactory *, TBool)

TInt	MountExtension	(	CProxyDriveFactory *	aFactory,
			TBool	aIsPrimary
		)

Parameters

CProxyDriveFactory * aFactory
TBool aIsPrimary

MountFileSystem(TBool, TUint32)

void	MountFileSystem	(	TBool	aForceMount,
			TUint32	aFsNameHash = 0
		)

Parameters

TBool aForceMount
TUint32 aFsNameHash = 0

MountedVolumeSize(TUint64 &)

TInt

MountedVolumeSize

(

TUint64 &

aSize

)

Parameters

TUint64 & aSize

MultiSlotDriveCheck()

void

MultiSlotDriveCheck

(

)

PurgeDirty(CMountCB &)

void

PurgeDirty

(

CMountCB &

aMount

)

Parameters

CMountCB & aMount

ReMount(CMountCB &)

TBool

ReMount

(

CMountCB &

aMount

)

Parameters

CMountCB & aMount

ReMount()

TBool

ReMount

(

)

[private]

ReactivateMounts()

void

ReactivateMounts

(

)

ReadFileSection(const TDesC &, TInt, TAny *, TInt, const RMessagePtr2 &)

TInt	ReadFileSection	(	const TDesC &	aName,
			TInt	aPos,
			TAny *	aTrg,
			TInt	aLength,
			const RMessagePtr2 &	aMessage
		)

Parameters

const TDesC & aName
TInt aPos
TAny * aTrg
TInt aLength
const RMessagePtr2 & aMessage

ReadFileSection64(const TDesC &, TInt64, TAny *, TInt, const RMessagePtr2 &)

TInt	ReadFileSection64	(	const TDesC &	aName,
			TInt64	aPos,
			TAny *	aTrg,
			TInt	aLength,
			const RMessagePtr2 &	aMessage
		)

Parameters

const TDesC & aName
TInt64 aPos
TAny * aTrg
TInt aLength
const RMessagePtr2 & aMessage

ReadSectionL(const TDesC &, TInt64, TAny *, TInt, const RMessagePtr2 &)

void	ReadSectionL	(	const TDesC &	aName,
			TInt64	aPos,
			TAny *	aTrg,
			TInt	aLength,
			const RMessagePtr2 &	aMessage
		)	[private]

Parameters

const TDesC & aName
TInt64 aPos
TAny * aTrg
TInt aLength
const RMessagePtr2 & aMessage

Rename(const TDesC &, const TDesC &)

TInt	Rename	(	const TDesC &	anOldName,
			const TDesC &	aNewName
		)

Parameters

const TDesC & anOldName
const TDesC & aNewName

Replace(const TDesC &, const TDesC &)

TInt	Replace	(	const TDesC &	anOldName,
			const TDesC &	aNewName
		)

Parameters

const TDesC & anOldName
const TDesC & aNewName

RequestFreeSpaceOnMount(TUint64)

TInt

RequestFreeSpaceOnMount

(

TUint64

aFreeSpaceRequired

)

Parameters

TUint64 aFreeSpaceRequired

ReservedSpace()

TInt

ReservedSpace

(

)

const [inline]

Gets the reserved space of a drive

RmDir(const TDesC &)

TInt

RmDir

(

const TDesC &

aName

)

Parameters

const TDesC & aName

ScanDrive()

TInt

ScanDrive

(

)

ScanDrive(TInt, TAny , TAny )

TInt	ScanDrive	(	TInt	aOperation,
			TAny *	aParam1 = NULL,
			TAny *	aParam2 = NULL
		)

Parameters

TInt aOperation
TAny * aParam1 = NULL
TAny * aParam2 = NULL

SetAtt(TUint)

void

SetAtt

(

TUint

aValue

)

Parameters

TUint aValue

SetChanged(TBool)

void

SetChanged

(

TBool

aValue

)

[inline]

Sets a flag to state that the drive contents has changed.

Parameters

TBool aValue

True if contents has changed; False if unchanged.

SetClampFlag(TBool)

void

SetClampFlag

(

TBool

aClamped

)

Parameters

TBool aClamped

SetDismountDeferred(TBool)

void

SetDismountDeferred

(

TBool

aPending

)

Parameters

TBool aPending

SetEntry(const TDesC &, const TTime &, TUint, TUint)

TInt	SetEntry	(	const TDesC &	aName,
			const TTime &	aTime,
			TUint	aMask,
			TUint	aVal
		)

Parameters

const TDesC & aName
const TTime & aTime
TUint aMask
TUint aVal

SetNotifyOff()

void

SetNotifyOff

(

)

[inline]

Sets the notification flag OFF. The client will not receive notifications on Read or Write failures from the file system.

SetNotifyOn()

void

SetNotifyOn

(

)

[inline]

Sets the notification flag ON. The client will receive notifications on Read or Write failures from the file system.

SetReservedSpace(const TInt)

void

SetReservedSpace

(

const TInt

aReservedSpace

)

[inline]

Reserves a space of a drive.

Parameters

const TInt aReservedSpace

Amount of space to reserve in bytes.

SetRugged(TBool)

void

SetRugged

(

TBool

aIsRugged

)

[inline]

Sets the rugged flag in the drive object.

IsRugged()

Parameters

TBool aIsRugged

SetSubst(HBufC *)

void

SetSubst

(

HBufC *

aSubst

)

[inline]

Assigns a path to a drive.

Parameters

HBufC * aSubst

Path will be assigned to a drive.

SetSubstedDrive(TDrive *)

void

SetSubstedDrive

(

TDrive *

aDrive

)

[inline]

Sets the drive as substed to the path set by an earlier call to SetSubst().

Parameters

TDrive * aDrive

A pointer to the drive on which the volume is mounted.

SetSynchronous(TBool)

void

SetSynchronous

(

TBool

aIsSynch

)

[inline]

Set or reset internal EDriveIsSynch flag for the TDrive.

Parameters

TBool aIsSynch

SetVolume(const TDesC &)

TInt

SetVolume

(

const TDesC &

aName

)

Parameters

const TDesC & aName

SetVolumeL(const TDesC &, HBufC *&)

void	SetVolumeL	(	const TDesC &	aName,
			HBufC *&	aBuf
		)	[private]

Parameters

const TDesC & aName
HBufC *& aBuf

Subst()

HBufC &

Subst

(

)

const [inline]

Gets the substed path set by an earlier call to SetSubst().

SubstedDrive()

TDrive &

SubstedDrive

(

)

const [inline]

Gets the substed drive.

UnLock()

void

UnLock

(

)

[inline]

UnLocks the drive.This function signals the iLock mutex.

UnclampFile(CMountCB , RFileClamp )

TInt	UnclampFile	(	CMountCB *	aMount,
			RFileClamp *	aHandle
		)

Parameters

CMountCB * aMount
RFileClamp * aHandle

UnlockDevice(TMediaPassword &, TBool)

TInt	UnlockDevice	(	TMediaPassword &	aPassword,
			TBool	aStore
		)

Parameters

TMediaPassword & aPassword
TBool aStore

ValidateShare(CFileCB &, TShare)

TInt	ValidateShare	(	CFileCB &	aFile,
			TShare	aReqShare
		)	[private]

Parameters

CFileCB & aFile
TShare aReqShare

Volume(TVolumeInfo &)

TInt

Volume

(

TVolumeInfo &

aVolume

)

Parameters

TVolumeInfo & aVolume

Member Enumerations Documentation

Enum anonymous

Enumerators

ENotifyOff = 0x01
EDismountDeferred = 0x02
ENotRugged = 0x04
EClampPresent = 0x08
EDriveIsSynch = 0x10

Member Data Documentation

TUint iAtt

TUint

iAtt

[private]

TBool iChanged

TBool

iChanged

[private]

CMountCB * iCurrentMount

CMountCB *

iCurrentMount

[private]

TInt iDismountLock

TInt

iDismountLock

[private]

TInt iDriveFlags

TInt

iDriveFlags

[private]

TInt iDriveNumber

TInt

iDriveNumber

[private]

TDriveExtInfo iExtInfo

TDriveExtInfo

iExtInfo

[private]

CFileSystem * iFSys

CFileSystem *

iFSys

[private]

TInt iLastMountError

TInt

iLastMountError

[private]

RFastLock iLock

RFastLock

iLock

[private]

CFsObjectCon * iMount

CFsObjectCon *

iMount

[private]

TInt iMountFailures

TInt

iMountFailures

[private]

TInt iMountNumber

TInt

iMountNumber

[private]

TInt iReason

TInt

iReason

[private]

TInt iReservedSpace

TInt

iReservedSpace

[private]

TInt iSpare1

TInt

iSpare1

[private]

TInt iSpare2

TInt

iSpare2

[private]

HBufC * iSubst

HBufC *

iSubst

[private]

TDrive * iSubstedDrive

TDrive *

iSubstedDrive

[private]

TDrive Class Reference

Constructor & Destructor Documentation

TDrive()

Member Functions Documentation

ActiveMounts()

Att()

CheckAttributes(const TDesC &, TUint &, TUint &)

Parameters

CheckDirectories(const TDesC &, const TDesC &)

Parameters

CheckDisk()

CheckDisk(TInt, TAny *, TAny *)

Parameters

CheckMount()

CheckMountAndEntryName(const TDesC &)

Parameters

CheckMountAndEntryNames(const TDesC &, const TDesC &)

Parameters

ClampFile(const TDesC &, TAny *)

Parameters

ClampFlag()

ClampsOnDrive()

ClearDevicePassword(TMediaPassword &)

Parameters

ControlIO(const RMessagePtr2 &, TInt, TAny *, TAny *)

Parameters

CreateL(TInt)

Parameters

CurrentMount()

DeferredDismount()

Delete(const TDesC &)

Parameters

DirOpen(CSessionFs *, TInt &, const TDesC &, TUint, const TUidType &)

Parameters

DirOpenL(CSessionFs *, TInt &, const TDesC &, TUint, const TUidType &, CDirCB *&)

Parameters

Dismount()

DismountDeferred()

DismountExtension(CProxyDriveFactory *, TBool)

Parameters

DismountLock()

DismountLocked()

DismountProxyDrive()

DismountUnlock()

DoCompleteDismountNotify(TInt)

Parameters

DoDismount()

DoEntryL(const TDesC &, TEntry &)

Parameters

DoMountFileSystemL(CMountCB *&, TBool, TUint32)

Parameters

DriveFault(TBool)

Parameters

DriveInfo(TDriveInfo &)

Parameters

DriveNumber()

Entry(const TDesC &, TEntry &)

Parameters

EraseDevicePassword()

ExtInfo()

ExtensionName(TDes &, TInt)

Parameters

FSys()

FileOpen(CFsRequest *, TInt &, const TDesC &, TUint, TFileOpen)

Parameters

FileOpenL(CFsRequest *, TInt &, const TDesC &, TUint, TFileOpen, CFileCB *&, CFileShare *&)

Parameters

FileTemp(CFsRequest *, TInt &, const TDesC &, TDes &, TUint)

Parameters

FinaliseMount()

FinaliseMount(TInt, TAny *, TAny *)

Parameters

FlushCachedFileInfo(TBool)

Parameters

FlushCachedFileInfoL()

ForceDismount()

ForceRemountDrive(const TDesC8 *, TInt, TUint)

Parameters

ForceUnmountFileSystemForFormatting()

FormatOpenL(CFsRequest *, TInt &, TFormatMode, const TLDFormatInfo *, const TVolFormatParam *)

CheckDisk(TInt, TAny , TAny )

ControlIO(const RMessagePtr2 &, TInt, TAny , TAny )

DirOpenL(CSessionFs , TInt &, const TDesC &, TUint, const TUidType &, CDirCB &)

FileOpenL(CFsRequest , TInt &, const TDesC &, TUint, TFileOpen, CFileCB &, CFileShare *&)

FinaliseMount(TInt, TAny , TAny )

FormatOpenL(CFsRequest , TInt &, TFormatMode, const TLDFormatInfo , const TVolFormatParam *)