Berkeley DB: db_env_set_func_unmap
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_unmap |

`

###

    #include <db.h>

    int
    db_env_set_func_unmap(int (*func_unmap)(void *addr, size_t len));

# Description

The Berkeley DB library requires the ability to unmap a file or shared memory region from memory. The func_unmap argument must conform to the following interface:

>     int unmap(void *addr, size_t len);

The addr argument is the argument returned by the db_env_set_func_map function when the file or region was mapped into memory, and the len argument is the same as the len argument specified to the db_env_set_func_map function when the file or region was mapped into memory.

The func_unmap interface must return the value of errno on failure and 0 on success.

The db_env_set_func_unmap method configures all operations performed by a process and all of its threads of control, not operations confined to a single database environment.

Although the db_env_set_func_unmap interface may be called at any time during the life of the application, it should normally be called before making calls to the db_env_create or db_create methods.

The db_env_set_func_unmap method returns a non-zero error value on failure and 0 on success.

# Errors

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

# See Also

Run-time configuration`

Copyright Sleepycat Software