1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>db_env_set_func_dirfree</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB C API Reference" /> 10 <link rel="up" href="setfunc.html" title="Appendix 3. Berkeley DB Application Space Static Functions" /> 11 <link rel="prev" href="db_env_set_func_close.html" title="db_env_set_func_close" /> 12 <link rel="next" href="db_env_set_func_dirlist.html" title="db_env_set_func_dirlist" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">db_env_set_func_dirfree</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="db_env_set_func_close.html">Prev</a> </td> 22 <th width="60%" align="center">Appendix 3. 23 Berkeley DB Application Space Static Functions 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="db_env_set_func_dirlist.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="sect1" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title" style="clear: both"><a id="db_env_set_func_dirfree"></a>db_env_set_func_dirfree</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db.h> 39 40int 41db_env_set_func_dirfree(void (*func_dirfree)(char **namesp, int cnt)); </pre> 42 <p> 43 The Berkeley DB library requires the ability to return any memory 44 allocated as part of the routine which reads through a directory and 45 creates a list of files that the directory contains (see 46 <a class="xref" href="db_env_set_func_dirlist.html" title="db_env_set_func_dirlist">db_env_set_func_dirlist</a>). 47 </p> 48 <p> 49 The <code class="function">db_env_set_func_dirfree()</code> function configures all operations performed 50 by a process and all of its threads of control, not operations 51 confined to a single database environment. 52 </p> 53 <p> 54 Although the <code class="function">db_env_set_func_dirfree()</code> function may be called at any time 55 during the life of the application, it should normally be called 56 before making calls to the <a class="xref" href="envcreate.html" title="db_env_create">db_env_create</a> or 57 <a class="xref" href="dbcreate.html" title="db_create">db_create</a> methods. 58 </p> 59 <p> 60 The <code class="function">db_env_set_func_dirfree()</code> <span> 61 function returns a non-zero error value on failure and 0 on success. 62 </span> 63 </p> 64 <div class="sect2" lang="en" xml:lang="en"> 65 <div class="titlepage"> 66 <div> 67 <div> 68 <h3 class="title"><a id="id1718584"></a>Parameters</h3> 69 </div> 70 </div> 71 </div> 72 <div class="sect3" lang="en" xml:lang="en"> 73 <div class="titlepage"> 74 <div> 75 <div> 76 <h4 class="title"><a id="id1718595"></a>func_dirfree</h4> 77 </div> 78 </div> 79 </div> 80 <p> 81 The <span class="bold"><strong>func_dirfree</strong></span> parameter is a 82 function which frees the memory returned from the 83 <a class="xref" href="db_env_set_func_dirlist.html" title="db_env_set_func_dirlist">db_env_set_func_dirlist</a> 84 function. 85 </p> 86 <p> 87 The <span class="bold"><strong>namesp</strong></span> and <span class="bold"><strong>cnt</strong></span> parameters to this function are the same 88 values as were returned by the 89 <a class="xref" href="db_env_set_func_dirlist.html" title="db_env_set_func_dirlist">db_env_set_func_dirlist</a> 90 function. 91 </p> 92 </div> 93 </div> 94 <div class="sect2" lang="en" xml:lang="en"> 95 <div class="titlepage"> 96 <div> 97 <div> 98 <h3 class="title"><a id="id1718227"></a>See Also</h3> 99 </div> 100 </div> 101 </div> 102 <p> 103 <a href="../../programmer_reference/program_runtime.html" class="olink">Run-time configuration</a> 104 105 </p> 106 </div> 107 </div> 108 <div class="navfooter"> 109 <hr /> 110 <table width="100%" summary="Navigation footer"> 111 <tr> 112 <td width="40%" align="left"><a accesskey="p" href="db_env_set_func_close.html">Prev</a> </td> 113 <td width="20%" align="center"> 114 <a accesskey="u" href="setfunc.html">Up</a> 115 </td> 116 <td width="40%" align="right"> <a accesskey="n" href="db_env_set_func_dirlist.html">Next</a></td> 117 </tr> 118 <tr> 119 <td width="40%" align="left" valign="top">db_env_set_func_close </td> 120 <td width="20%" align="center"> 121 <a accesskey="h" href="index.html">Home</a> 122 </td> 123 <td width="40%" align="right" valign="top"> db_env_set_func_dirlist</td> 124 </tr> 125 </table> 126 </div> 127 </body> 128</html> 129