<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<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>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Kyoto Cabinet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a> </li>
<li class="navelem"><a class="el" href="classkyotocabinet_1_1DirStream.html">DirStream</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">kyotocabinet::DirStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="kyotocabinet::DirStream" -->
<p>Directory stream abstraction.
<a href="classkyotocabinet_1_1DirStream.html#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 class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Directory stream abstraction. </p>
</div><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"><a class="el" href="classkyotocabinet_1_1DirStream.html#aa98a65abd29f28ec0a4dc1696d0c3895">kyotocabinet::DirStream::DirStream</a> </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"><a class="el" href="classkyotocabinet_1_1DirStream.html#a8a9cefcaad74c1a4779fdd550de5ca00">kyotocabinet::DirStream::~DirStream</a> </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 <a class="el" href="classkyotocabinet_1_1DirStream.html#a4bb079d87b8a6362547b4cd7cc8ba6d7">kyotocabinet::DirStream::open</a> </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 class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">path</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 <a class="el" href="classkyotocabinet_1_1DirStream.html#abcc79ce9f03fd87dabe9aba3bbecb148">kyotocabinet::DirStream::close</a> </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 <a class="el" href="classkyotocabinet_1_1DirStream.html#ae86f20f4e4f7c7ee2c9e482cbf6ac440">kyotocabinet::DirStream::read</a> </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 class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">path</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><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 25 2012 01:21:36 for Kyoto Cabinet by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
