1<!--$Id: set_func_dirfree.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_dirfree</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_dirfree</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_dirfree(void (*func_dirfree)(char **namesp, int cnt));
26</pre></b>
27<hr size=1 noshade>
28<b>Description: db_env_set_func_dirfree</b>
29<p>The Berkeley DB library requires the ability to return any memory allocated as part
30of the routine which reads through a directory and creates a list of files
31that the directory contains (see <a href="/api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>).</p>
32<p>The db_env_set_func_dirfree method configures all operations performed by a process and
33all of its threads of control, not operations confined to a single
34database environment.</p>
35<p>Although the db_env_set_func_dirfree method may be called at any time during the life of
36the application, it should normally be called before making calls to the
37<a href="/api_c/env_class.html">db_env_create</a> or <a href="/api_c/db_class.html">db_create</a> methods.</p>
38<p>The db_env_set_func_dirfree method
39returns a non-zero error value on failure
40and 0 on success.
41</p>
42<b>Parameters</b> <br>
43 <b>func_dirfree</b><ul compact><li>The <b>func_dirfree</b> parameter is a function which frees the memory
44returned from the <a href="/api_c/set_func_dirlist.html">db_env_set_func_dirlist</a> function.
45<p>The <b>namesp</b> and <b>cnt</b> parameters to this function are the
46same values as were returned by the <a href="/api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>
47function.</p></ul>
48<br>
49<br><b>See Also</b>
50<a href="/ref/program/runtime.html">Run-time configuration</a>
51</tt>
52<table width="100%"><tr><td><br></td><td align=right>
53<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>
54</td></tr></table>
55<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
56</body>
57</html>
58