summaryrefslogtreecommitdiff
path: root/db/docs/api_cxx/logc_close.html
blob: 22c8f50523d31bc6586a081e024e33a39432a48a (plain)
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
<!--Id: logc_close.so,v 10.3 2001/10/02 01:33:35 bostic Exp -->
<!--Copyright 1997-2001 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<html>
<head>
<title>Berkeley DB: DbLogc::logc_close</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td>
<h1>DbLogc::logc_close</h1>
</td>
<td align=right>
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include &lt;db_cxx.h&gt;
<p>
int
DbLogc::close(u_int32_t flags);
</pre></h3>
<h1>Description</h1>
<p>The DbLogc::logc_close method discards the log cursor.  After DbLogc::logc_close
has been called, regardless of its return, the cursor handle may not be
used again.
<p>The <b>flags</b> parameter is currently unused, and must be set to 0.
<p>The DbLogc::logc_close 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.
<h1>Errors</h1>
<p>The DbLogc::logc_close method may fail and throw an exception or return a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>The cursor was previously closed.
</dl>
<p>The DbLogc::logc_close 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 DbLogc::logc_close method may fail and either
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating
<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail
in the same way.
<h1>Class</h1>
<a href="../api_cxx/dbenv_class.html">DbEnv</a>
<h1>See Also</h1>
<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>,
<a href="../api_cxx/env_set_lg_dir.html">DbEnv::set_lg_dir</a>,
<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>,
<a href="../api_cxx/env_set_lg_regionmax.html">DbEnv::set_lg_regionmax</a>,
<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>,
<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>,
<a href="../api_cxx/log_cursor.html">DbEnv::log_cursor</a>,
<a href="../api_cxx/log_file.html">DbEnv::log_file</a>,
<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>,
<a href="../api_cxx/log_put.html">DbEnv::log_put</a>,
<a href="../api_cxx/log_register.html">DbEnv::log_register</a>,
<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a>,
<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>,
<a href="../api_cxx/logc_close.html">DbLogc::logc_close</a>
and
<a href="../api_cxx/logc_get.html">DbLogc::logc_get</a>.
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>