RFs Class Reference

class RFs : public RSessionBase

A handle to a file server session.

A program or thread may have arbitrarily many sessions open simultaneously.

Use this class for all file system manipulation, including:

1. adding, removing, moving and renaming files and directories

2. inspecting and changing file attributes and directory entry details. These include the time and date when the file or directory was last written to, its size and various attribute flags such as read-only, hidden, archive or system.

3. finding a file s real name; if the file system on which it is stored has to "mangle" the name into a shorter format

4. getting directory listings

5. maintaining a default path; unlike some other systems, there is a single system default path, rather than one for each drive: the default path consists of a drive and a path specification.

6. performing context-sensitive parses using TParse objects, and the session path

7. obtaining information on drives and volumes

8. formatting and labelling volumes

9. obtaining a list of valid drives

10. emulating the DOS subst command, which allows any directory to appear as if it were a separate drive

11. requesting notification of when significant change occurs. This can be used for programs which maintain file lists, but must update those lists when change occurs.

12. finding the version number of the file server

13. resource counting to ensure that all resources are closed when the session terminates.

This class is not intended for user derivation.

The following restrictions apply when a path is specified:

1. its total length must not exceed 256 characters

2. wildcards cannot be used in the drive or in any directory name, although they may be allowed in the filename and extension.

3. double backslashes are not allowed in the path.

4. the following characters must not be included anywhere in the path: < > " / |

5. a colon may only be included between the drive and path

6. no directory name or filename plus extension may consist solely of space characters, or of a single or double dot.

7. spaces between the drive, if specified, and the first directory in the path are illegal, although there may be spaces between other path components, for instance between directories.

Inherits from

Nested Classes and Structures

Public Member Functions
EFSRV_IMPORT_C TIntAddCompositeMount(const TDesC &, TInt, TInt, TBool)
EFSRV_IMPORT_C TIntAddExtension(const TDesC &)
EFSRV_IMPORT_C TIntAddFileSystem(const TDesC &)
EFSRV_IMPORT_C TIntAddPlugin(const TDesC &)
IMPORT_C TIntAddProxyDrive(const TDesC &)
EFSRV_IMPORT_C TIntAllowDismount(TInt)
EFSRV_IMPORT_C TIntAtt(const TDesC &, TUint &)
EFSRV_IMPORT_C TIntCharToDrive(TChar, TInt &)
EFSRV_IMPORT_C TIntCheckDisk(const TDesC &)
EFSRV_IMPORT_C TIntClearPassword(TInt, const TMediaPassword &)
EFSRV_IMPORT_C voidClose()
EFSRV_IMPORT_C TIntConnect(TInt)
EFSRV_IMPORT_C TIntControlIo(TInt, TInt)
EFSRV_IMPORT_C TIntControlIo(TInt, TInt, TDes8 &)
EFSRV_IMPORT_C TIntControlIo(TInt, TInt, TDes8 &, TDes8 &)
EFSRV_IMPORT_C TIntControlIo(TInt, TInt, TAny *, TAny *)
EFSRV_IMPORT_C TIntCreatePrivatePath(TInt)
EFSRV_IMPORT_C voidDebugNotify(TInt, TUint, TRequestStatus &)
EFSRV_IMPORT_C TIntDelete(const TDesC &)
EFSRV_IMPORT_C TIntDismountExtension(const TDesC &, TInt)
EFSRV_IMPORT_C TIntDismountFileSystem(const TDesC &, TInt)
EFSRV_IMPORT_C TIntDismountPlugin(const TDesC &)
EFSRV_IMPORT_C TIntDismountPlugin(const TDesC &, TInt)
EFSRV_IMPORT_C TIntDismountPlugin(const TDesC &, TInt, TInt)
IMPORT_C TIntDismountProxyDrive(const TUint)
EFSRV_IMPORT_C TIntDrive(TDriveInfo &, TInt)
EFSRV_IMPORT_C TIntDriveList(TDriveList &)
EFSRV_IMPORT_C TIntDriveList(TDriveList &, TUint)
EFSRV_IMPORT_C TIntDriveToChar(TInt, TChar &)
EFSRV_IMPORT_C TIntEntry(const TDesC &, TEntry &)
EFSRV_IMPORT_C TIntErasePassword(TInt)
EFSRV_IMPORT_C TIntExtensionName(TDes &, TInt, TInt)
EFSRV_IMPORT_C TIntFileSystemName(TDes &, TInt)
EFSRV_IMPORT_C TIntFileSystemSubType(TInt, TDes &)
EFSRV_IMPORT_C TIntFinaliseDrive(TInt, TFinaliseDrvMode)
EFSRV_IMPORT_C TIntFinaliseDrives()
EFSRV_IMPORT_C TIntGetDir(const TDesC &, TUint, TUint, CDir *&)
EFSRV_IMPORT_C TIntGetDir(const TDesC &, TUint, TUint, CDir *&, CDir *&)
EFSRV_IMPORT_C TIntGetDir(const TDesC &, const TUidType &, TUint, CDir *&)
EFSRV_IMPORT_C TIntGetDriveName(TInt, TDes &)
EFSRV_IMPORT_C TIntGetLongName(const TDesC &, TDes &)
EFSRV_IMPORT_C TIntGetMediaSerialNumber(TMediaSerialNumber &, TInt)
EFSRV_IMPORT_C TBoolGetNotifyUser()
EFSRV_IMPORT_C TIntGetReserveAccess(TInt)
EFSRV_IMPORT_C TIntGetShortName(const TDesC &, TDes &)
EFSRV_IMPORT_C TDriveNumberGetSystemDrive()
EFSRV_IMPORT_C TCharGetSystemDriveChar()
EFSRV_IMPORT_C TIntInitialisePropertiesFile(const TPtrC8 &)
EFSRV_IMPORT_C TUint8 *IsFileInRom(const TDesC &)
EFSRV_IMPORT_C TIntIsFileOpen(const TDesC &, TBool &)
EFSRV_IMPORT_C TBoolIsRomAddress(TAny *)
EFSRV_IMPORT_C TBoolIsValidDrive(TInt)
EFSRV_IMPORT_C TBoolIsValidName(const TDesC &)
EFSRV_IMPORT_C TBoolIsValidName(const TDesC &, TText &)
EFSRV_IMPORT_C TBoolIsValidName(const TDesC &, TNameValidParam &)
EFSRV_IMPORT_C TIntLoaderHeapFunction(TInt, TAny *, TAny *)
EFSRV_IMPORT_C TIntLockDrive(TInt, const TMediaPassword &, const TMediaPassword &, TBool)
EFSRV_IMPORT_C TIntMkDir(const TDesC &)
EFSRV_IMPORT_C TIntMkDirAll(const TDesC &)
EFSRV_IMPORT_C TIntModified(const TDesC &, TTime &)
EFSRV_IMPORT_C TIntMountExtension(const TDesC &, TInt)
EFSRV_IMPORT_C TIntMountFileSystem(const TDesC &, TInt)
EFSRV_IMPORT_C TIntMountFileSystem(const TDesC &, TInt, TBool)
EFSRV_IMPORT_C TIntMountFileSystem(const TDesC &, const TDesC &, TInt)
EFSRV_IMPORT_C TIntMountFileSystem(const TDesC &, const TDesC &, TInt, TBool)
EFSRV_IMPORT_C TIntMountFileSystemAndScan(const TDesC &, TInt, TBool &)
EFSRV_IMPORT_C TIntMountFileSystemAndScan(const TDesC &, const TDesC &, TInt, TBool &)
EFSRV_IMPORT_C TIntMountPlugin(const TDesC &)
EFSRV_IMPORT_C TIntMountPlugin(const TDesC &, TInt)
EFSRV_IMPORT_C TIntMountPlugin(const TDesC &, TInt, TInt)
TInt MountProxyDrive(const TUint, const TDesC &, T0, T1)
EFSRV_IMPORT_C voidNotifyChange(TNotifyType, TRequestStatus &)
EFSRV_IMPORT_C voidNotifyChange(TNotifyType, TRequestStatus &, const TDesC &)
EFSRV_IMPORT_C voidNotifyChangeCancel()
EFSRV_IMPORT_C voidNotifyChangeCancel(TRequestStatus &)
EFSRV_IMPORT_C voidNotifyDiskSpace(TInt64, TInt, TRequestStatus &)
EFSRV_IMPORT_C voidNotifyDiskSpaceCancel(TRequestStatus &)
EFSRV_IMPORT_C voidNotifyDiskSpaceCancel()
EFSRV_IMPORT_C voidNotifyDismount(TInt, TRequestStatus &, TNotifyDismountMode)
EFSRV_IMPORT_C voidNotifyDismountCancel(TRequestStatus &)
EFSRV_IMPORT_C voidNotifyDismountCancel()
EFSRV_IMPORT_C TIntParse(const TDesC &, TParse &)
EFSRV_IMPORT_C TIntParse(const TDesC &, const TDesC &, TParse &)
EFSRV_IMPORT_C TIntPluginName(TDes &, TInt, TInt)
EFSRV_IMPORT_C TIntPrivatePath(TDes &)
EFSRV_IMPORT_C TIntQueryVolumeInfoExt(TInt, TQueryVolumeInfoExtCmd, TDes8 &)
EFSRV_IMPORT_C TIntReadFileSection(const TDesC &, TInt64, TDes8 &, TInt)
EFSRV_IMPORT_C TIntRealName(const TDesC &, TDes &)
EFSRV_IMPORT_C TIntReleaseReserveAccess(TInt)
EFSRV_IMPORT_C TIntRemountDrive(TInt, const TDesC8 *, TUint)
EFSRV_IMPORT_C TIntRemoveExtension(const TDesC &)
EFSRV_IMPORT_C TIntRemoveFileSystem(const TDesC &)
EFSRV_IMPORT_C TIntRemovePlugin(const TDesC &)
IMPORT_C TIntRemoveProxyDrive(const TDesC &)
EFSRV_IMPORT_C TIntRename(const TDesC &, const TDesC &)
EFSRV_IMPORT_C TIntReplace(const TDesC &, const TDesC &)
EFSRV_IMPORT_C TIntReserveDriveSpace(TInt, TInt)
EFSRV_IMPORT_C TIntResourceCount()
EFSRV_IMPORT_C voidResourceCountMarkEnd()
EFSRV_IMPORT_C voidResourceCountMarkStart()
EFSRV_IMPORT_C TIntRmDir(const TDesC &)
EFSRV_IMPORT_C TIntScanDrive(const TDesC &)
EFSRV_IMPORT_C TIntSessionPath(TDes &)
EFSRV_IMPORT_C TIntSetAllocFailure(TInt)
EFSRV_IMPORT_C TIntSetAtt(const TDesC &, TUint, TUint)
EFSRV_IMPORT_C TIntSetDebugRegister(TInt)
EFSRV_IMPORT_C TIntSetDriveName(TInt, const TDesC &)
EFSRV_IMPORT_C TIntSetEntry(const TDesC &, const TTime &, TUint, TUint)
IMPORT_C TIntSetErrorCondition(TInt, TInt)
EFSRV_IMPORT_C TIntSetLocalDriveMapping(const TDesC8 &)
EFSRV_IMPORT_C TIntSetModified(const TDesC &, const TTime &)
EFSRV_IMPORT_C TIntSetNotifyChange(TBool)
EFSRV_IMPORT_C voidSetNotifyUser(TBool)
EFSRV_IMPORT_C TIntSetSessionPath(const TDesC &)
EFSRV_IMPORT_C TIntSetSessionToPrivate(TInt)
EFSRV_IMPORT_C TIntSetStartupConfiguration(TInt, TAny *, TAny *)
EFSRV_IMPORT_C TIntSetSubst(const TDesC &, TInt)
EFSRV_IMPORT_C TIntSetSystemDrive(TDriveNumber)
EFSRV_IMPORT_C TIntSetVolumeLabel(const TDesC &, TInt)
EFSRV_IMPORT_C voidStartupInitComplete(TRequestStatus &)
EFSRV_IMPORT_C TIntSubst(TDes &, TInt)
EFSRV_IMPORT_C TIntSupportedFileSystemName(TDes &, TInt, TInt)
EFSRV_IMPORT_C TIntSwapFileSystem(const TDesC &, const TDesC &, TInt)
TInt Unclamp(const RFileClamp &)
EFSRV_IMPORT_C TIntUnlockDrive(TInt, const TMediaPassword &, TBool)
EFSRV_IMPORT_C TVersionVersion()
EFSRV_IMPORT_C TIntVolume(TVolumeInfo &, TInt)
EFSRV_IMPORT_C voidVolume(TVolumeInfo &, TInt, TRequestStatus &)
EFSRV_IMPORT_C TIntVolumeIOParam(TInt, TVolumeIOParamInfo &)
Protected Member Functions
TInt SendReceive(TInt, const TIpcArgs &)
Private Member Functions
voidDoGetDirL(TUint, CDir *&, RDir &)
IMPORT_C TIntDoMountProxyDrive(const TIpcArgs &)
voidGetDirL(const TDesC &, TUint, TUint, CDir *&, CDir *&, RDir &)
voidGetDirL(const TDesC &, TUint, TUint, CDir *&, RDir &)
voidGetDirL(const TDesC &, const TUidType &, TUint, CDir *&, RDir &)
TInt GetOpenFileList(TInt &, TInt &, TThreadId &, TEntryArray &)
EFSRV_IMPORT_C TIntReadFileSection_RESERVED(const TDesC &, TInt, TDes8 &, TInt)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Public Member Enumerations
enumanonymous { KRootFileSystem = 0x00800000, KFirstChildFileSystem = 0 }
enumTFinaliseDrvMode { EFinal_RW, EFinal_RO, EForceUnfinalise }
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Inherited Attributes
RHandleBase::iHandle

Member Functions Documentation

AddCompositeMount(const TDesC &, TInt, TInt, TBool)

EFSRV_IMPORT_C TIntAddCompositeMount(const TDesC &aFileSystemName,
TIntaLocalDriveToMount,
TIntaCompositeDrive,
TBoolaSync
)const

Parameters

const TDesC & aFileSystemName
TInt aLocalDriveToMount
TInt aCompositeDrive
TBool aSync

AddExtension(const TDesC &)

EFSRV_IMPORT_C TIntAddExtension(const TDesC &aFileName)

Parameters

const TDesC & aFileName

AddFileSystem(const TDesC &)

EFSRV_IMPORT_C TIntAddFileSystem(const TDesC &aFileName)const

Parameters

const TDesC & aFileName

AddPlugin(const TDesC &)

EFSRV_IMPORT_C TIntAddPlugin(const TDesC &aFileName)const

Parameters

const TDesC & aFileName

AddProxyDrive(const TDesC &)

IMPORT_C TIntAddProxyDrive(const TDesC &aFileName)

Parameters

const TDesC & aFileName

AllowDismount(TInt)

EFSRV_IMPORT_C TIntAllowDismount(TIntaDrive)const

Parameters

TInt aDrive

Att(const TDesC &, TUint &)

EFSRV_IMPORT_C TIntAtt(const TDesC &aName,
TUint &aAttValue
)const

Parameters

const TDesC & aName
TUint & aAttValue

CharToDrive(TChar, TInt &)

EFSRV_IMPORT_C TIntCharToDrive(TCharaChar,
TInt &aDrive
)[static]

Parameters

TChar aChar
TInt & aDrive

CheckDisk(const TDesC &)

EFSRV_IMPORT_C TIntCheckDisk(const TDesC &aDrive)const

Parameters

const TDesC & aDrive

ClearPassword(TInt, const TMediaPassword &)

EFSRV_IMPORT_C TIntClearPassword(TIntaDrv,
const TMediaPassword &aPswd
)

Parameters

TInt aDrv
const TMediaPassword & aPswd

Close()

EFSRV_IMPORT_C voidClose()

Connect(TInt)

EFSRV_IMPORT_C TIntConnect(TIntaMessageSlots =  KFileServerDefaultMessageSlots )

Parameters

TInt aMessageSlots =  KFileServerDefaultMessageSlots

ControlIo(TInt, TInt)

EFSRV_IMPORT_C TIntControlIo(TIntaDrive,
TIntaCommand
)

Parameters

TInt aDrive
TInt aCommand

ControlIo(TInt, TInt, TDes8 &)

EFSRV_IMPORT_C TIntControlIo(TIntaDrive,
TIntaCommand,
TDes8 &aParam1
)

Parameters

TInt aDrive
TInt aCommand
TDes8 & aParam1

ControlIo(TInt, TInt, TDes8 &, TDes8 &)

EFSRV_IMPORT_C TIntControlIo(TIntaDrive,
TIntaCommand,
TDes8 &aParam1,
TDes8 &aParam2
)

Parameters

TInt aDrive
TInt aCommand
TDes8 & aParam1
TDes8 & aParam2

ControlIo(TInt, TInt, TAny *, TAny *)

EFSRV_IMPORT_C TIntControlIo(TIntaDrive,
TIntaCommand,
TAny *aParam1,
TAny *aParam2
)

Parameters

TInt aDrive
TInt aCommand
TAny * aParam1
TAny * aParam2

CreatePrivatePath(TInt)

EFSRV_IMPORT_C TIntCreatePrivatePath(TIntaDrive)

Parameters

TInt aDrive

DebugNotify(TInt, TUint, TRequestStatus &)

EFSRV_IMPORT_C voidDebugNotify(TIntaDrive,
TUintaNotifyType,
TRequestStatus &aStat
)

Parameters

TInt aDrive
TUint aNotifyType
TRequestStatus & aStat

Delete(const TDesC &)

EFSRV_IMPORT_C TIntDelete(const TDesC &aName)

Parameters

const TDesC & aName

DismountExtension(const TDesC &, TInt)

EFSRV_IMPORT_C TIntDismountExtension(const TDesC &aExtensionName,
TIntaDrive
)

Parameters

const TDesC & aExtensionName
TInt aDrive

DismountFileSystem(const TDesC &, TInt)

EFSRV_IMPORT_C TIntDismountFileSystem(const TDesC &aFileSystemName,
TIntaDrive
)const

Parameters

const TDesC & aFileSystemName
TInt aDrive

DismountPlugin(const TDesC &)

EFSRV_IMPORT_C TIntDismountPlugin(const TDesC &aPluginName)const

Parameters

const TDesC & aPluginName

DismountPlugin(const TDesC &, TInt)

EFSRV_IMPORT_C TIntDismountPlugin(const TDesC &aPluginName,
TIntaDrive
)const

Parameters

const TDesC & aPluginName
TInt aDrive

DismountPlugin(const TDesC &, TInt, TInt)

EFSRV_IMPORT_C TIntDismountPlugin(const TDesC &aPluginName,
TIntaDrive,
TIntaPos
)const

Parameters

const TDesC & aPluginName
TInt aDrive
TInt aPos

DismountProxyDrive(const TUint)

IMPORT_C TIntDismountProxyDrive(const TUintaDrive)

Parameters

const TUint aDrive

DoGetDirL(TUint, CDir *&, RDir &)

voidDoGetDirL(TUintanEntrySortKey,
CDir *&anEntryList,
RDir &aDir
)const [private]

Parameters

TUint anEntrySortKey
CDir *& anEntryList
RDir & aDir

DoMountProxyDrive(const TIpcArgs &)

IMPORT_C TIntDoMountProxyDrive(const TIpcArgs &ipcArgs)[private]

Parameters

const TIpcArgs & ipcArgs

Drive(TDriveInfo &, TInt)

EFSRV_IMPORT_C TIntDrive(TDriveInfo &anInfo,
TIntaDrive =  KDefaultDrive
)const

Parameters

TDriveInfo & anInfo
TInt aDrive =  KDefaultDrive

DriveList(TDriveList &)

EFSRV_IMPORT_C TIntDriveList(TDriveList &aList)const

Parameters

TDriveList & aList

DriveList(TDriveList &, TUint)

EFSRV_IMPORT_C TIntDriveList(TDriveList &aList,
TUintaFlags
)const

Parameters

TDriveList & aList
TUint aFlags

DriveToChar(TInt, TChar &)

EFSRV_IMPORT_C TIntDriveToChar(TIntaDrive,
TChar &aChar
)[static]

Parameters

TInt aDrive
TChar & aChar

Entry(const TDesC &, TEntry &)

EFSRV_IMPORT_C TIntEntry(const TDesC &aName,
TEntry &anEntry
)const

Parameters

const TDesC & aName
TEntry & anEntry

ErasePassword(TInt)

EFSRV_IMPORT_C TIntErasePassword(TIntaDrv)

Parameters

TInt aDrv

ExtensionName(TDes &, TInt, TInt)

EFSRV_IMPORT_C TIntExtensionName(TDes &aExtensionName,
TIntaDrive,
TIntaPos
)

Parameters

TDes & aExtensionName
TInt aDrive
TInt aPos

FileSystemName(TDes &, TInt)

EFSRV_IMPORT_C TIntFileSystemName(TDes &aName,
TIntaDrive
)const

Parameters

TDes & aName
TInt aDrive

FileSystemSubType(TInt, TDes &)

EFSRV_IMPORT_C TIntFileSystemSubType(TIntaDriveNo,
TDes &aName
)const

Parameters

TInt aDriveNo
TDes & aName

FinaliseDrive(TInt, TFinaliseDrvMode)

EFSRV_IMPORT_C TIntFinaliseDrive(TIntaDriveNo,
TFinaliseDrvModeaMode
)const

Parameters

TInt aDriveNo
TFinaliseDrvMode aMode

FinaliseDrives()

EFSRV_IMPORT_C TIntFinaliseDrives()

GetDir(const TDesC &, TUint, TUint, CDir *&)

EFSRV_IMPORT_C TIntGetDir(const TDesC &aName,
TUintanEntryAttMask,
TUintanEntrySortKey,
CDir *&anEntryList
)const

Parameters

const TDesC & aName
TUint anEntryAttMask
TUint anEntrySortKey
CDir *& anEntryList

GetDir(const TDesC &, TUint, TUint, CDir *&, CDir *&)

EFSRV_IMPORT_C TIntGetDir(const TDesC &aName,
TUintanEntryAttMask,
TUintanEntrySortKey,
CDir *&anEntryList,
CDir *&aDirList
)const

Parameters

const TDesC & aName
TUint anEntryAttMask
TUint anEntrySortKey
CDir *& anEntryList
CDir *& aDirList

GetDir(const TDesC &, const TUidType &, TUint, CDir *&)

EFSRV_IMPORT_C TIntGetDir(const TDesC &aName,
const TUidType &anEntryUid,
TUintanEntrySortKey,
CDir *&aFileList
)const

Parameters

const TDesC & aName
const TUidType & anEntryUid
TUint anEntrySortKey
CDir *& aFileList

GetDirL(const TDesC &, TUint, TUint, CDir *&, CDir *&, RDir &)

voidGetDirL(const TDesC &aMatchName,
TUintanEntryAttMask,
TUintanEntrySortKey,
CDir *&anEntryList,
CDir *&aDirList,
RDir &aDir
)const [private]

Parameters

const TDesC & aMatchName
TUint anEntryAttMask
TUint anEntrySortKey
CDir *& anEntryList
CDir *& aDirList
RDir & aDir

GetDirL(const TDesC &, TUint, TUint, CDir *&, RDir &)

voidGetDirL(const TDesC &aMatchName,
TUintanEntryAttMask,
TUintanEntrySortKey,
CDir *&anEntryList,
RDir &aDir
)const [private]

Parameters

const TDesC & aMatchName
TUint anEntryAttMask
TUint anEntrySortKey
CDir *& anEntryList
RDir & aDir

GetDirL(const TDesC &, const TUidType &, TUint, CDir *&, RDir &)

voidGetDirL(const TDesC &aMatchName,
const TUidType &aUidType,
TUintanEntrySortKey,
CDir *&anEntryList,
RDir &aDir
)const [private]

Parameters

const TDesC & aMatchName
const TUidType & aUidType
TUint anEntrySortKey
CDir *& anEntryList
RDir & aDir

GetDriveName(TInt, TDes &)

EFSRV_IMPORT_C TIntGetDriveName(TIntaDrive,
TDes &aDriveName
)const

Parameters

TInt aDrive
TDes & aDriveName

GetLongName(const TDesC &, TDes &)

EFSRV_IMPORT_C TIntGetLongName(const TDesC &aShortName,
TDes &aLongName
)const

Parameters

const TDesC & aShortName
TDes & aLongName

GetMediaSerialNumber(TMediaSerialNumber &, TInt)

EFSRV_IMPORT_C TIntGetMediaSerialNumber(TMediaSerialNumber &aSerialNum,
TIntaDrive
)

Parameters

TMediaSerialNumber & aSerialNum
TInt aDrive

GetNotifyUser()

EFSRV_IMPORT_C TBoolGetNotifyUser()

GetOpenFileList(TInt &, TInt &, TThreadId &, TEntryArray &)

TInt GetOpenFileList(TInt &aSessionNum,
TInt &aLocalPos,
TThreadId &aThreadId,
TEntryArray &anArray
)const [private]

Parameters

TInt & aSessionNum
TInt & aLocalPos
TThreadId & aThreadId
TEntryArray & anArray

GetReserveAccess(TInt)

EFSRV_IMPORT_C TIntGetReserveAccess(TIntaDriveNo)

Parameters

TInt aDriveNo

GetShortName(const TDesC &, TDes &)

EFSRV_IMPORT_C TIntGetShortName(const TDesC &aLongName,
TDes &aShortName
)const

Parameters

const TDesC & aLongName
TDes & aShortName

GetSystemDrive()

EFSRV_IMPORT_C TDriveNumberGetSystemDrive()[static]

GetSystemDriveChar()

EFSRV_IMPORT_C TCharGetSystemDriveChar()[static]

InitialisePropertiesFile(const TPtrC8 &)

EFSRV_IMPORT_C TIntInitialisePropertiesFile(const TPtrC8 &aPtr)const

Parameters

const TPtrC8 & aPtr

IsFileInRom(const TDesC &)

EFSRV_IMPORT_C TUint8 *IsFileInRom(const TDesC &aFileName)const

Parameters

const TDesC & aFileName

IsFileOpen(const TDesC &, TBool &)

EFSRV_IMPORT_C TIntIsFileOpen(const TDesC &aFile,
TBool &anAnswer
)const

Parameters

const TDesC & aFile
TBool & anAnswer

IsRomAddress(TAny *)

EFSRV_IMPORT_C TBoolIsRomAddress(TAny *aAny)[static]

Parameters

TAny * aAny

IsValidDrive(TInt)

EFSRV_IMPORT_C TBoolIsValidDrive(TIntaDrive)[static]

Parameters

TInt aDrive

IsValidName(const TDesC &)

EFSRV_IMPORT_C TBoolIsValidName(const TDesC &anEntryName)const

Parameters

const TDesC & anEntryName

IsValidName(const TDesC &, TText &)

EFSRV_IMPORT_C TBoolIsValidName(const TDesC &aFileName,
TText &aBadChar
)const

Parameters

const TDesC & aFileName
TText & aBadChar

IsValidName(const TDesC &, TNameValidParam &)

EFSRV_IMPORT_C TBoolIsValidName(const TDesC &aName,
TNameValidParam &aParam
)

Parameters

const TDesC & aName
TNameValidParam & aParam

LoaderHeapFunction(TInt, TAny *, TAny *)

EFSRV_IMPORT_C TIntLoaderHeapFunction(TIntaFunction,
TAny *aArg1 = NULL,
TAny *aArg2 = NULL
)

Parameters

TInt aFunction
TAny * aArg1 = NULL
TAny * aArg2 = NULL

LockDrive(TInt, const TMediaPassword &, const TMediaPassword &, TBool)

EFSRV_IMPORT_C TIntLockDrive(TIntaDrv,
const TMediaPassword &aOld,
const TMediaPassword &aNew,
TBoolaStr
)

Parameters

TInt aDrv
const TMediaPassword & aOld
const TMediaPassword & aNew
TBool aStr

MkDir(const TDesC &)

EFSRV_IMPORT_C TIntMkDir(const TDesC &aPath)

Parameters

const TDesC & aPath

MkDirAll(const TDesC &)

EFSRV_IMPORT_C TIntMkDirAll(const TDesC &aPath)

Parameters

const TDesC & aPath

Modified(const TDesC &, TTime &)

EFSRV_IMPORT_C TIntModified(const TDesC &aName,
TTime &aTime
)const

Parameters

const TDesC & aName
TTime & aTime

MountExtension(const TDesC &, TInt)

EFSRV_IMPORT_C TIntMountExtension(const TDesC &aExtensionName,
TIntaDrive
)

Parameters

const TDesC & aExtensionName
TInt aDrive

MountFileSystem(const TDesC &, TInt)

EFSRV_IMPORT_C TIntMountFileSystem(const TDesC &aFileSystemName,
TIntaDrive
)const

Parameters

const TDesC & aFileSystemName
TInt aDrive

MountFileSystem(const TDesC &, TInt, TBool)

EFSRV_IMPORT_C TIntMountFileSystem(const TDesC &aFileSystemName,
TIntaDrive,
TBoolaIsSync
)const

Parameters

const TDesC & aFileSystemName
TInt aDrive
TBool aIsSync

MountFileSystem(const TDesC &, const TDesC &, TInt)

EFSRV_IMPORT_C TIntMountFileSystem(const TDesC &aFileSystemName,
const TDesC &aExtensionName,
TIntaDrive
)

Parameters

const TDesC & aFileSystemName
const TDesC & aExtensionName
TInt aDrive

MountFileSystem(const TDesC &, const TDesC &, TInt, TBool)

EFSRV_IMPORT_C TIntMountFileSystem(const TDesC &aFileSystemName,
const TDesC &aExtensionName,
TIntaDrive,
TBoolaIsSync
)

Parameters

const TDesC & aFileSystemName
const TDesC & aExtensionName
TInt aDrive
TBool aIsSync

MountFileSystemAndScan(const TDesC &, TInt, TBool &)

EFSRV_IMPORT_C TIntMountFileSystemAndScan(const TDesC &aFileSystemName,
TIntaDrive,
TBool &aIsMountSuccess
)const

Parameters

const TDesC & aFileSystemName
TInt aDrive
TBool & aIsMountSuccess

MountFileSystemAndScan(const TDesC &, const TDesC &, TInt, TBool &)

EFSRV_IMPORT_C TIntMountFileSystemAndScan(const TDesC &aFileSystemName,
const TDesC &aExtensionName,
TIntaDrive,
TBool &aIsMountSuccess
)const

Parameters

const TDesC & aFileSystemName
const TDesC & aExtensionName
TInt aDrive
TBool & aIsMountSuccess

MountPlugin(const TDesC &)

EFSRV_IMPORT_C TIntMountPlugin(const TDesC &aPluginName)const

Parameters

const TDesC & aPluginName

MountPlugin(const TDesC &, TInt)

EFSRV_IMPORT_C TIntMountPlugin(const TDesC &aPluginName,
TIntaDrive
)const

Parameters

const TDesC & aPluginName
TInt aDrive

MountPlugin(const TDesC &, TInt, TInt)

EFSRV_IMPORT_C TIntMountPlugin(const TDesC &aPluginName,
TIntaDrive,
TIntaPos
)const

Parameters

const TDesC & aPluginName
TInt aDrive
TInt aPos

MountProxyDrive(const TUint, const TDesC &, T0, T1)

TInt MountProxyDrive(const TUintaDrive,
const TDesC &aName,
T0a0,
T1a1
)[inline]

Parameters

const TUint aDrive
const TDesC & aName
T0 a0
T1 a1

NotifyChange(TNotifyType, TRequestStatus &)

EFSRV_IMPORT_C voidNotifyChange(TNotifyTypeaType,
TRequestStatus &aStat
)

Parameters

TNotifyType aType
TRequestStatus & aStat

NotifyChange(TNotifyType, TRequestStatus &, const TDesC &)

EFSRV_IMPORT_C voidNotifyChange(TNotifyTypeaType,
TRequestStatus &aStat,
const TDesC &aPathName
)

Parameters

TNotifyType aType
TRequestStatus & aStat
const TDesC & aPathName

NotifyChangeCancel()

EFSRV_IMPORT_C voidNotifyChangeCancel()

NotifyChangeCancel(TRequestStatus &)

EFSRV_IMPORT_C voidNotifyChangeCancel(TRequestStatus &aStat)

Parameters

TRequestStatus & aStat

NotifyDiskSpace(TInt64, TInt, TRequestStatus &)

EFSRV_IMPORT_C voidNotifyDiskSpace(TInt64aThreshold,
TIntaDrive,
TRequestStatus &aStat
)

Parameters

TInt64 aThreshold
TInt aDrive
TRequestStatus & aStat

NotifyDiskSpaceCancel(TRequestStatus &)

EFSRV_IMPORT_C voidNotifyDiskSpaceCancel(TRequestStatus &aStat)

Parameters

TRequestStatus & aStat

NotifyDiskSpaceCancel()

EFSRV_IMPORT_C voidNotifyDiskSpaceCancel()

NotifyDismount(TInt, TRequestStatus &, TNotifyDismountMode)

EFSRV_IMPORT_C voidNotifyDismount(TIntaDrive,
TRequestStatus &aStat,
TNotifyDismountModeaMode = EFsDismountRegisterClient
)const

Parameters

TInt aDrive
TRequestStatus & aStat
TNotifyDismountMode aMode = EFsDismountRegisterClient

NotifyDismountCancel(TRequestStatus &)

EFSRV_IMPORT_C voidNotifyDismountCancel(TRequestStatus &aStat)const

Parameters

TRequestStatus & aStat

NotifyDismountCancel()

EFSRV_IMPORT_C voidNotifyDismountCancel()const

Parse(const TDesC &, TParse &)

EFSRV_IMPORT_C TIntParse(const TDesC &aName,
TParse &aParse
)const

Parameters

const TDesC & aName
TParse & aParse

Parse(const TDesC &, const TDesC &, TParse &)

EFSRV_IMPORT_C TIntParse(const TDesC &aName,
const TDesC &aRelated,
TParse &aParse
)const

Parameters

const TDesC & aName
const TDesC & aRelated
TParse & aParse

PluginName(TDes &, TInt, TInt)

EFSRV_IMPORT_C TIntPluginName(TDes &aPluginName,
TIntaDrive,
TIntaPos
)

Parameters

TDes & aPluginName
TInt aDrive
TInt aPos

PrivatePath(TDes &)

EFSRV_IMPORT_C TIntPrivatePath(TDes &aPath)

Parameters

TDes & aPath

QueryVolumeInfoExt(TInt, TQueryVolumeInfoExtCmd, TDes8 &)

EFSRV_IMPORT_C TIntQueryVolumeInfoExt(TIntaDrive,
TQueryVolumeInfoExtCmdaCommand,
TDes8 &aInfo
)const

Parameters

TInt aDrive
TQueryVolumeInfoExtCmd aCommand
TDes8 & aInfo

ReadFileSection(const TDesC &, TInt64, TDes8 &, TInt)

EFSRV_IMPORT_C TIntReadFileSection(const TDesC &aName,
TInt64aPos,
TDes8 &aDes,
TIntaLength
)const

Parameters

const TDesC & aName
TInt64 aPos
TDes8 & aDes
TInt aLength

ReadFileSection_RESERVED(const TDesC &, TInt, TDes8 &, TInt)

EFSRV_IMPORT_C TIntReadFileSection_RESERVED(const TDesC &aName,
TIntaPos,
TDes8 &aDes,
TIntaLength
)const [private]

Parameters

const TDesC & aName
TInt aPos
TDes8 & aDes
TInt aLength

RealName(const TDesC &, TDes &)

EFSRV_IMPORT_C TIntRealName(const TDesC &aName,
TDes &aResult
)const

Parameters

const TDesC & aName
TDes & aResult

ReleaseReserveAccess(TInt)

EFSRV_IMPORT_C TIntReleaseReserveAccess(TIntaDriveNo)

Parameters

TInt aDriveNo

RemountDrive(TInt, const TDesC8 *, TUint)

EFSRV_IMPORT_C TIntRemountDrive(TIntaDrive,
const TDesC8 *aMountInfo = NULL,
TUintaFlags = 0
)

Parameters

TInt aDrive
const TDesC8 * aMountInfo = NULL
TUint aFlags = 0

RemoveExtension(const TDesC &)

EFSRV_IMPORT_C TIntRemoveExtension(const TDesC &aExtensionName)

Parameters

const TDesC & aExtensionName

RemoveFileSystem(const TDesC &)

EFSRV_IMPORT_C TIntRemoveFileSystem(const TDesC &aFileSystemName)const

Parameters

const TDesC & aFileSystemName

RemovePlugin(const TDesC &)

EFSRV_IMPORT_C TIntRemovePlugin(const TDesC &aPluginName)const

Parameters

const TDesC & aPluginName

RemoveProxyDrive(const TDesC &)

IMPORT_C TIntRemoveProxyDrive(const TDesC &aDriveName)

Parameters

const TDesC & aDriveName

Rename(const TDesC &, const TDesC &)

EFSRV_IMPORT_C TIntRename(const TDesC &anOldName,
const TDesC &aNewName
)

Parameters

const TDesC & anOldName
const TDesC & aNewName

Replace(const TDesC &, const TDesC &)

EFSRV_IMPORT_C TIntReplace(const TDesC &anOldName,
const TDesC &aNewName
)

Parameters

const TDesC & anOldName
const TDesC & aNewName

ReserveDriveSpace(TInt, TInt)

EFSRV_IMPORT_C TIntReserveDriveSpace(TIntaDriveNo,
TIntaSpace
)

Parameters

TInt aDriveNo
TInt aSpace

ResourceCount()

EFSRV_IMPORT_C TIntResourceCount()const

ResourceCountMarkEnd()

EFSRV_IMPORT_C voidResourceCountMarkEnd()const

ResourceCountMarkStart()

EFSRV_IMPORT_C voidResourceCountMarkStart()const

RmDir(const TDesC &)

EFSRV_IMPORT_C TIntRmDir(const TDesC &aPath)

Parameters

const TDesC & aPath

ScanDrive(const TDesC &)

EFSRV_IMPORT_C TIntScanDrive(const TDesC &aDrive)const

Parameters

const TDesC & aDrive

SendReceive(TInt, const TIpcArgs &)

TInt SendReceive(TIntaFunction,
const TIpcArgs &aArgs
)const [protected]

Issues a synchronous request to the server with the specified function number and arguments.

KErrNone, if the send operation is successful; KErrServerTerminated, if the server no longer present; KErrServerBusy, if there are no message slots available; KErrNoMemory, if there is insufficient memory available.

panic

USER 72 if the function number is negative.

Parameters

TInt aFunctionThe function number identifying the request.
const TIpcArgs & aArgsA set of up to 4 arguments and their types to be passed to the server.

SessionPath(TDes &)

EFSRV_IMPORT_C TIntSessionPath(TDes &aPath)const

Parameters

TDes & aPath

SetAllocFailure(TInt)

EFSRV_IMPORT_C TIntSetAllocFailure(TIntaAllocNum)

Parameters

TInt aAllocNum

SetAtt(const TDesC &, TUint, TUint)

EFSRV_IMPORT_C TIntSetAtt(const TDesC &aName,
TUintaSetAttMask,
TUintaClearAttMask
)

Parameters

const TDesC & aName
TUint aSetAttMask
TUint aClearAttMask

SetDebugRegister(TInt)

EFSRV_IMPORT_C TIntSetDebugRegister(TIntaVal)

Parameters

TInt aVal

SetDriveName(TInt, const TDesC &)

EFSRV_IMPORT_C TIntSetDriveName(TIntaDrive,
const TDesC &aDriveName
)

Parameters

TInt aDrive
const TDesC & aDriveName

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

EFSRV_IMPORT_C TIntSetEntry(const TDesC &aName,
const TTime &aTime,
TUintaSetAttMask,
TUintaClearAttMask
)

Parameters

const TDesC & aName
const TTime & aTime
TUint aSetAttMask
TUint aClearAttMask

SetErrorCondition(TInt, TInt)

IMPORT_C TIntSetErrorCondition(TIntanError,
TIntaCount = 0
)

Parameters

TInt anError
TInt aCount = 0

SetLocalDriveMapping(const TDesC8 &)

EFSRV_IMPORT_C TIntSetLocalDriveMapping(const TDesC8 &aMapping)

Parameters

const TDesC8 & aMapping

SetModified(const TDesC &, const TTime &)

EFSRV_IMPORT_C TIntSetModified(const TDesC &aName,
const TTime &aTime
)

Parameters

const TDesC & aName
const TTime & aTime

SetNotifyChange(TBool)

EFSRV_IMPORT_C TIntSetNotifyChange(TBoolaNotifyChange)

Parameters

TBool aNotifyChange

SetNotifyUser(TBool)

EFSRV_IMPORT_C voidSetNotifyUser(TBoolaValue)

Parameters

TBool aValue

SetSessionPath(const TDesC &)

EFSRV_IMPORT_C TIntSetSessionPath(const TDesC &aPath)

Parameters

const TDesC & aPath

SetSessionToPrivate(TInt)

EFSRV_IMPORT_C TIntSetSessionToPrivate(TIntaDrive)

Parameters

TInt aDrive

SetStartupConfiguration(TInt, TAny *, TAny *)

EFSRV_IMPORT_C TIntSetStartupConfiguration(TIntaCommand,
TAny *aParam1,
TAny *aParam2
)const

Parameters

TInt aCommand
TAny * aParam1
TAny * aParam2

SetSubst(const TDesC &, TInt)

EFSRV_IMPORT_C TIntSetSubst(const TDesC &aPath,
TIntaDrive =  KDefaultDrive
)

Parameters

const TDesC & aPath
TInt aDrive =  KDefaultDrive

SetSystemDrive(TDriveNumber)

EFSRV_IMPORT_C TIntSetSystemDrive(TDriveNumberaSystemDrive)

Parameters

TDriveNumber aSystemDrive

SetVolumeLabel(const TDesC &, TInt)

EFSRV_IMPORT_C TIntSetVolumeLabel(const TDesC &aName,
TIntaDrive =  KDefaultDrive
)

Parameters

const TDesC & aName
TInt aDrive =  KDefaultDrive

StartupInitComplete(TRequestStatus &)

EFSRV_IMPORT_C voidStartupInitComplete(TRequestStatus &aStat)

Parameters

TRequestStatus & aStat

Subst(TDes &, TInt)

EFSRV_IMPORT_C TIntSubst(TDes &aPath,
TIntaDrive =  KDefaultDrive
)const

Parameters

TDes & aPath
TInt aDrive =  KDefaultDrive

SupportedFileSystemName(TDes &, TInt, TInt)

EFSRV_IMPORT_C TIntSupportedFileSystemName(TDes &aName,
TIntaDrive,
TIntaFsEnumerator
)const

Parameters

TDes & aName
TInt aDrive
TInt aFsEnumerator

SwapFileSystem(const TDesC &, const TDesC &, TInt)

EFSRV_IMPORT_C TIntSwapFileSystem(const TDesC &aOldFileSystemName,
const TDesC &aNewFileSystemName,
TIntaDrive
)const

Parameters

const TDesC & aOldFileSystemName
const TDesC & aNewFileSystemName
TInt aDrive

Unclamp(const RFileClamp &)

TInt Unclamp(const RFileClamp &aHandle)

Parameters

const RFileClamp & aHandle

UnlockDrive(TInt, const TMediaPassword &, TBool)

EFSRV_IMPORT_C TIntUnlockDrive(TIntaDrv,
const TMediaPassword &Pswd,
TBoolaStr
)

Parameters

TInt aDrv
const TMediaPassword & Pswd
TBool aStr

Version()

EFSRV_IMPORT_C TVersionVersion()const

Volume(TVolumeInfo &, TInt)

EFSRV_IMPORT_C TIntVolume(TVolumeInfo &aVol,
TIntaDrive =  KDefaultDrive
)const

Parameters

TVolumeInfo & aVol
TInt aDrive =  KDefaultDrive

Volume(TVolumeInfo &, TInt, TRequestStatus &)

EFSRV_IMPORT_C voidVolume(TVolumeInfo &aVol,
TIntaDrive,
TRequestStatus &aStat
)const

Parameters

TVolumeInfo & aVol
TInt aDrive
TRequestStatus & aStat

VolumeIOParam(TInt, TVolumeIOParamInfo &)

EFSRV_IMPORT_C TIntVolumeIOParam(TIntaDriveNo,
TVolumeIOParamInfo &aParamInfo
)const

Parameters

TInt aDriveNo
TVolumeIOParamInfo & aParamInfo

Member Enumerations Documentation

Enum anonymous

Special enumerator values for the SupportedFileSystemName() API

Enumerators

KRootFileSystem = 0x00800000
KFirstChildFileSystem = 0

Enum TFinaliseDrvMode

specifies drive finalisation modes

Enumerators

EFinal_RW
EFinal_RO
EForceUnfinalise