db_create
Prev | Chapter 2. The DB Handle | Next

## db_create

    #include <db.h>

    int db_create(DB **dbp, DB_ENV *dbenv, u_int32_t flags);

The `db_create()` function creates a DB structure that is the handle for a Berkeley DB database. This function allocates memory for the structure, returning a pointer to the structure in the memory to which dbp refers. To release the allocated memory and discard the handle, call the DB->close(), DB->remove(), DB->rename(), or DB->verify() methods.

DB handles are free-threaded if the DB_THREAD flag is specified to the DB->open() method when the database is opened or if the database environment in which the database is opened is free-threaded. The handle should not be closed while any other handle that refers to the database is in use; for example, database handles must not be closed while cursor handles into the database remain open, or transactions that include operations on the database have not yet been committed or aborted. Once the DB->close(), DB->remove(), DB->rename(), or DB->verify() methods are called, the handle may not be accessed again, regardless of the method's return.

The DB handle contains a special field, `app_private`, which is declared as type `void *`. This field is provided for the use of the application program. It is initialized to NULL and is not further used by Berkeley DB in any way.

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

### Parameters

#### dbp

The dbp parameter references the memory into which the returned structure pointer is stored.

#### dbenv

If the dbenv parameter is NULL, the database is standalone; that is, it is not part of any Berkeley DB environment.

If the dbenv parameter is not NULL, the database is created within the specified Berkeley DB environment. The database access methods automatically make calls to the other subsystems in Berkeley DB, based on the enclosing environment. For example, if the environment has been configured to use locking, the access methods will automatically acquire the correct locks when reading and writing pages of the database.

#### flags

The flags parameter is currently unused, and must be set to 0.

### Errors

The `db_create()` function may fail and return one of the following non-zero errors:

#### EINVAL

An invalid flag value or parameter was specified.

### Class

DB

### See Also

Database and Related Methods

Prev | Up | Next
DB->close() | Home | DB->compact()