Debian Codegraph @

doc/api/classkyotocabinet_1_1DirStream.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <title>Kyoto Cabinet: kyotocabinet::DirStream Class Reference</title>
7
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
10
11
12
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div! -->
16
17
18 <div id="titlearea">
19 <table cellspacing="0" cellpadding="0">
20 <tbody>
21 <tr style="height: 56px;">
22
23
24 <td style="padding-left: 0.5em;">
25 <div id="projectname">Kyoto Cabinet
26
27 </div>
28
29 </td>
30
31
32
33 </tr>
34 </tbody>
35 </table>
36 </div>
37
38 <!-- Generated by Doxygen 1.7.6.1 -->
39 <div id="navrow1" class="tabs">
40 <ul class="tablist">
41 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
43 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
44 <li><a href="files.html"><span>Files</span></a></li>
45 </ul>
46 </div>
47 <div id="navrow2" class="tabs2">
48 <ul class="tablist">
49 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
50 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
51 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
52 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
53 </ul>
54 </div>
55 <div id="nav-path" class="navpath">
56 <ul>
57 <li class="navelem"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a> </li>
58 <li class="navelem"><a class="el" href="classkyotocabinet_1_1DirStream.html">DirStream</a> </li>
59 </ul>
60 </div>
61 </div>
62 <div class="header">
63 <div class="summary">
64 <a href="#pub-methods">Public Member Functions</a> </div>
65 <div class="headertitle">
66 <div class="title">kyotocabinet::DirStream Class Reference</div> </div>
67 </div><!--header-->
68 <div class="contents">
69 <!-- doxytag: class="kyotocabinet::DirStream" -->
70 <p>Directory stream abstraction.
71 <a href="classkyotocabinet_1_1DirStream.html#details">More...</a></p>
72
73 <p><code>#include &lt;kcfile.h&gt;</code></p>
74
75 <p><a href="classkyotocabinet_1_1DirStream-members.html">List of all members.</a></p>
76 <table class="memberdecls">
77 <tr><td colspan="2"><h2><a name="pub-methods"></a>
78 Public Member Functions</h2></td></tr>
79 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DirStream.html#aa98a65abd29f28ec0a4dc1696d0c3895">DirStream</a> ()</td></tr>
80 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="#aa98a65abd29f28ec0a4dc1696d0c3895"></a><br/></td></tr>
81 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DirStream.html#a8a9cefcaad74c1a4779fdd550de5ca00">~DirStream</a> ()</td></tr>
82 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a8a9cefcaad74c1a4779fdd550de5ca00"></a><br/></td></tr>
83 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DirStream.html#a4bb079d87b8a6362547b4cd7cc8ba6d7">open</a> (const std::string &amp;path)</td></tr>
84 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a directory. <a href="#a4bb079d87b8a6362547b4cd7cc8ba6d7"></a><br/></td></tr>
85 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DirStream.html#abcc79ce9f03fd87dabe9aba3bbecb148">close</a> ()</td></tr>
86 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the file. <a href="#abcc79ce9f03fd87dabe9aba3bbecb148"></a><br/></td></tr>
87 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DirStream.html#ae86f20f4e4f7c7ee2c9e482cbf6ac440">read</a> (std::string *path)</td></tr>
88 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the next file in the directory. <a href="#ae86f20f4e4f7c7ee2c9e482cbf6ac440"></a><br/></td></tr>
89 </table>
90 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
91 <div class="textblock"><p>Directory stream abstraction. </p>
92 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
93 <a class="anchor" id="aa98a65abd29f28ec0a4dc1696d0c3895"></a><!-- doxytag: member="kyotocabinet::DirStream::DirStream" ref="aa98a65abd29f28ec0a4dc1696d0c3895" args="()" -->
94 <div class="memitem">
95 <div class="memproto">
96 <table class="memname">
97 <tr>
98 <td class="memname"><a class="el" href="classkyotocabinet_1_1DirStream.html#aa98a65abd29f28ec0a4dc1696d0c3895">kyotocabinet::DirStream::DirStream</a> </td>
99 <td>(</td>
100 <td class="paramname"></td><td>)</td>
101 <td><code> [explicit]</code></td>
102 </tr>
103 </table>
104 </div>
105 <div class="memdoc">
106
107 <p>Default constructor. </p>
108
109 </div>
110 </div>
111 <a class="anchor" id="a8a9cefcaad74c1a4779fdd550de5ca00"></a><!-- doxytag: member="kyotocabinet::DirStream::~DirStream" ref="a8a9cefcaad74c1a4779fdd550de5ca00" args="()" -->
112 <div class="memitem">
113 <div class="memproto">
114 <table class="memname">
115 <tr>
116 <td class="memname"><a class="el" href="classkyotocabinet_1_1DirStream.html#a8a9cefcaad74c1a4779fdd550de5ca00">kyotocabinet::DirStream::~DirStream</a> </td>
117 <td>(</td>
118 <td class="paramname"></td><td>)</td>
119 <td></td>
120 </tr>
121 </table>
122 </div>
123 <div class="memdoc">
124
125 <p>Destructor. </p>
126 <dl class="note"><dt><b>Note:</b></dt><dd>If the file is not closed, it is closed implicitly. </dd></dl>
127
128 </div>
129 </div>
130 <hr/><h2>Member Function Documentation</h2>
131 <a class="anchor" id="a4bb079d87b8a6362547b4cd7cc8ba6d7"></a><!-- doxytag: member="kyotocabinet::DirStream::open" ref="a4bb079d87b8a6362547b4cd7cc8ba6d7" args="(const std::string &amp;path)" -->
132 <div class="memitem">
133 <div class="memproto">
134 <table class="memname">
135 <tr>
136 <td class="memname">bool <a class="el" href="classkyotocabinet_1_1DirStream.html#a4bb079d87b8a6362547b4cd7cc8ba6d7">kyotocabinet::DirStream::open</a> </td>
137 <td>(</td>
138 <td class="paramtype">const std::string &amp;&#160;</td>
139 <td class="paramname"><em>path</em></td><td>)</td>
140 <td></td>
141 </tr>
142 </table>
143 </div>
144 <div class="memdoc">
145
146 <p>Open a directory. </p>
147 <dl class="params"><dt><b>Parameters:</b></dt><dd>
148 <table class="params">
149 <tr><td class="paramname">path</td><td>the path of a directory. </td></tr>
150 </table>
151 </dd>
152 </dl>
153 <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
154
155 </div>
156 </div>
157 <a class="anchor" id="abcc79ce9f03fd87dabe9aba3bbecb148"></a><!-- doxytag: member="kyotocabinet::DirStream::close" ref="abcc79ce9f03fd87dabe9aba3bbecb148" args="()" -->
158 <div class="memitem">
159 <div class="memproto">
160 <table class="memname">
161 <tr>
162 <td class="memname">bool <a class="el" href="classkyotocabinet_1_1DirStream.html#abcc79ce9f03fd87dabe9aba3bbecb148">kyotocabinet::DirStream::close</a> </td>
163 <td>(</td>
164 <td class="paramname"></td><td>)</td>
165 <td></td>
166 </tr>
167 </table>
168 </div>
169 <div class="memdoc">
170
171 <p>Close the file. </p>
172 <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
173
174 </div>
175 </div>
176 <a class="anchor" id="ae86f20f4e4f7c7ee2c9e482cbf6ac440"></a><!-- doxytag: member="kyotocabinet::DirStream::read" ref="ae86f20f4e4f7c7ee2c9e482cbf6ac440" args="(std::string *path)" -->
177 <div class="memitem">
178 <div class="memproto">
179 <table class="memname">
180 <tr>
181 <td class="memname">bool <a class="el" href="classkyotocabinet_1_1DirStream.html#ae86f20f4e4f7c7ee2c9e482cbf6ac440">kyotocabinet::DirStream::read</a> </td>
182 <td>(</td>
183 <td class="paramtype">std::string *&#160;</td>
184 <td class="paramname"><em>path</em></td><td>)</td>
185 <td></td>
186 </tr>
187 </table>
188 </div>
189 <div class="memdoc">
190
191 <p>Read the next file in the directory. </p>
192 <dl class="params"><dt><b>Parameters:</b></dt><dd>
193 <table class="params">
194 <tr><td class="paramname">path</td><td>a string to store the file path. </td></tr>
195 </table>
196 </dd>
197 </dl>
198 <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
199
200 </div>
201 </div>
202 </div><!-- contents -->
203
204
205 <hr class="footer"/><address class="footer"><small>
206 Generated on Fri May 25 2012 01:21:36 for Kyoto Cabinet by &#160;<a href="http://www.doxygen.org/index.html">
207 <img class="footer" src="doxygen.png" alt="doxygen"/>
208 </a> 1.7.6.1
209 </small></address>
210
211 </body>
212 </html>