← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_cxx/logc_get.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.10.5 upstream)
  • mto: This revision was merged to the branch mainline in revision 128.
  • Revision ID: james.westby@ubuntu.com-20100517170206-xu1wmjuy40nt2sk0
Tags: upstream-2.30.1
Import upstream version 2.30.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdb/docs/api_cxx/logc_get.html
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: DbLogc::get</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>DbLogc::get</h1>
16
 
</td>
17
 
<td align=right>
18
 
<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>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
#include &lt;db_cxx.h&gt;
24
 
<p>
25
 
int
26
 
DbLogc::get(DbLsn *lsn, Dbt *data, u_int32_t flags);
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>The DbLogc::get method retrieve records from the log according to the
30
 
<b>lsn</b> and <b>flags</b> arguments.
31
 
<p>The data field of the <b>data</b> structure is set to the record
32
 
retrieved, and the size field indicates the number of bytes in the
33
 
record.  See <a href="../api_cxx/dbt_class.html">Dbt</a> for a description of other fields in the
34
 
<b>data</b> structure.  The <a href="../api_cxx/dbt_class.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a>,
35
 
<a href="../api_cxx/dbt_class.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> and <a href="../api_cxx/dbt_class.html#DB_DBT_USERMEM">DB_DBT_USERMEM</a> flags may be specified
36
 
for any <a href="../api_cxx/dbt_class.html">Dbt</a> used for data retrieval.
37
 
<p>The <b>flags</b> value must be set to one of the following values:
38
 
<p><dl compact>
39
 
<p><dt><a name="DB_FIRST">DB_FIRST</a><dd>The first record from any of the log files found in the log directory
40
 
is returned in the <b>data</b> argument.
41
 
The <b>lsn</b> argument is overwritten with the <a href="../api_cxx/lsn_class.html">DbLsn</a> of the
42
 
record returned.
43
 
<p>
44
 
If the log is empty, the DbLogc::get method will return DB_NOTFOUND.
45
 
<p><dt><a name="DB_LAST">DB_LAST</a><dd>The last record in the log is returned in the <b>data</b> argument.
46
 
The <b>lsn</b> argument is overwritten with the <a href="../api_cxx/lsn_class.html">DbLsn</a> of the
47
 
record returned.
48
 
<p>
49
 
If the log is empty, the DbLogc::get method will return DB_NOTFOUND.
50
 
<p><dt><a name="DB_NEXT">DB_NEXT</a>, <a name="DB_PREV">DB_PREV</a><dd>The current log position is advanced to the next (previous) record in
51
 
the log, and that record is returned in the <b>data</b> argument.  The
52
 
<b>lsn</b> argument is overwritten with the <a href="../api_cxx/lsn_class.html">DbLsn</a> of the record
53
 
returned.
54
 
<p>If the cursor has not been initialized via DB_FIRST, DB_LAST, DB_SET,
55
 
DB_NEXT, or DB_PREV, DbLogc::get will return the first (last) record
56
 
in the log.
57
 
If the last (first) log record has already been returned or the log is
58
 
empty, the DbLogc::get method will return DB_NOTFOUND.
59
 
If the log was opened with the DB_THREAD flag set, calls to
60
 
DbLogc::get with the DB_NEXT (DB_PREV) flag set, the DbLogc::get method either returns EINVAL or throws an exception that encapsulates EINVAL.
61
 
<p><dt><a name="DB_CURRENT">DB_CURRENT</a><dd>Return the log record to which the log currently refers.
62
 
If the log cursor has not been initialized via DB_FIRST, DB_LAST,
63
 
DB_SET, DB_NEXT, or DB_PREV, or if the log was opened with the DB_THREAD
64
 
flag set, the DbLogc::get method either returns EINVAL or throws an exception that encapsulates EINVAL.
65
 
<p><dt><a name="DB_SET">DB_SET</a><dd>Retrieve the record specified by the <b>lsn</b> argument.
66
 
If the specified <a href="../api_cxx/lsn_class.html">DbLsn</a> is invalid (for example, it does not
67
 
appear in the log), the DbLogc::get method either returns EINVAL or throws an exception that encapsulates EINVAL.
68
 
</dl>
69
 
<p>
70
 
Otherwise, the DbLogc::get method either returns a non-zero error value or throws an exception that
71
 
encapsulates a non-zero error value on failure, and returns 0 on success.
72
 
<h1>Errors</h1>
73
 
<p>The DbLogc::get method may fail and throw an exception or return a non-zero error for the following conditions:
74
 
<p><dl compact>
75
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
76
 
<p>The DB_CURRENT flag was set and the log pointer had not yet been
77
 
initialized.
78
 
<p>The DB_SET flag was set and the specified log sequence number does not
79
 
exist.
80
 
</dl>
81
 
<p>The DbLogc::get 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.
82
 
If a catastrophic error has occurred, the DbLogc::get method may fail and
83
 
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
84
 
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
85
 
in which case all subsequent Berkeley DB calls will fail in the same way.
86
 
<h1>Class</h1>
87
 
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/logc_class.html">DbLogc</a>, <a href="../api_cxx/lsn_class.html">DbLsn</a>
88
 
<h1>See Also</h1>
89
 
<a href="../api_cxx/log_list.html">Logging Subsystem and Related Methods</a>
90
 
</tt>
91
 
<table width="100%"><tr><td><br></td><td align=right>
92
 
<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>
93
 
</td></tr></table>
94
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
95
 
</body>
96
 
</html>