<!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::Dir 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_dir.html">Dir</a> </div> </div> <div class="contents"> <h1>ost::Dir Class Reference</h1><!-- doxytag: class="ost::Dir" --><!-- doxytag: inherits="ost::File" --> <p>A low level portable directory class. <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::Dir:</div> <div class="dynsection"> <div class="center"> <img src="classost_1_1_dir.png" usemap="#ost::Dir_map" alt=""/> <map id="ost::Dir_map" name="ost::Dir_map"> <area href="classost_1_1_file.html" alt="ost::File" shape="rect" coords="0,0,55,24"/> </map> </div> </div> <p><a href="classost_1_1_dir-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#a35c68382a79e205132194c32af59ac4c">Dir</a> (const char *name=NULL)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#a7b0fb4c5e5e9ced25efcddbd2f37e00e">open</a> (const char *name)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#a8f439da41f86d01387473bc9931ef179">close</a> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#af35b160e87f5ec073b6a337f40f329d5">~Dir</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#a98c67812ca6f3f4e309e84053dd93df8">getName</a> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#abf520535c863cb5a1b94f0612f5c6ca3">operator++</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#a38d64fc32a9e901edbcf3476ef849ff1">operator++</a> (int)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#adb728806f0337320ad3aaa58220f08f1">operator*</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#a93343c7c9c4a9cab5b1ae18a160db296">rewind</a> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#ab346cc699cf34444e58bb481e2c0336b">operator!</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#a87edefd7ed55f53a9a37191542460211">isValid</a> (void)</td></tr> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#a31e1004c72a22a928aeef5fe0b5349c8">create</a> (const char *path, <a class="el" href="classost_1_1_file.html#ae2d644ff1e3bff4611e73f5526081118">Attr</a> attr=attrGroup)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#af053b6a8d527d984d16463e63fb5b78d">remove</a> (const char *path)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#aba68a83a1454700d475a66759f9ada0f">setPrefix</a> (const char *path)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_dir.html#a75d020016cddcfa03b0c1b5cddf9198c">getPrefix</a> (char *path, size_t size=PATH_MAX)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A low level portable directory class. </p> <p>Used to support ccstd Directory container. This provides a basic mechanism for allocating and accessing file entries.</p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> low level directory access class. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a35c68382a79e205132194c32af59ac4c"></a><!-- doxytag: member="ost::Dir::Dir" ref="a35c68382a79e205132194c32af59ac4c" args="(const char *name=NULL)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::Dir::Dir </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> = <code>NULL</code></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="af35b160e87f5ec073b6a337f40f329d5"></a><!-- doxytag: member="ost::Dir::~Dir" ref="af35b160e87f5ec073b6a337f40f329d5" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual ost::Dir::~Dir </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a8f439da41f86d01387473bc9931ef179"></a><!-- doxytag: member="ost::Dir::close" ref="a8f439da41f86d01387473bc9931ef179" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::Dir::close </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="a31e1004c72a22a928aeef5fe0b5349c8"></a><!-- doxytag: member="ost::Dir::create" ref="a31e1004c72a22a928aeef5fe0b5349c8" args="(const char *path, Attr attr=attrGroup)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static bool ost::Dir::create </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classost_1_1_file.html#ae2d644ff1e3bff4611e73f5526081118">Attr</a> </td> <td class="paramname"> <em>attr</em> = <code>attrGroup</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a98c67812ca6f3f4e309e84053dd93df8"></a><!-- doxytag: member="ost::Dir::getName" ref="a98c67812ca6f3f4e309e84053dd93df8" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* ost::Dir::getName </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="a75d020016cddcfa03b0c1b5cddf9198c"></a><!-- doxytag: member="ost::Dir::getPrefix" ref="a75d020016cddcfa03b0c1b5cddf9198c" args="(char *path, size_t size=PATH_MAX)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static bool ost::Dir::getPrefix </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"> <em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"> <em>size</em> = <code>PATH_MAX</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a87edefd7ed55f53a9a37191542460211"></a><!-- doxytag: member="ost::Dir::isValid" ref="a87edefd7ed55f53a9a37191542460211" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::Dir::isValid </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="a7b0fb4c5e5e9ced25efcddbd2f37e00e"></a><!-- doxytag: member="ost::Dir::open" ref="a7b0fb4c5e5e9ced25efcddbd2f37e00e" args="(const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::Dir::open </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ab346cc699cf34444e58bb481e2c0336b"></a><!-- doxytag: member="ost::Dir::operator!" ref="ab346cc699cf34444e58bb481e2c0336b" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::Dir::operator! </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="adb728806f0337320ad3aaa58220f08f1"></a><!-- doxytag: member="ost::Dir::operator*" ref="adb728806f0337320ad3aaa58220f08f1" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* ost::Dir::operator* </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a38d64fc32a9e901edbcf3476ef849ff1"></a><!-- doxytag: member="ost::Dir::operator++" ref="a38d64fc32a9e901edbcf3476ef849ff1" args="(int)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* ost::Dir::operator++ </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="abf520535c863cb5a1b94f0612f5c6ca3"></a><!-- doxytag: member="ost::Dir::operator++" ref="abf520535c863cb5a1b94f0612f5c6ca3" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* ost::Dir::operator++ </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="af053b6a8d527d984d16463e63fb5b78d"></a><!-- doxytag: member="ost::Dir::remove" ref="af053b6a8d527d984d16463e63fb5b78d" args="(const char *path)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static bool ost::Dir::remove </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>path</em></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a93343c7c9c4a9cab5b1ae18a160db296"></a><!-- doxytag: member="ost::Dir::rewind" ref="a93343c7c9c4a9cab5b1ae18a160db296" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::Dir::rewind </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="aba68a83a1454700d475a66759f9ada0f"></a><!-- doxytag: member="ost::Dir::setPrefix" ref="aba68a83a1454700d475a66759f9ada0f" args="(const char *path)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static bool ost::Dir::setPrefix </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>path</em></td> <td> ) </td> <td><code> [static]</code></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>