1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
|
<! "@(#)get.so 10.9 (Sleepycat) 10/4/98">
<!Copyright 1997, 1998 by Sleepycat Software, Inc. All rights reserved.>
<html>
<body bgcolor=white>
<head>
<title>Berkeley DB: lock_get</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btr
ee,hash,hashing,transaction,transactions,locking,logging,access method,access me
thods,java,C,C++">
</head>
<h1>lock_get</h1>
<hr size=1 noshade>
<tt>
<h3>
<pre>
#include <db.h>
<p>
int
lock_get(DB_LOCKTAB *lt, u_int32_t locker,
u_int32_t flags, const DBT *obj,
const db_lockmode_t lock_mode, DB_LOCK *lock);
</pre>
</h3>
<h1>Description</h1>
<p>
The lock_get function is a simple interface to the <a href="../../api_c/DbLockTab/vec.html">lock_vec</a>
functionality.
<p>
It is equivalent to calling the <a href="../../api_c/DbLockTab/vec.html">lock_vec</a> function with the
<b>lt</b>,
<b>locker</b> and <b>flags</b> arguments, and a single element
<b>list</b> array, for which the <b>op</b> field is DB_LOCK_GET,
and the <b>obj</b>, <b>lock_mode</b> and <b>lock</b> fields are
represented by the arguments of the same name.
<p>
Note that the type of the <b>obj</b> argument to lock_get is
different from the <b>obj</b> element found in the DB_LOCKREQ structure.
<p>
The lock_get function returns success and failure as described for
the <a href="../../api_c/DbLockTab/vec.html">lock_vec</a> function.
<p>
The lock_get
function returns the value of <b>errno</b> on failure, and 0 on success.
<p>
<h1>Errors</h1>
If a fatal error occurs in Berkeley DB, the lock_get function may fail and return
DB_RUNRECOVERY, at which point all subsequent database calls will also
return DB_RUNRECOVERY.
<p>
The lock_get
function may fail and return <b>errno</b>
for any of the errors specified for the following Berkeley DB and C library
functions:
abort(3),
fcntl(3),
fflush(3),
fprintf(3),
fsync(3),
getpid(3),
<a href="../../api_c/DbLockTab/detect.html">lock_detect</a>,
lseek(3),
memcpy(3),
memset(3),
mmap(3),
munmap(3),
pstat_getdynamic(3),
shmat(3),
shmdt(3),
strerror(3),
sysconf(3),
vfprintf(3),
vsnprintf(3),
and
write(3).
<p>
In addition, the lock_get
function may fail and return <b>errno</b>
for the following conditions:
<dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>
</dl>
<p>
<h1>See Also</h1>
<a href="../../api_c/DbLockTab/close.html">lock_close</a>,
<a href="../../api_c/DbLockTab/detect.html">lock_detect</a>,
lock_get,
<a href="../../api_c/DbLockTab/id.html">lock_id</a>,
<a href="../../api_c/DbLockTab/open.html">lock_open</a>,
<a href="../../api_c/DbLock/put.html">lock_put</a>,
<a href="../../api_c/DbLockTab/stat.html">lock_stat</a>,
<a href="../../api_c/DbLockTab/unlink.html">lock_unlink</a>
and
<a href="../../api_c/DbLockTab/vec.html">lock_vec</a>.
</tt>
</body>
</html>
|