CrystalSpace

Public API Reference

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

vfs.h File Reference

Virtual File System SCF interface. More...

#include "csutil/scf.h"
#include "csutil/ref.h"
#include "iutil/databuff.h"
#include "iutil/stringarray.h"

Go to the source code of this file.

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...


Detailed Description

Virtual File System SCF interface.

Definition in file vfs.h.


Generated for Crystal Space by doxygen 1.2.14