<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU CommonC++: ost::RandomFile Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_random_file.html">RandomFile</a>
</div>
</div>
<div class="contents">
<h1>ost::RandomFile Class Reference</h1><!-- doxytag: class="ost::RandomFile" --><!-- doxytag: inherits="ost::Mutex,ost::File" -->
<p>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.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="file_8h_source.html">file.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::RandomFile:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_random_file.png" usemap="#ost::RandomFile_map" alt=""/>
<map id="ost::RandomFile_map" name="ost::RandomFile_map">
<area href="classost_1_1_mutex.html" alt="ost::Mutex" shape="rect" coords="55,0,156,24"/>
<area href="classost_1_1_file.html" alt="ost::File" shape="rect" coords="166,0,267,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>
</div>
</div>
<p><a href="classost_1_1_random_file-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#ae88353b07b9a470a4bfb83f3880d11c6">~RandomFile</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a random access file or it's derived class. <a href="#ae88353b07b9a470a4bfb83f3880d11c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a99c99374d066bb3ccc04e6469df6c737">initial</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method should be called right after a <a class="el" href="classost_1_1_random_file.html" title="The purpose of this class is to define a base class for low level random file access...">RandomFile</a> derived object has been created. <a href="#a99c99374d066bb3ccc04e6469df6c737"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">off_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#aed24526ff016216a57a179dfa7c1a70e">getCapacity</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get current file capacity. <a href="#aed24526ff016216a57a179dfa7c1a70e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#ae78c71b1e3fab5861bc9fdae595829a7">restart</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is commonly used to close and re-open an existing database. <a href="#ae78c71b1e3fab5861bc9fdae595829a7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a4c6b37d6c510619a3988eb2024e5596e">getErrorNumber</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return current error id. <a href="#a4c6b37d6c510619a3988eb2024e5596e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a161d0a323f1493fb241537c780ea50d3">getErrorString</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return current error string. <a href="#a161d0a323f1493fb241537c780ea50d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#ac6efd8f7cd9f643c9986a1b4bb537240">operator!</a> (void)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#abf33cf415283a29f6e81edcacd101178">RandomFile</a> (const char *name=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an unopened random access file. <a href="#abf33cf415283a29f6e81edcacd101178"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#afe157c3a2b21bc1d914885b3df8f61e7">RandomFile</a> (const <a class="el" href="classost_1_1_random_file.html">RandomFile</a> &rf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default copy constructor. <a href="#afe157c3a2b21bc1d914885b3df8f61e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#aa82c1311e24dd37063c05629c29d51e6">error</a> (<a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> errid, char *errstr=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Post an error event. <a href="#aa82c1311e24dd37063c05629c29d51e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a92df85d985d4fd0f4b272742243db7da">error</a> (char *err)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Post an extended string error message. <a href="#a92df85d985d4fd0f4b272742243db7da"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#af8205a0d1592268c7de8212c7c5d38b1">setError</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to enable or disable throwing of exceptions on errors. <a href="#af8205a0d1592268c7de8212c7c5d38b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#acc54d7bb92ff3d5856c89bdf146d27fa">setCompletion</a> (<a class="el" href="classost_1_1_file.html#a81c533fbe84167e862768a396ff30e32">Complete</a> mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to set file completion modes. <a href="#acc54d7bb92ff3d5856c89bdf146d27fa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a429480dd369c4058a8af0cc8ec91866a">setTemporary</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to set the temporary attribute for the file. <a href="#a429480dd369c4058a8af0cc8ec91866a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classost_1_1_file.html#ae2d644ff1e3bff4611e73f5526081118">Attr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a76af824e4cd76326652b6d84af1651b9">initialize</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is used to initialize a newly created file as indicated by the "initial" flag. <a href="#a76af824e4cd76326652b6d84af1651b9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a0013f73f6551540a4d8acb2f53092d2d">final</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the file. <a href="#a0013f73f6551540a4d8acb2f53092d2d"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#abc91558a45f6d8c78165625e01addc0c">fd</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_file.html#af371cd81457b88328c08c4501f5e8271">Access</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a36f63b4d57f5f789f4ec3cade258ceba">access</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a564788b0bea48ae7ea0155a5bf01be31">pathname</a></td></tr>
<tr><td class="memItemLeft" >struct {</td></tr>
<tr><td class="memItemLeft" > unsigned <a class="el" href="classost_1_1_random_file.html#aeda3247665dcab25eadc6c1cda60f035">count</a>: 16</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_random_file.html#a289ffc07e73dcb9498f94bbf4fba850e">thrown</a>: 1</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_random_file.html#af02ec49a4e28eeb3eefd76926ff18857">initial</a>: 1</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_random_file.html#a7b1672a1fbe2f99bee46abd9f725a3ef">immediate</a>: 1</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_random_file.html#a73521e78146eebab7d971975ee909739">temp</a>: 1</td></tr>
<tr><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a8260decf1cb2104013163b8982f19408">flags</a></td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a545b24a724aca9618b51646af6eef791">isDir</a> (const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#ae67c06e2e981b9a649f6c7fa7f023565">isFile</a> (const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a58717ca2d1464ac6e5f3503c6e275391">isDevice</a> (const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#acdb005baebbc4353cb934187b015a5ff">canAccess</a> (const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#aec847eef43d72f784d736417267f47bc">canModify</a> (const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a40311ef3c3c118efa404dea875630ac9">lastModified</a> (const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_random_file.html#a3bfd0fff55953031faf14b2b4f31d4ee">lastAccessed</a> (const char *path)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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. </p>
<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 class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> Portable random disk file access. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="abf33cf415283a29f6e81edcacd101178"></a><!-- doxytag: member="ost::RandomFile::RandomFile" ref="abf33cf415283a29f6e81edcacd101178" args="(const char *name=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::RandomFile::RandomFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> = <code>NULL</code></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an unopened random access file. </p>
</div>
</div>
<a class="anchor" id="afe157c3a2b21bc1d914885b3df8f61e7"></a><!-- doxytag: member="ost::RandomFile::RandomFile" ref="afe157c3a2b21bc1d914885b3df8f61e7" args="(const RandomFile &rf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::RandomFile::RandomFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_random_file.html">RandomFile</a> & </td>
<td class="paramname"> <em>rf</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default copy constructor. </p>
</div>
</div>
<a class="anchor" id="ae88353b07b9a470a4bfb83f3880d11c6"></a><!-- doxytag: member="ost::RandomFile::~RandomFile" ref="ae88353b07b9a470a4bfb83f3880d11c6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::RandomFile::~RandomFile </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy a random access file or it's derived class. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a92df85d985d4fd0f4b272742243db7da"></a><!-- doxytag: member="ost::RandomFile::error" ref="a92df85d985d4fd0f4b272742243db7da" args="(char *err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> ost::RandomFile::error </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>err</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Post an extended string error message. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>errExtended. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>error string. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="file_8h_source.html#l00447">error()</a>.</p>
<p>Referenced by <a class="el" href="file_8h_source.html#l00447">error()</a>.</p>
</div>
</div>
<a class="anchor" id="aa82c1311e24dd37063c05629c29d51e6"></a><!-- doxytag: member="ost::RandomFile::error" ref="aa82c1311e24dd37063c05629c29d51e6" args="(Error errid, char *errstr=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> ost::RandomFile::error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> </td>
<td class="paramname"> <em>errid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>errstr</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Post an error event. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>error code. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>errid</em> </td><td>error code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>errstr</em> </td><td>error message string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0013f73f6551540a4d8acb2f53092d2d"></a><!-- doxytag: member="ost::RandomFile::final" ref="a0013f73f6551540a4d8acb2f53092d2d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::RandomFile::final </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the file. </p>
</div>
</div>
<a class="anchor" id="aed24526ff016216a57a179dfa7c1a70e"></a><!-- doxytag: member="ost::RandomFile::getCapacity" ref="aed24526ff016216a57a179dfa7c1a70e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">off_t ost::RandomFile::getCapacity </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get current file capacity. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>total file size. </dd></dl>
</div>
</div>
<a class="anchor" id="a4c6b37d6c510619a3988eb2024e5596e"></a><!-- doxytag: member="ost::RandomFile::getErrorNumber" ref="a4c6b37d6c510619a3988eb2024e5596e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> ost::RandomFile::getErrorNumber </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return current error id. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>last error identifier set. </dd></dl>
</div>
</div>
<a class="anchor" id="a161d0a323f1493fb241537c780ea50d3"></a><!-- doxytag: member="ost::RandomFile::getErrorString" ref="a161d0a323f1493fb241537c780ea50d3" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ost::RandomFile::getErrorString </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return current error string. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>last error string set. </dd></dl>
</div>
</div>
<a class="anchor" id="a99c99374d066bb3ccc04e6469df6c737"></a><!-- doxytag: member="ost::RandomFile::initial" ref="a99c99374d066bb3ccc04e6469df6c737" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_random_file.html#af02ec49a4e28eeb3eefd76926ff18857">ost::RandomFile::initial</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method should be called right after a <a class="el" href="classost_1_1_random_file.html" title="The purpose of this class is to define a base class for low level random file access...">RandomFile</a> derived object has been created. </p>
<p>This method will invoke initialize if the object is newly created, and set file access permissions appropriately.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if file had to be initialized. </dd></dl>
</div>
</div>
<a class="anchor" id="a76af824e4cd76326652b6d84af1651b9"></a><!-- doxytag: member="ost::RandomFile::initialize" ref="a76af824e4cd76326652b6d84af1651b9" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classost_1_1_file.html#ae2d644ff1e3bff4611e73f5526081118">Attr</a> ost::RandomFile::initialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is used to initialize a newly created file as indicated by the "initial" flag. </p>
<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 class="return"><dt><b>Returns:</b></dt><dd>access, or attrInvalid if should be removed. </dd></dl>
</div>
</div>
<a class="anchor" id="ac6efd8f7cd9f643c9986a1b4bb537240"></a><!-- doxytag: member="ost::RandomFile::operator!" ref="ac6efd8f7cd9f643c9986a1b4bb537240" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::RandomFile::operator! </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae78c71b1e3fab5861bc9fdae595829a7"></a><!-- doxytag: member="ost::RandomFile::restart" ref="ae78c71b1e3fab5861bc9fdae595829a7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> ost::RandomFile::restart </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is commonly used to close and re-open an existing database. </p>
<p>This may be used when the database has been unlinked and an external process provides a new one to use. </p>
<p>Reimplemented in <a class="el" href="classost_1_1_thread_file.html#a634eeae5f8e783d26e484046344a0556">ost::ThreadFile</a>, and <a class="el" href="classost_1_1_shared_file.html#a254c43de705b9ad9f5d24536b6cff1e0">ost::SharedFile</a>.</p>
</div>
</div>
<a class="anchor" id="acc54d7bb92ff3d5856c89bdf146d27fa"></a><!-- doxytag: member="ost::RandomFile::setCompletion" ref="acc54d7bb92ff3d5856c89bdf146d27fa" args="(Complete mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_file.html#a726c26bbd45c9cb0701267a2824284e6">Error</a> ost::RandomFile::setCompletion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_file.html#a81c533fbe84167e862768a396ff30e32">Complete</a> </td>
<td class="paramname"> <em>mode</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to set file completion modes. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>errSuccess if okay. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>completion mode. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af8205a0d1592268c7de8212c7c5d38b1"></a><!-- doxytag: member="ost::RandomFile::setError" ref="af8205a0d1592268c7de8212c7c5d38b1" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::RandomFile::setError </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to enable or disable throwing of exceptions on errors. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>enable</em> </td><td>true if errors will be thrown. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a429480dd369c4058a8af0cc8ec91866a"></a><!-- doxytag: member="ost::RandomFile::setTemporary" ref="a429480dd369c4058a8af0cc8ec91866a" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::RandomFile::setTemporary </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to set the temporary attribute for the file. </p>
<p>Temporary files are automatically deleted when closed.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>enable</em> </td><td>true for marking as temporary. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="acdb005baebbc4353cb934187b015a5ff"></a><!-- doxytag: member="ost::RandomFile::canAccess" ref="acdb005baebbc4353cb934187b015a5ff" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool canAccess </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aec847eef43d72f784d736417267f47bc"></a><!-- doxytag: member="ost::RandomFile::canModify" ref="aec847eef43d72f784d736417267f47bc" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool canModify </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a58717ca2d1464ac6e5f3503c6e275391"></a><!-- doxytag: member="ost::RandomFile::isDevice" ref="a58717ca2d1464ac6e5f3503c6e275391" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isDevice </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a545b24a724aca9618b51646af6eef791"></a><!-- doxytag: member="ost::RandomFile::isDir" ref="a545b24a724aca9618b51646af6eef791" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isDir </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae67c06e2e981b9a649f6c7fa7f023565"></a><!-- doxytag: member="ost::RandomFile::isFile" ref="ae67c06e2e981b9a649f6c7fa7f023565" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3bfd0fff55953031faf14b2b4f31d4ee"></a><!-- doxytag: member="ost::RandomFile::lastAccessed" ref="a3bfd0fff55953031faf14b2b4f31d4ee" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">time_t lastAccessed </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a40311ef3c3c118efa404dea875630ac9"></a><!-- doxytag: member="ost::RandomFile::lastModified" ref="a40311ef3c3c118efa404dea875630ac9" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">time_t lastModified </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a36f63b4d57f5f789f4ec3cade258ceba"></a><!-- doxytag: member="ost::RandomFile::access" ref="a36f63b4d57f5f789f4ec3cade258ceba" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_file.html#af371cd81457b88328c08c4501f5e8271">Access</a> <a class="el" href="classost_1_1_random_file.html#a36f63b4d57f5f789f4ec3cade258ceba">ost::RandomFile::access</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aeda3247665dcab25eadc6c1cda60f035"></a><!-- doxytag: member="ost::RandomFile::count" ref="aeda3247665dcab25eadc6c1cda60f035" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned <a class="el" href="classost_1_1_random_file.html#aeda3247665dcab25eadc6c1cda60f035">ost::RandomFile::count</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="abc91558a45f6d8c78165625e01addc0c"></a><!-- doxytag: member="ost::RandomFile::fd" ref="abc91558a45f6d8c78165625e01addc0c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classost_1_1_random_file.html#abc91558a45f6d8c78165625e01addc0c">ost::RandomFile::fd</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8260decf1cb2104013163b8982f19408"></a><!-- doxytag: member="ost::RandomFile::flags" ref="a8260decf1cb2104013163b8982f19408" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct { ... } <a class="el" href="classost_1_1_random_file.html#a8260decf1cb2104013163b8982f19408">ost::RandomFile::flags</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7b1672a1fbe2f99bee46abd9f725a3ef"></a><!-- doxytag: member="ost::RandomFile::immediate" ref="a7b1672a1fbe2f99bee46abd9f725a3ef" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_random_file.html#a7b1672a1fbe2f99bee46abd9f725a3ef">ost::RandomFile::immediate</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af02ec49a4e28eeb3eefd76926ff18857"></a><!-- doxytag: member="ost::RandomFile::initial" ref="af02ec49a4e28eeb3eefd76926ff18857" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_random_file.html#af02ec49a4e28eeb3eefd76926ff18857">ost::RandomFile::initial</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a564788b0bea48ae7ea0155a5bf01be31"></a><!-- doxytag: member="ost::RandomFile::pathname" ref="a564788b0bea48ae7ea0155a5bf01be31" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="classost_1_1_random_file.html#a564788b0bea48ae7ea0155a5bf01be31">ost::RandomFile::pathname</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a73521e78146eebab7d971975ee909739"></a><!-- doxytag: member="ost::RandomFile::temp" ref="a73521e78146eebab7d971975ee909739" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_random_file.html#a73521e78146eebab7d971975ee909739">ost::RandomFile::temp</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a289ffc07e73dcb9498f94bbf4fba850e"></a><!-- doxytag: member="ost::RandomFile::thrown" ref="a289ffc07e73dcb9498f94bbf4fba850e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_random_file.html#a289ffc07e73dcb9498f94bbf4fba850e">ost::RandomFile::thrown</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<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></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
293
