Berkeley DB: db_env_set_func_dirlist
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# db_env_set_func_dirlist |

`

###

    #include <db.h>

    int
    db_env_set_func_dirlist(
        int (*func_dirlist)(const char *dir, char ***namesp, int *cntp));

# Description

The Berkeley DB library requires the ability to read through a directory and create a list of files that the directory contains. The func_dirlist argument must conform to the following interface:

>     int dirlist(const char *dir, char ***namesp, int *cntp);

The dir 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 namesp argument refers, and a count of the number of elements in the array into the memory location to which cntp refers.

The func_dirlist function must return the value of errno on failure and 0 on success.

The db_env_set_func_dirlist interface affects the entire application, not a single database or database environment.

Although the db_env_set_func_dirlist interface may be used to configure Berkeley DB at any time during the life of the application, it should normally be called before making any calls to the db_env_create or db_create functions.

The db_env_set_func_dirlist function returns a non-zero error value on failure and 0 on success.

# Errors

The db_env_set_func_dirlist function may fail and return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

The db_env_set_func_dirlist function 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 function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

# See Also

db_env_set_func_close, db_env_set_func_dirfree, db_env_set_func_dirlist, db_env_set_func_exists, db_env_set_func_free, db_env_set_func_fsync, db_env_set_func_ioinfo, db_env_set_func_malloc, db_env_set_func_map, db_env_set_func_open, db_env_set_func_read, db_env_set_func_realloc, db_env_set_func_seek, db_env_set_func_sleep, db_env_set_func_unlink, db_env_set_func_unmap, db_env_set_func_write, and db_env_set_func_yield.`

Copyright Sleepycat Software