1<!--$Id: set_func_dirlist.so,v 10.19 2004/08/13 03:39:02 bostic Exp $-->
2<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
3<!--See the file LICENSE for redistribution information.-->
4<html>
5<head>
6<title>Berkeley DB: db_env_set_func_dirlist</title>
7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
9</head>
10<body bgcolor=white>
11<table width="100%"><tr valign=top>
12<td>
13<b>db_env_set_func_dirlist</b>
14</td>
15<td align=right>
16<a href="/api_c/api_core.html"><img src="/images/api.gif" alt="API"></a>
17<a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a></td>
18</tr></table>
19<hr size=1 noshade>
20<tt>
21<b><pre>
22#include &lt;db.h&gt;
23<p>
24int
25db_env_set_func_dirlist(int (*func_dirlist)(const char *dir, char ***namesp, int *cntp));
26</pre></b>
27<hr size=1 noshade>
28<b>Description: db_env_set_func_dirlist</b>
29<p>The Berkeley DB library requires the ability to read through a directory and
30create a list of files that the directory contains.</p>
31<p>The db_env_set_func_dirlist method configures all operations performed by a process and
32all of its threads of control, not operations confined to a single
33database environment.</p>
34<p>Although the db_env_set_func_dirlist method may be called at any time during the life of
35the application, it should normally be called before making calls to the
36<a href="/api_c/env_class.html">db_env_create</a> or <a href="/api_c/db_class.html">db_create</a> methods.</p>
37<p>The db_env_set_func_dirlist method
38returns a non-zero error value on failure
39and 0 on success.
40</p>
41<b>Parameters</b> <br>
42 <b>func_dirlist</b><ul compact><li>The <b>func_dirlist</b> parameter is the function which reads through
43a directory and returns a list of the files it contains.
44<p>The <b>dir</b> parameter to this function is the name of the directory
45to be searched.</p>
46<p>The function must return a pointer to an array of nul-terminated file
47names into the memory location to which the <b>namesp</b> parameter
48refers, and a count of the number of elements in the array into the
49memory location to which <b>cntp</b> refers.</p></ul>
50<p>The <b>func_dirlist</b> function must return the value of <b>errno</b> on
51failure and 0 on success.</p>
52<br>
53<br><b>See Also</b>
54<a href="/ref/program/runtime.html">Run-time configuration</a>
55</tt>
56<table width="100%"><tr><td><br></td><td align=right>
57<a href="/api_c/api_core.html"><img src="/images/api.gif" alt="API"></a><a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a>
58</td></tr></table>
59<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
60</body>
61</html>
62