Edit File - File Manager

Edit File: logc_get.html

<html>
<head>
<title>Berkeley DB: DB_LOGC-&gt;get</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
DB_LOGC-&gt;get
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db.h&gt;

int
DB_LOGC-&gt;get(DB_LOGC *logc, DB_LSN *lsn, DBT *data, u_int32_t flags);
</pre>
<hr size=1 noshade>
Description: DB_LOGC-&gt;get
The DB_LOGC-&gt;get method returns records from the log.
Unless otherwise specified, the DB_LOGC-&gt;get method
returns a non-zero error value on failure
and 0 on success.

Parameters 
 data<ul compact><li>The data field of the data structure is set to the record
retrieved, and the size field indicates the number of bytes in the
record. See <a href="../../db4-devel-4.7.25/api_c/dbt_class.html">DBT</a> for a description of other fields in the
data structure. The <a href="../../db4-devel-4.7.25/api_c/dbt_class.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a>,
<a href="../../db4-devel-4.7.25/api_c/dbt_class.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> and <a href="../../db4-devel-4.7.25/api_c/dbt_class.html#DB_DBT_USERMEM">DB_DBT_USERMEM</a> flags may be specified
for any <a href="../../db4-devel-4.7.25/api_c/dbt_class.html">DBT</a> used for data retrieval.</ul>
 flags<ul compact><li>The flags parameter must be set to one of the following values:
 
<a name="DB_CURRENT">DB_CURRENT</a><ul compact><li>Return the log record to which the log currently refers.</ul>
<a name="DB_FIRST">DB_FIRST</a><ul compact><li>The first record from any of the log files found in the log directory
is returned in the data parameter.
The lsn parameter is overwritten with the <a href="../../db4-devel-4.7.25/api_c/lsn_class.html">DB_LSN</a> of the
record returned.
The DB_LOGC-&gt;get method will return <a href="../../db4-devel-4.7.25/ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a> if DB_FIRST is set and the log is empty.
</ul>
<a name="DB_LAST">DB_LAST</a><ul compact><li>The last record in the log is returned in the data parameter.
The lsn parameter is overwritten with the <a href="../../db4-devel-4.7.25/api_c/lsn_class.html">DB_LSN</a> of the
record returned.
The DB_LOGC-&gt;get method will return <a href="../../db4-devel-4.7.25/ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a> if DB_LAST is set and the log is empty.
</ul>
<a name="DB_NEXT">DB_NEXT</a><ul compact><li>The current log position is advanced to the next record in the log, and
that record is returned in the data parameter. The lsn
parameter is overwritten with the <a href="../../db4-devel-4.7.25/api_c/lsn_class.html">DB_LSN</a> of the record returned.
If the cursor has not been initialized via DB_FIRST, DB_LAST, DB_SET,
DB_NEXT, or DB_PREV, DB_LOGC-&gt;get will return the first record in
the log.
The DB_LOGC-&gt;get method will return <a href="../../db4-devel-4.7.25/ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a> if DB_NEXT is set and the last log record has already been
returned or the log is empty.
</ul>
<a name="DB_PREV">DB_PREV</a><ul compact><li>The current log position is advanced to the previous record in the log,
and that record is returned in the data parameter. The
lsn parameter is overwritten with the <a href="../../db4-devel-4.7.25/api_c/lsn_class.html">DB_LSN</a> of the record
returned.
If the cursor has not been initialized via DB_FIRST, DB_LAST, DB_SET,
DB_NEXT, or DB_PREV, DB_LOGC-&gt;get will return the last record in the
log.
The DB_LOGC-&gt;get method will return <a href="../../db4-devel-4.7.25/ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a> if DB_PREV is set and the first log record has already been
returned or the log is empty.
</ul>
<a name="DB_SET">DB_SET</a><ul compact><li>Retrieve the record specified by the lsn parameter.</ul>
 </ul>
 lsn<ul compact><li>When the flag parameter is set to DB_CURRENT,
DB_FIRST, DB_LAST, DB_NEXT or DB_PREV,
the lsn parameter is overwritten with the <a href="../../db4-devel-4.7.25/api_c/lsn_class.html">DB_LSN</a> value
of the record retrieved. When flag is set to DB_SET,
the lsn parameter is the <a href="../../db4-devel-4.7.25/api_c/lsn_class.html">DB_LSN</a> value of the record to
be retrieved.</ul>
 
 Errors
The DB_LOGC-&gt;get method
may fail and return one of the following non-zero errors:
 
EINVAL<ul compact><li>If the DB_CURRENT flag was set and the log cursor has not yet
been initialized;
the DB_CURRENT, DB_NEXT, or DB_PREV flags were
set and the log was opened with the DB_THREAD flag set;
the DB_SET flag was set and the specified log sequence number
does not appear in the log; or if an
invalid flag value or parameter was specified.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_c/env_class.html">DB_ENV</a>, <a href="../../db4-devel-4.7.25/api_c/logc_class.html">DB_LOGC</a>, <a href="../../db4-devel-4.7.25/api_c/lsn_class.html">DB_LSN</a>
 See Also
<a href="../../db4-devel-4.7.25/api_c/log_list.html">Logging Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager