CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Virtual File System (VFS)


Compounds

struct  iFile
 A replacement for FILE type in the virtual file space. More...

struct  csFileTime
 File time structure - used to query and set the last-modification time of a file. More...

struct  iVFS
 The Virtual Filesystem Class is intended to be the only way for Crystal Space engine to access the files. More...


File opening flags

#define VFS_FILE_MODE   0x0000000f
 File open mode mask. More...

#define VFS_FILE_READ   0x00000000
 Open file for reading. More...

#define VFS_FILE_WRITE   0x00000001
 Open file for writing. More...

#define VFS_FILE_UNCOMPRESSED   0x80000000
 Store file uncompressed (no gain possible). More...


File status codes

#define VFS_STATUS_OK   0
 File status ok. More...

#define VFS_STATUS_OTHER   1
 Unclassified error. More...

#define VFS_STATUS_NOSPACE   2
 Device has no more space for file data. More...

#define VFS_STATUS_RESOURCES   3
 Not enough system resources. More...

#define VFS_STATUS_ACCESSDENIED   4
 Access denied: either you have no write access, the filesystem is read-only your you tried to read a file opened for write access. More...

#define VFS_STATUS_IOERROR   5
 An error occured during reading or writing data. More...


Defines

#define ASSIGN_FILETIME(ft, tm)
 This macro can be used to assign a "struct tm" to a csFileTime. More...

#define VFS_PATH_DIVIDER   ','
 Composite path divider. More...

#define VFS_PATH_SEPARATOR   '/'
 The "virtual" path separator. More...

#define VFS_MAX_PATH_LEN   256
 The maximal "virtual" path+filename length. More...


Define Documentation

#define ASSIGN_FILETIME ft,
tm   
 

Value:

(ft).sec = (tm).tm_sec; \
  (ft).min = (tm).tm_min;       \
  (ft).hour = (tm).tm_hour;     \
  (ft).day = (tm).tm_mday;      \
  (ft).mon = (tm).tm_mon;       \
  (ft).year = (tm).tm_year + 1900;
This macro can be used to assign a "struct tm" to a csFileTime.

Definition at line 54 of file vfs.h.

#define VFS_FILE_MODE   0x0000000f
 

File open mode mask.

Definition at line 72 of file vfs.h.

#define VFS_FILE_READ   0x00000000
 

Open file for reading.

Definition at line 74 of file vfs.h.

#define VFS_FILE_UNCOMPRESSED   0x80000000
 

Store file uncompressed (no gain possible).

Definition at line 78 of file vfs.h.

#define VFS_FILE_WRITE   0x00000001
 

Open file for writing.

Definition at line 76 of file vfs.h.

#define VFS_MAX_PATH_LEN   256
 

The maximal "virtual" path+filename length.

Definition at line 67 of file vfs.h.

#define VFS_PATH_DIVIDER   ','
 

Composite path divider.

Definition at line 63 of file vfs.h.

#define VFS_PATH_SEPARATOR   '/'
 

The "virtual" path separator.

Definition at line 65 of file vfs.h.

#define VFS_STATUS_ACCESSDENIED   4
 

Access denied: either you have no write access, the filesystem is read-only your you tried to read a file opened for write access.

Definition at line 95 of file vfs.h.

#define VFS_STATUS_IOERROR   5
 

An error occured during reading or writing data.

Definition at line 97 of file vfs.h.

#define VFS_STATUS_NOSPACE   2
 

Device has no more space for file data.

Definition at line 88 of file vfs.h.

#define VFS_STATUS_OK   0
 

File status ok.

Definition at line 84 of file vfs.h.

#define VFS_STATUS_OTHER   1
 

Unclassified error.

Definition at line 86 of file vfs.h.

#define VFS_STATUS_RESOURCES   3
 

Not enough system resources.

Definition at line 90 of file vfs.h.


Generated for Crystal Space by doxygen 1.2.14