<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: iutil/vfs.h File Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>iutil/vfs.h File Reference</h1>Virtual File System SCF interface. <a href="#_details">More...</a> <p> <code>#include "<a class="el" href="scf_8h-source.html">csutil/scf.h</a>"</code><br> <code>#include "<a class="el" href="databuff_8h-source.html">iutil/databuff.h</a>"</code><br> <p> <a href="vfs_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Classes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsFileTime.html">csFileTime</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">File time structure - used to query and set the last-modification time of a file. <a href="structcsFileTime.html#_details">More...</a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFile.html">iFile</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A replacement for FILE type in the virtual file space. <a href="structiFile.html#_details">More...</a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structiVFS.html">iVFS</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The Virtual Filesystem Class is intended to be the only way for Crystal Space engine to access the files. <a href="structiVFS.html#_details">More...</a><br></td></tr> <tr><td colspan="2"><br><h2>Defines</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#g57d3a33621fb4710ab64f2bcfb18d30c">ASSIGN_FILETIME</a>(ft, tm)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">This macro can be used to assign a "struct tm" to a <a class="el" href="structcsFileTime.html" title="File time structure - used to query and set the last-modification time of a file...">csFileTime</a>. <a href="group__vfs.html#g57d3a33621fb4710ab64f2bcfb18d30c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#gf70c17caf04101784a2ae3f16c38b7c1">VFS_MAX_PATH_LEN</a> 256</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The maximal "virtual" path+filename length. <a href="group__vfs.html#gf70c17caf04101784a2ae3f16c38b7c1"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#g1aacdb5b87745d0bb6183c80fed81a47">VFS_PATH_DIVIDER</a> ','</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Composite path divider. <a href="group__vfs.html#g1aacdb5b87745d0bb6183c80fed81a47"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#g2968b7fe281a48fe2d905ca0bce2dad1">VFS_PATH_SEPARATOR</a> '/'</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The "virtual" path separator. <a href="group__vfs.html#g2968b7fe281a48fe2d905ca0bce2dad1"></a><br></td></tr> <tr><td colspan="2"><div class="groupHeader">File opening flags</div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#g4c74af62f4c9462116ac6890a5cc8c8f">VFS_FILE_APPEND</a> 0x00000002</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Open file for append. <a href="group__vfs.html#g4c74af62f4c9462116ac6890a5cc8c8f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#g8e6b141a580423e1d638b6964c8ebfdc">VFS_FILE_MODE</a> 0x0000000f</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">File open mode mask. <a href="group__vfs.html#g8e6b141a580423e1d638b6964c8ebfdc"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#gba6832b0add5ef2fd23abddbc8288822">VFS_FILE_READ</a> 0x00000000</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Open file for reading. <a href="group__vfs.html#gba6832b0add5ef2fd23abddbc8288822"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#gcaa8a2fbb1274d54b6d4646a667c1a75">VFS_FILE_UNCOMPRESSED</a> 0x80000000</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Store file uncompressed (no gain possible). <a href="group__vfs.html#gcaa8a2fbb1274d54b6d4646a667c1a75"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#g69dd3ad75290635fff3f282398b15647">VFS_FILE_WRITE</a> 0x00000001</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Open file for writing. <a href="group__vfs.html#g69dd3ad75290635fff3f282398b15647"></a><br></td></tr> <tr><td colspan="2"><div class="groupHeader">File status codes</div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#gf655ca2c3b3f4c242b7e719f83d73e3c">VFS_STATUS_ACCESSDENIED</a> 4</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Access denied: either you have no write access, the filesystem is read-only or you tried to read a file opened for write access. <a href="group__vfs.html#gf655ca2c3b3f4c242b7e719f83d73e3c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#gbbc89b124421b6525f9332c38767337f">VFS_STATUS_IOERROR</a> 5</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">An error occured during reading or writing data. <a href="group__vfs.html#gbbc89b124421b6525f9332c38767337f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#gca3e703c9d51b2f00aac916ce33d840e">VFS_STATUS_NOSPACE</a> 2</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Device has no more space for file data. <a href="group__vfs.html#gca3e703c9d51b2f00aac916ce33d840e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#g27ec68419e79b3faa5a2eacdaceebe47">VFS_STATUS_OK</a> 0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">File status ok. <a href="group__vfs.html#g27ec68419e79b3faa5a2eacdaceebe47"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#g22a0f09acfe1aa0f8420f86e6007ca9e">VFS_STATUS_OTHER</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Unclassified error. <a href="group__vfs.html#g22a0f09acfe1aa0f8420f86e6007ca9e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vfs.html#g10ed068e274e218f03f3faca92bfa078">VFS_STATUS_RESOURCES</a> 3</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Not enough system resources. <a href="group__vfs.html#g10ed068e274e218f03f3faca92bfa078"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Virtual File System SCF interface. <p> <p>Definition in file <a class="el" href="vfs_8h-source.html">vfs.h</a>.</p> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>