|
Server : Apache/2.4.62 System : FreeBSD fbsdweb2.web.rcn.net 14.1-RELEASE FreeBSD 14.1-RELEASE releng/14.1-n267679-10e31f0946d8 GENERIC amd64 User : www ( 80) PHP Version : 8.3.8 Disable Function : NONE Directory : /usr/local/share/doc/db18/api_reference/C/ |
Upload File : |
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>db_env_set_func_dirlist</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C API Reference" />
<link rel="up" href="setfunc.html" title="Appendix C. Berkeley DB Application Space Static Functions" />
<link rel="prev" href="db_env_set_func_dirfree.html" title="db_env_set_func_dirfree" />
<link rel="next" href="db_env_set_func_exists.html" title="db_env_set_func_exists" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 18.1.40</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">db_env_set_func_dirlist</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="db_env_set_func_dirfree.html">Prev</a> </td>
<th width="60%" align="center">Appendix C.
Berkeley DB Application Space Static Functions
</th>
<td width="20%" align="right"> <a accesskey="n" href="db_env_set_func_exists.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="db_env_set_func_dirlist"></a>db_env_set_func_dirlist</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db.h>
int
db_env_set_func_dirlist(int (*func_dirlist)(const char *dir,
char ***namesp, int *cntp)); </pre>
<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 class="xref" href="envcreate.html" title="db_env_create">
<span>db_env_create</span>
</a> or
<a class="xref" href="dbcreate.html" title="db_create">
<span>db_create</span>
</a> methods.
</p>
<p>
The <code class="function">db_env_set_func_dirlist()</code> <span>
function returns a non-zero error value on failure and 0 on success.
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm139753794403456"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idm139753794403072"></a>func_dirlist</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>func_dirlist</strong></span> parameter is the
function which reads through a directory and returns a list of the
files it contains.
</p>
<p>
The <span class="bold"><strong>dir</strong></span> 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 <span class="bold"><strong>namesp</strong></span> parameter refers, and a count of the
number of elements in the array into the memory location to which
<span class="bold"><strong>cntp</strong></span> refers.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm139753794410576"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a href="../../programmer_reference/program_runtime.html" class="olink">Run-time configuration</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="db_env_set_func_dirfree.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="setfunc.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="db_env_set_func_exists.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">db_env_set_func_dirfree </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> db_env_set_func_exists</td>
</tr>
</table>
</div>
</body>
</html>