f32file.h File Reference

#include <f32file.h>


const TIntKDefaultDrive

The session default drive.


const TIntKDriveAbsent

Indicates a drive letter which is not in use.

This is useful when scanning a drive list to find which drives are available.


const TIntKFileServerDefaultMessageSlots

The default value for the number of message slots passed to RFs::Connect().

See also: RFs::Connect


const TIntKEntryArraySize

The size of the array of TEntry items contained in a TEntryArray object.

See also: TEntryArray TEntry


const TIntKPathDelimiter

The character used to separate directories in the path name.


const TIntKDriveDelimiter

The character used to separate the drive letter from the path.


const TIntKExtDelimiter

The character used to separate the filename from the extension.


const TIntKMaxDrives

The maximum number of available drives.


const TIntKMaxProxyDrives

The maximum number of available proxy drives.

Typedef TDriveList

typedef TBuf8< KMaxDrives >TDriveList

Defines a modifiable buffer descriptor to contain a drive list.

The descriptor has maximum length KMaxDrives, sufficient to contain all possible drive letters.

See also: RFs::DriveList KMaxDrives


const TIntKMaxDriveName

The maximum length of a drivename.

Sufficient for a drive letter and colon.

Typedef TDriveName

typedef TBuf< KMaxDriveName >TDriveName

Defines a modifiable buffer descriptor to contain a drive name.

A drive name comprises a drive letter (A through Z) and a colon. KMaxDriveName (2 bytes) is sufficient for a drive letter and colon.

See also: TDriveUnit::Name KMaxDriveName


const TIntKMaxFSNameLength

The maximum length of a file system name or file system sub type name. 32 characters is sufficient for a file system or sub type name.

Typedef TFSName

typedef TBuf< KMaxFSNameLength >TFSName

Defines a modifiable buffer descriptor to contain a file system or file system sub type name.

See also: KMaxFSNameLength


const TUintKEntryAttNormal

File/directory attribute: any file without the hidden or system attribute.


const TUintKEntryAttReadOnly

File/directory attribute: read-only file or directory.


const TUintKEntryAttHidden

File/directory attribute: hidden file or directory.


const TUintKEntryAttSystem

File/directory attribute: system file.


const TUintKEntryAttVolume

File/directory attribute: volume name directory.


const TUintKEntryAttDir

File/directory attribute: a directory without the hidden or system attribute.


const TUintKEntryAttArchive

File/directory attribute: an archive file.


const TUintKEntryAttXIP

File/directory attribute: ROM eXecute In Place file


const TUintKEntryAttRemote

This file attribute bit is set if the file exists only on a remote file system and is not locally cached.

Due to the potential high-latency of remote file systems, applications (or users of applications) may make use of this bit to modify their behaviour when working with remote files.

This is a read-only attribute, so any attempt to set this attribute will will be ignored.


const TUintKEntryAttMaskFileSystemSpecific

The range of entry attributes reserved for file-system specific meanings. File systems may assign meaning to these bits, but their definition will not be supported nor maintained by Symbian.

All other file attribute bits are reserved for use by Symbian.

The following table summarises the assignment of attribute bits:

0 - KEntryAttReadOnly 1 - KEntryAttHidden 2 - KEntryAttSystem 3 - KEntryAttVolume

4 - KEntryAttDir 6 - KEntryAttArchive 7 - KEntryAttXIP

8 - KEntryAttRemote 9 - Reserved 10 - Reserved 11 - Reserved

12 - Reserved 13 - Reserved 14 - Reserved 15 - Reserved

16 - File System Specific 17 - File System Specific 18 - File System Specific 19 - File System Specific

20 - File System Specific 22 - File System Specific 22 - File System Specific 23 - File System Specific

24 - KEntryAttPacked 25 - Reserved 26 - Reserved 27 - KEntryAttMatchExclude

28 - KEntryAttAllowUid 29 - Reserved 30 - KEntryAttMatchExclusive 31 - Reserved


const TUintKEntryAttMatchMask

Bit mask for matching file and directory entries.

This mask ensures that directories and hidden and system files are matched.

(Note that KEntryAttNormal matches all entry types except directories, hidden and system entries).

See also: RFs::GetDir


const TUintKEntryAttMaskSupported

Bit mask for matching file and directory entries.

This is used when all entry types, including hidden and system files, but excluding the volume entry are to be matched.

See also: RFs::GetDir


const TUintKEntryAttMatchExclusive

Bit mask for matching file and directory entries.

This is used for exclusive matching. When OR'ed with one or more file attribute constants, for example, KEntryAttNormal, it ensures that only the files with those attributes are matched. When OR ed with KEntryAttDir, directories only (not hidden or system) are matched.

See also: KEntryAttDir KEntryAttNormal RFs::GetDir


const TUintKEntryAttUnique

Bit mask for feature manager file entries.

It is used in order to identify each ROM feature set data file uniquely in the mount order of ROM sections.


const TUintKEntryAttMatchExclude

Bit mask for matching file and directory entries.

It is used to exclude files or directories with certain attributes from directory listings. This bitmask has the opposite effect to KEntryAttMatchExclusive. For example:


excludes all read only entries from the directory listing.

lists only read only entries.

See also: KEntryAttMatchExclusive RFs::GetDir


const TUintKEntryAttAllowUid

Bit mask for matching file and directory entries.

Bit mask flag used when UID information should be included in the directory entry listing.

See also: RFs::GetDir


const TUintKEntryAttPacked

Indicates that a TEntry (that is generally returned from a TEntryArray) is stored in packed format where the iSizeHigh and iReserved fields follow the valid characters of the name string. Before accessing the aforementioned members, the entry must be unpacked.


const TUintKMaxMapsPerCall


const TUintKFileShareMask

Bit mask provided for retrieving a file's share mode.

See also: TFileMode

Typedef TBlockArrayDes

typedef TBuf8< KMaxMapsPerCall *sizeof(TBlockMapEntry)>TBlockArrayDes

Typedef TVolFormatParamBuf

typedef TPckgBuf< TVolFormatParam >TVolFormatParamBuf

package buffer for the objects of class TVolFormatParamBuf

Typedef CFileList

typedef CDir CFileList

Contains a list of entries for the files which were opened in a file server session.

See also: CDir


const TIntKFileServerUidValue

The UID of the File Server process