aboutsummaryrefslogtreecommitdiff
path: root/doc/oscl_html/classOscl__FileFind.html
blob: f7157da62dd40c123087bf96a7f2a9877ba1f489 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
<!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>oscl: Oscl_FileFind 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</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>Data&nbsp;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Oscl_FileFind Class Reference<br/>
<small>
[<a class="el" href="group__osclio.html">OSCL IO</a>]</small>
</h1><!-- doxytag: class="Oscl_FileFind" -->
<p><code>#include &lt;<a class="el" href="oscl__file__find_8h_source.html">oscl_file_find.h</a>&gt;</code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2df">error_type</a> { <br/>
&nbsp;&nbsp;<a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2dfac79059044f5f2e75104893a645569e54">E_OK</a> =  0, 
<a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2dfad37ba368950a2e9105d6e4b6958014e7">E_INVALID_STATE</a>, 
<a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2dfac9e5fab739b7d6f174c44cd5f56199c7">E_INVALID_ARG</a>, 
<a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2dfa16156bfbcf845fc1abf231a42196f0b0">E_PATH_TOO_LONG</a>, 
<br/>
&nbsp;&nbsp;<a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2dfa1010b516b17eed3dc6e1412aa932b981">E_PATH_NOT_FOUND</a>, 
<a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2dfa203c3853cec9ce5fbd0dd53659c411a2">E_NO_MATCH</a>, 
<a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2dfa6af640a8270857d50f469fd54cac93d1">E_BUFFER_TOO_SMALL</a>, 
<a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2dfa43d4be9b91547d033d9f00d420144611">E_NOT_IMPLEMENTED</a>, 
<br/>
&nbsp;&nbsp;<a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2dfa9771f18bf9ebee9c689cb7ad4b44839d">E_MEMORY_ERROR</a>, 
<a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2dfaa999f2667aae5c8f05cdb2e714def367">E_OTHER</a>
<br/>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileFind.html#ab40a4a664396709c064853976146a495">element_type</a> { <a class="el" href="classOscl__FileFind.html#ab40a4a664396709c064853976146a495ae8439310fc430f859f6a81c1b6eaf028">FILE_TYPE</a> =  0, 
<a class="el" href="classOscl__FileFind.html#ab40a4a664396709c064853976146a495a70e3dcc5462562929fc4717b8870a242">DIR_TYPE</a>, 
<a class="el" href="classOscl__FileFind.html#ab40a4a664396709c064853976146a495a4fb9ac836d587c071c672defe65626a8">INVALID_TYPE</a>
 }</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileFind.html#ad722701c75f3e34a8897bf011223358d">FindFirst</a> (const char *directory, const char *pattern, char *buf, uint32 buflen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF const <a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileFind.html#ae9a3b89c347efdccab74555dc2c08926">FindFirst</a> (const <a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *directory, const <a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *pattern, <a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *buf, uint32 buflen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileFind.html#af49bbad507a5f26714b27a47e5325527">FindNext</a> (char *buf, uint32 buflen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileFind.html#abb57620684a8f3d3217b116ab46084b2">FindNext</a> (<a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *buf, uint32 buflen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileFind.html#a424d507b72d2ca103160a4d9efc27217">Close</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="classOscl__FileFind.html#ab40a4a664396709c064853976146a495">element_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileFind.html#afd1c6b5ff9c9e02d642a98f9efd3d55b">GetElementType</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2df">error_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileFind.html#ad06c0154df4a1eb78f7c637e844f7e56">GetLastError</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileFind.html#a32ad396615c5a66b87023db2a0ac2b02">Oscl_FileFind</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOscl__FileFind.html#a9fb1b4122fe20d5a9f84e36b82cc31c3">~Oscl_FileFind</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classOscl__FileFind.html">Oscl_FileFind</a> class defines the generic way of finding filesystem elements that match a pattern within a directory </p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ab40a4a664396709c064853976146a495"></a><!-- doxytag: member="Oscl_FileFind::element_type" ref="ab40a4a664396709c064853976146a495" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classOscl__FileFind.html#ab40a4a664396709c064853976146a495">Oscl_FileFind::element_type</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ab40a4a664396709c064853976146a495ae8439310fc430f859f6a81c1b6eaf028"></a><!-- doxytag: member="FILE_TYPE" ref="ab40a4a664396709c064853976146a495ae8439310fc430f859f6a81c1b6eaf028" args="" -->FILE_TYPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ab40a4a664396709c064853976146a495a70e3dcc5462562929fc4717b8870a242"></a><!-- doxytag: member="DIR_TYPE" ref="ab40a4a664396709c064853976146a495a70e3dcc5462562929fc4717b8870a242" args="" -->DIR_TYPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ab40a4a664396709c064853976146a495a4fb9ac836d587c071c672defe65626a8"></a><!-- doxytag: member="INVALID_TYPE" ref="ab40a4a664396709c064853976146a495a4fb9ac836d587c071c672defe65626a8" args="" -->INVALID_TYPE</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a class="anchor" id="ae4de731ab256c60e7cfffc1befdec2df"></a><!-- doxytag: member="Oscl_FileFind::error_type" ref="ae4de731ab256c60e7cfffc1befdec2df" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2df">Oscl_FileFind::error_type</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ae4de731ab256c60e7cfffc1befdec2dfac79059044f5f2e75104893a645569e54"></a><!-- doxytag: member="E_OK" ref="ae4de731ab256c60e7cfffc1befdec2dfac79059044f5f2e75104893a645569e54" args="" -->E_OK</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae4de731ab256c60e7cfffc1befdec2dfad37ba368950a2e9105d6e4b6958014e7"></a><!-- doxytag: member="E_INVALID_STATE" ref="ae4de731ab256c60e7cfffc1befdec2dfad37ba368950a2e9105d6e4b6958014e7" args="" -->E_INVALID_STATE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae4de731ab256c60e7cfffc1befdec2dfac9e5fab739b7d6f174c44cd5f56199c7"></a><!-- doxytag: member="E_INVALID_ARG" ref="ae4de731ab256c60e7cfffc1befdec2dfac9e5fab739b7d6f174c44cd5f56199c7" args="" -->E_INVALID_ARG</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae4de731ab256c60e7cfffc1befdec2dfa16156bfbcf845fc1abf231a42196f0b0"></a><!-- doxytag: member="E_PATH_TOO_LONG" ref="ae4de731ab256c60e7cfffc1befdec2dfa16156bfbcf845fc1abf231a42196f0b0" args="" -->E_PATH_TOO_LONG</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae4de731ab256c60e7cfffc1befdec2dfa1010b516b17eed3dc6e1412aa932b981"></a><!-- doxytag: member="E_PATH_NOT_FOUND" ref="ae4de731ab256c60e7cfffc1befdec2dfa1010b516b17eed3dc6e1412aa932b981" args="" -->E_PATH_NOT_FOUND</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae4de731ab256c60e7cfffc1befdec2dfa203c3853cec9ce5fbd0dd53659c411a2"></a><!-- doxytag: member="E_NO_MATCH" ref="ae4de731ab256c60e7cfffc1befdec2dfa203c3853cec9ce5fbd0dd53659c411a2" args="" -->E_NO_MATCH</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae4de731ab256c60e7cfffc1befdec2dfa6af640a8270857d50f469fd54cac93d1"></a><!-- doxytag: member="E_BUFFER_TOO_SMALL" ref="ae4de731ab256c60e7cfffc1befdec2dfa6af640a8270857d50f469fd54cac93d1" args="" -->E_BUFFER_TOO_SMALL</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae4de731ab256c60e7cfffc1befdec2dfa43d4be9b91547d033d9f00d420144611"></a><!-- doxytag: member="E_NOT_IMPLEMENTED" ref="ae4de731ab256c60e7cfffc1befdec2dfa43d4be9b91547d033d9f00d420144611" args="" -->E_NOT_IMPLEMENTED</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae4de731ab256c60e7cfffc1befdec2dfa9771f18bf9ebee9c689cb7ad4b44839d"></a><!-- doxytag: member="E_MEMORY_ERROR" ref="ae4de731ab256c60e7cfffc1befdec2dfa9771f18bf9ebee9c689cb7ad4b44839d" args="" -->E_MEMORY_ERROR</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae4de731ab256c60e7cfffc1befdec2dfaa999f2667aae5c8f05cdb2e714def367"></a><!-- doxytag: member="E_OTHER" ref="ae4de731ab256c60e7cfffc1befdec2dfaa999f2667aae5c8f05cdb2e714def367" args="" -->E_OTHER</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a32ad396615c5a66b87023db2a0ac2b02"></a><!-- doxytag: member="Oscl_FileFind::Oscl_FileFind" ref="a32ad396615c5a66b87023db2a0ac2b02" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF Oscl_FileFind::Oscl_FileFind </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>constructor. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl>

</div>
</div>
<a class="anchor" id="a9fb1b4122fe20d5a9f84e36b82cc31c3"></a><!-- doxytag: member="Oscl_FileFind::~Oscl_FileFind" ref="a9fb1b4122fe20d5a9f84e36b82cc31c3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF Oscl_FileFind::~Oscl_FileFind </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>destructor. will deallocate open handles if necessary</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a424d507b72d2ca103160a4d9efc27217"></a><!-- doxytag: member="Oscl_FileFind::Close" ref="a424d507b72d2ca103160a4d9efc27217" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF void Oscl_FileFind::Close </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>closes the handle to directory. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>none </dd></dl>

</div>
</div>
<a class="anchor" id="ae9a3b89c347efdccab74555dc2c08926"></a><!-- doxytag: member="Oscl_FileFind::FindFirst" ref="ae9a3b89c347efdccab74555dc2c08926" args="(const oscl_wchar *directory, const oscl_wchar *pattern, oscl_wchar *buf, uint32 buflen)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF const <a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a>* Oscl_FileFind::FindFirst </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *&nbsp;</td>
          <td class="paramname"> <em>directory</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *&nbsp;</td>
          <td class="paramname"> <em>pattern</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *&nbsp;</td>
          <td class="paramname"> <em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32&nbsp;</td>
          <td class="paramname"> <em>buflen</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Opens a directory for reading.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>directory</em>&nbsp;</td><td>directory to search (utf16). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pattern</em>&nbsp;</td><td>wildcard pattern filter (utf16). passing NULL, results in a universal match. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>buf</em>&nbsp;</td><td>buffer for returned pathname (utf16). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>buflen</em>&nbsp;</td><td>size in wide characters of buf. If buf is not large enough to hold the returned string, NULL is returned, and GetLastError is set to E_BUFFER_TOO_SMALL.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns a pointer to buffer supplied, which contains the pathname of the first found element, or NULL otherwise. On a NULL return value, <a class="el" href="classOscl__FileFind.html#ad06c0154df4a1eb78f7c637e844f7e56">GetLastError()</a> returns a more detailed error. </dd></dl>

</div>
</div>
<a class="anchor" id="ad722701c75f3e34a8897bf011223358d"></a><!-- doxytag: member="Oscl_FileFind::FindFirst" ref="ad722701c75f3e34a8897bf011223358d" args="(const char *directory, const char *pattern, char *buf, uint32 buflen)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF const char* Oscl_FileFind::FindFirst </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>directory</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pattern</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32&nbsp;</td>
          <td class="paramname"> <em>buflen</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Finds first element matching the pattern.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>directory</em>&nbsp;</td><td>directory to search (utf8). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pattern</em>&nbsp;</td><td>wildcard pattern filter (utf8). passing NULL, results in a universal match. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>buf</em>&nbsp;</td><td>buffer for returned pathname (utf8). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>buflen</em>&nbsp;</td><td>size in wide characters of buf. If buf is not large enough to hold the returned string, NULL is returned, and GetLastError is set to E_BUFFER_TOO_SMALL.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns a pointer to buffer supplied, which contains the pathname of the first found element, or NULL otherwise.On a NULL return value, <a class="el" href="classOscl__FileFind.html#ad06c0154df4a1eb78f7c637e844f7e56">GetLastError()</a> returns a more detailed error. </dd></dl>

</div>
</div>
<a class="anchor" id="abb57620684a8f3d3217b116ab46084b2"></a><!-- doxytag: member="Oscl_FileFind::FindNext" ref="abb57620684a8f3d3217b116ab46084b2" args="(oscl_wchar *buf, uint32 buflen)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF <a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a>* Oscl_FileFind::FindNext </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *&nbsp;</td>
          <td class="paramname"> <em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32&nbsp;</td>
          <td class="paramname"> <em>buflen</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Reads the next element in a directory. Note: the pointer returned by this function is not persistent and should be stored. Its scope is limited to the lifetime of the class. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>buf</em>&nbsp;</td><td>buffer to hold directory name(utf16) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>buflen</em>&nbsp;</td><td>size in wide characters of buf. If buf is not large enough to hold the returned string, NULL is returned, and GetLastError is set to E_BUFFER_TOO_SMALL. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns a pointer to buffer supplied, which contains the pathname of the next found element, or NULL otherwise. On a NULL return value, <a class="el" href="classOscl__FileFind.html#ad06c0154df4a1eb78f7c637e844f7e56">GetLastError()</a> returns a more detailed error. </dd></dl>

</div>
</div>
<a class="anchor" id="af49bbad507a5f26714b27a47e5325527"></a><!-- doxytag: member="Oscl_FileFind::FindNext" ref="af49bbad507a5f26714b27a47e5325527" args="(char *buf, uint32 buflen)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF char* Oscl_FileFind::FindNext </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32&nbsp;</td>
          <td class="paramname"> <em>buflen</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Reads the next element in the directory. Note: the pointer returned by this function is not persistent and should be stored. Its scope is limited to the lifetime of the class. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>buf</em>&nbsp;</td><td>buffer to hold directory name(utf8) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>buflen</em>&nbsp;</td><td>size in wide characters of buf. If buf is not large enough to hold the returned string, NULL is returned, and GetLastError is set to E_BUFFER_TOO_SMALL. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns a pointer to buffer supplied, which contains the pathname of the next found element, or NULL otherwise. On a NULL return value, <a class="el" href="classOscl__FileFind.html#ad06c0154df4a1eb78f7c637e844f7e56">GetLastError()</a> returns a more detailed error. </dd></dl>

</div>
</div>
<a class="anchor" id="afd1c6b5ff9c9e02d642a98f9efd3d55b"></a><!-- doxytag: member="Oscl_FileFind::GetElementType" ref="afd1c6b5ff9c9e02d642a98f9efd3d55b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF <a class="el" href="classOscl__FileFind.html#ab40a4a664396709c064853976146a495">element_type</a> Oscl_FileFind::GetElementType </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the element type for the last element returned </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>see enumeration above for more info. </dd></dl>

</div>
</div>
<a class="anchor" id="ad06c0154df4a1eb78f7c637e844f7e56"></a><!-- doxytag: member="Oscl_FileFind::GetLastError" ref="ad06c0154df4a1eb78f7c637e844f7e56" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF <a class="el" href="classOscl__FileFind.html#ae4de731ab256c60e7cfffc1befdec2df">error_type</a> Oscl_FileFind::GetLastError </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the error code for the last operation. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>see enumeration above for more info. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__file__find_8h_source.html">oscl_file_find.h</a></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: CORE_9.005.1.1 </small>
</small></address>
</body>
</html>