<!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>Kyoto Cabinet: kyotocabinet::DirStream 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>
</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="namespacekyotocabinet.html">kyotocabinet</a>::<a class="el" href="classkyotocabinet_1_1DirStream.html">DirStream</a>
</div>
</div>
<div class="contents">
<h1>kyotocabinet::DirStream Class Reference</h1><!-- doxytag: class="kyotocabinet::DirStream" -->
<p>Directory stream abstraction.
<a href="#_details">More...</a></p>
<p><code>#include <kcfile.h></code></p>
<p><a href="classkyotocabinet_1_1DirStream-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="classkyotocabinet_1_1DirStream.html#aa98a65abd29f28ec0a4dc1696d0c3895">DirStream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#aa98a65abd29f28ec0a4dc1696d0c3895"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DirStream.html#a8a9cefcaad74c1a4779fdd550de5ca00">~DirStream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a8a9cefcaad74c1a4779fdd550de5ca00"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DirStream.html#a4bb079d87b8a6362547b4cd7cc8ba6d7">open</a> (const std::string &path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a directory. <a href="#a4bb079d87b8a6362547b4cd7cc8ba6d7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DirStream.html#abcc79ce9f03fd87dabe9aba3bbecb148">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the file. <a href="#abcc79ce9f03fd87dabe9aba3bbecb148"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DirStream.html#ae86f20f4e4f7c7ee2c9e482cbf6ac440">read</a> (std::string *path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the next file in the directory. <a href="#ae86f20f4e4f7c7ee2c9e482cbf6ac440"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Directory stream abstraction. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa98a65abd29f28ec0a4dc1696d0c3895"></a><!-- doxytag: member="kyotocabinet::DirStream::DirStream" ref="aa98a65abd29f28ec0a4dc1696d0c3895" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kyotocabinet::DirStream::DirStream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<a class="anchor" id="a8a9cefcaad74c1a4779fdd550de5ca00"></a><!-- doxytag: member="kyotocabinet::DirStream::~DirStream" ref="a8a9cefcaad74c1a4779fdd550de5ca00" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kyotocabinet::DirStream::~DirStream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>If the file is not closed, it is closed implicitly. </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4bb079d87b8a6362547b4cd7cc8ba6d7"></a><!-- doxytag: member="kyotocabinet::DirStream::open" ref="a4bb079d87b8a6362547b4cd7cc8ba6d7" args="(const std::string &path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::DirStream::open </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open a directory. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>the path of a directory. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="abcc79ce9f03fd87dabe9aba3bbecb148"></a><!-- doxytag: member="kyotocabinet::DirStream::close" ref="abcc79ce9f03fd87dabe9aba3bbecb148" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::DirStream::close </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the file. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ae86f20f4e4f7c7ee2c9e482cbf6ac440"></a><!-- doxytag: member="kyotocabinet::DirStream::read" ref="ae86f20f4e4f7c7ee2c9e482cbf6ac440" args="(std::string *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::DirStream::read </td>
<td>(</td>
<td class="paramtype">std::string * </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read the next file in the directory. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>a string to store the file path. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Dec 11 01:50:27 2010 for Kyoto Cabinet 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
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
c07f89287b8745f052fcf9bc1067c5c0
>
files
>
69
