set_func_dirlist.html [plain text]
<!--$Id: set_func_dirlist.html,v 1.2 2004/03/30 01:21:42 jtownsen Exp $-->
<!--Copyright 1997-2003 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: db_env_set_func_dirlist</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td>
<h3>db_env_set_func_dirlist</h3>
</td>
<td align=right>
<a href="../api_c/api_index.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db.h>
<p>
int
db_env_set_func_dirlist(
int (*func_dirlist)(const char *dir, char ***namesp, int *cntp));
</pre></h3>
<hr size=1 noshade>
<h3>Description: db_env_set_func_dirlist</h3>
<p>The Berkeley DB library requires the ability to read through a directory and
create a list of files that the directory contains.</p>
<p>The db_env_set_func_dirlist method configures all operations performed by a process and
all of its threads of control, not operations confined to a single
database environment.</p>
<p>Although the db_env_set_func_dirlist method may be called at any time during the life of
the application, it should normally be called before making calls to the
<a href="../api_c/env_class.html">db_env_create</a> or <a href="../api_c/db_class.html">db_create</a> methods.</p>
<p>The db_env_set_func_dirlist method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<p><dl compact>
<p><dt><b>func_dirlist</b><dd>
The <b>func_dirlist</b> parameter is the function which reads through
a directory and returns a list of the files it contains.
<p>The <b>dir</b> parameter to this function is the name of the directory
to be searched.</p>
<p>The function must return a pointer to an array of nul-terminated file
names into the memory location to which the <b>namesp</b> parameter
refers, and a count of the number of elements in the array into the
memory location to which <b>cntp</b> refers.</p>
<p>The <b>func_dirlist</b> function must return the value of <b>errno</b> on
failure and 0 on success.</p>
</dl>
<h3>See Also</h3>
<a href="../ref/program/runtime.html">Run-time configuration</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/api_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>