# DbEnv::lock_id

`

###

    #include <db_cxx.h>

    int
    DbEnv::lock_id(u_int32_t *idp);

# Description

The DbEnv::lock_id method copies a locker ID, which is guaranteed to be unique in the specified lock table, into the memory location to which idp refers.

The DbEnv::lock_id_free method should be called to return the locker ID to the Berkeley DB library when it is no longer needed.

The DbEnv::lock_id method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success.

# Errors

The DbEnv::lock_id method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the DbEnv::lock_id method may fail and either return DB_RUNRECOVERY or throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

DbEnv, DbLock

# See Also

Locking Subsystem and Related Methods`

Copyright Sleepycat Software