Sindbad~EG File Manager

Current Path : /usr/local/share/doc/db41/api_c/
Upload File :
Current File : /usr/local/share/doc/db41/api_c/set_func_dirlist.html

<!--$Id: set_func_dirlist.so,v 10.14 2002/08/24 18:24:41 bostic Exp $-->
<!--Copyright 1997-2002 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>
<h1>db_env_set_func_dirlist</h1>
</td>
<td align=right>
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include &lt;db.h&gt;
<p>
int
db_env_set_func_dirlist(
    int (*func_dirlist)(const char *dir, char ***namesp, int *cntp));
</pre></h3>
<h1>Description</h1>
<p>The Berkeley DB library requires the ability to read through a directory and
create a list of files that the directory contains.  The
<b>func_dirlist</b> argument must conform to the following interface:
<p><blockquote><pre>int dirlist(const char *dir, char ***namesp, int *cntp);</pre></blockquote>
<p>The <b>dir</b> argument is the name of the directory to be searched.
The function must return a pointer to an array of nul-terminated file
names into the memory location to which the <b>namesp</b> argument
refers, and a count of the number of elements in the array into the
memory location to which <b>cntp</b> refers.
<p>The <b>func_dirlist</b> interface must return the value of <b>errno</b> on
failure and 0 on success.
<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>Although the db_env_set_func_dirlist interface 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_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> methods.
<p>The db_env_set_func_dirlist method returns a non-zero error value on failure and 0 on success.
<h1>Errors</h1>
<p>The db_env_set_func_dirlist method may fail and return a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
</dl>
<p>The db_env_set_func_dirlist method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the db_env_set_func_dirlist method may fail and
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>See Also</h1>
<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/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>

Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists