Sophie

Sophie

distrib > Mandriva > 8.2 > i586 > media > contrib > by-pkgid > 68d373e54fb21da3730c08bede406633 > files > 610

libCommonC++1.9_3-devel-1.9.4-2mdk.i586.rpm

<!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>ost::RandomFile class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.10 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ost::RandomFile  Class Reference</h1>The purpose of this class is to define a base class for low level random file access that is portable between Win32 and Posix systems. Portable random disk file access. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="file_8h-source.html">file.h</a>&gt;</code>
<p>
<p>Inheritance diagram for ost::RandomFile::
<p><center><img src="classost_1_1_random_file.gif" usemap="#ost::RandomFile_map" border="0"></center>
<map name="ost::RandomFile_map">
<area href="classost_1_1_mutex.html" alt="ost::Mutex" shape="rect" coords="111,0,212,24">
<area href="classost_1_1_mapped_file.html" alt="ost::MappedFile" shape="rect" coords="0,112,101,136">
<area href="classost_1_1_shared_file.html" alt="ost::SharedFile" shape="rect" coords="111,112,212,136">
<area href="classost_1_1_thread_file.html" alt="ost::ThreadFile" shape="rect" coords="222,112,323,136">
</map>
<a href="classost_1_1_random_file-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#a0">~RandomFile</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Destroy a random access file or it's derived class.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#a1">Initial</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This method should be called right after a <a class="el" href="classost_1_1_random_file.html">RandomFile</a> derived object has been created.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>off_t&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#a2">getCapacity</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get current file capacity.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceost.html#a5">fileerror_t</a>&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#a3">Restart</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This method is commonly used to close and re-open an existing database.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a5">fileerror_t</a>&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#a4">getErrorNumber</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return current error id.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char *&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#a5">getErrorString</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return current error string.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#a6">operator!</a> (void)</td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#b0">RandomFile</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Create an unopened random access file.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#b1">RandomFile</a> (const RandomFile &amp;rf)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default copy constructor.</em> <a href="#b1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a5">fileerror_t</a>&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#b2">Error</a> (<a class="el" href="namespaceost.html#a5">fileerror_t</a> errid, char *errstr=NULL)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Post an error event.</em> <a href="#b2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a5">fileerror_t</a>&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#b3">Error</a> (char *errstr)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Post an extended string error message.</em> <a href="#b3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#b4">setError</a> (bool enable)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Used to enable or disable throwing of exceptions on errors.</em> <a href="#b4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a5">fileerror_t</a>&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#b5">setCompletion</a> (<a class="el" href="namespaceost.html#a7">filecomplete_t</a> mode)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Used to set file completion modes.</em> <a href="#b5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#b6">setTemporary</a> (bool enable)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Used to set the temporary attribute for the file.</em> <a href="#b6">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceost.html#a4">fileattr_t</a>&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#b7">Initialize</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This method is used to initialize a newly created file as indicated by the "initial" flag.</em> <a href="#b7">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#b8">Final</a> (void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Close the file.</em> <a href="#b8">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#n0">fd</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a6">fileaccess_t</a>&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#n1">access</a></td></tr>
<tr><td nowrap align=right valign=top>char *&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#n2">pathname</a></td></tr>
<tr><td nowrap align=right valign=top>ost::RandomFile:: { ... } &nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#n8">flags</a></td></tr>
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#n3">count</a>: 16</td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#n4">thrown</a>: 1</td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#n5">initial</a>: 1</td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#n6">immediate</a>: 1</td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classost_1_1_random_file.html#n7">temp</a>: 1</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The purpose of this class is to define a base class for low level random file access that is portable between Win32 and Posix systems. Portable random disk file access.
<p>
This class is a foundation both for optimized thread shared and traditional locked file access that is commonly used to build database services, rather than the standard C++ streaming file classes.
<p>
<dl compact><dt><b>
Author: </b><dd>
David Sugar &lt;<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>&gt; </dl>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="b0" doxytag="ost::RandomFile::RandomFile"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> ost::RandomFile::RandomFile </td>
          <td class="md">(&nbsp;</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Create an unopened random access file.
<p>
    </td>
  </tr>
</table>
<a name="b1" doxytag="ost::RandomFile::RandomFile"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> ost::RandomFile::RandomFile </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const RandomFile &amp;</td>
          <td class="mdname1">&nbsp; <em>rf</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Default copy constructor.
<p>
    </td>
  </tr>
</table>
<a name="a0" doxytag="ost::RandomFile::~RandomFile"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual ost::RandomFile::~RandomFile </td>
          <td class="md">(&nbsp;</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Destroy a random access file or it's derived class.
<p>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b3" doxytag="ost::RandomFile::Error"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a5">fileerror_t</a> ost::RandomFile::Error </td>
          <td class="md">(&nbsp;</td>
          <td class="md">char *</td>
          <td class="mdname1">&nbsp; <em>errstr</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline, protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Post an extended string error message.
<p>
<dl compact><dt><b>
Returns: </b><dd>
FILE_EXTENDED_ERROR. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>error
</em>&nbsp;</td><td>
string. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="b2" doxytag="ost::RandomFile::Error"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a5">fileerror_t</a> ost::RandomFile::Error </td>
          <td class="md">(&nbsp;</td>
          <td class="md"><a class="el" href="namespaceost.html#a5">fileerror_t</a></td>
          <td class="mdname">&nbsp; <em>errid</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">char *</td>
          <td class="mdname">&nbsp; <em>errstr</em> = NULL</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Post an error event.
<p>
<dl compact><dt><b>
Returns: </b><dd>
error code. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>error
</em>&nbsp;</td><td>
code. </td></tr>
<tr><td valign=top><em>error
</em>&nbsp;</td><td>
message string. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="b8" doxytag="ost::RandomFile::Final"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void ost::RandomFile::Final </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Close the file.
<p>
    </td>
  </tr>
</table>
<a name="a1" doxytag="ost::RandomFile::Initial"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool ost::RandomFile::Initial </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This method should be called right after a <a class="el" href="classost_1_1_random_file.html">RandomFile</a> derived object has been created.
<p>
This method will invoke initialize if the object is newly created, and set file access permissions appropriately.
<p>
<dl compact><dt><b>
Returns: </b><dd>
true if file had to be initialized. </dl>    </td>
  </tr>
</table>
<a name="b7" doxytag="ost::RandomFile::Initialize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceost.html#a4">fileattr_t</a> ost::RandomFile::Initialize </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline, protected, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This method is used to initialize a newly created file as indicated by the "initial" flag.
<p>
This method also returns the file access permissions that should be associated with the file. This method should never be called directly, but is instead used to impliment the "Initial" method. Typically one would use this to build an empty database shell when a previously empty database file is created.
<p>
<dl compact><dt><b>
Returns: </b><dd>
access, or FILE_ATTR_INVALID if should be removed. </dl>    </td>
  </tr>
</table>
<a name="a3" doxytag="ost::RandomFile::Restart"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceost.html#a5">fileerror_t</a> ost::RandomFile::Restart </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This method is commonly used to close and re-open an existing database.
<p>
This may be used when the database has been unlinked and an external process provides a new one to use. 
<p>
Reimplemented in <a class="el" href="classost_1_1_thread_file.html#a2">ost::ThreadFile</a>, and <a class="el" href="classost_1_1_shared_file.html#a3">ost::SharedFile</a>.    </td>
  </tr>
</table>
<a name="a2" doxytag="ost::RandomFile::getCapacity"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> off_t ost::RandomFile::getCapacity </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get current file capacity.
<p>
<dl compact><dt><b>
Returns: </b><dd>
total file size. </dl>    </td>
  </tr>
</table>
<a name="a4" doxytag="ost::RandomFile::getErrorNumber"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a5">fileerror_t</a> ost::RandomFile::getErrorNumber </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return current error id.
<p>
<dl compact><dt><b>
Returns: </b><dd>
last error identifier set. </dl>    </td>
  </tr>
</table>
<a name="a5" doxytag="ost::RandomFile::getErrorString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> char* ost::RandomFile::getErrorString </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return current error string.
<p>
<dl compact><dt><b>
Returns: </b><dd>
last error string set. </dl>    </td>
  </tr>
</table>
<a name="a6" doxytag="ost::RandomFile::operator!"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool ost::RandomFile::operator! </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="b5" doxytag="ost::RandomFile::setCompletion"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a5">fileerror_t</a> ost::RandomFile::setCompletion </td>
          <td class="md">(&nbsp;</td>
          <td class="md"><a class="el" href="namespaceost.html#a7">filecomplete_t</a></td>
          <td class="mdname1">&nbsp; <em>mode</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Used to set file completion modes.
<p>
<dl compact><dt><b>
Returns: </b><dd>
FILE_SUCCESS if okay. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>completion
</em>&nbsp;</td><td>
mode. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="b4" doxytag="ost::RandomFile::setError"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void ost::RandomFile::setError </td>
          <td class="md">(&nbsp;</td>
          <td class="md">bool</td>
          <td class="mdname1">&nbsp; <em>enable</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline, protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Used to enable or disable throwing of exceptions on errors.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>true
</em>&nbsp;</td><td>
if errors will be thrown. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="b6" doxytag="ost::RandomFile::setTemporary"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void ost::RandomFile::setTemporary </td>
          <td class="md">(&nbsp;</td>
          <td class="md">bool</td>
          <td class="mdname1">&nbsp; <em>enable</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline, protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Used to set the temporary attribute for the file.
<p>
Temporary files are automatically deleted when closed.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>true
</em>&nbsp;</td><td>
for marking as temporary. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="n1" doxytag="ost::RandomFile::access"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a6">fileaccess_t</a> ost::RandomFile::access<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="n3" doxytag="ost::RandomFile::count"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> unsigned ost::RandomFile::count<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="n0" doxytag="ost::RandomFile::fd"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int ost::RandomFile::fd<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="n8" doxytag="ost::RandomFile::flags"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> struct { ... }   ost::RandomFile::flags<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="n6" doxytag="ost::RandomFile::immediate"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool ost::RandomFile::immediate<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="n5" doxytag="ost::RandomFile::initial"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool ost::RandomFile::initial<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="n2" doxytag="ost::RandomFile::pathname"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> char* ost::RandomFile::pathname<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="n7" doxytag="ost::RandomFile::temp"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool ost::RandomFile::temp<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="n4" doxytag="ost::RandomFile::thrown"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool ost::RandomFile::thrown<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="file_8h-source.html">file.h</a></ul>
<hr><address><small>Generated at Fri Jan 4 18:51:50 2002 for CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy;&nbsp;1997-2001</small></address>
</body>
</html>