1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>DB_ENV->log_cursor()</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB C API Reference" /> 10 <link rel="up" href="lsn.html" title="Chapter 7. The DB_LSN Handle" /> 11 <link rel="prev" href="logarchive.html" title="DB_ENV->log_archive()" /> 12 <link rel="next" href="logfile.html" title="DB_ENV->log_file()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DB_ENV->log_cursor()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="logarchive.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 7. 23 The DB_LSN Handle 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="logfile.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="sect1" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title" style="clear: both"><a id="logcursor"></a>DB_ENV->log_cursor()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db.h> 39 40int 41DB_ENV->log_cursor(DB_ENV *dbenv, DB_LOGC **cursorp, u_int32_t flags); </pre> 42 <p> 43 The <code class="methodname">DB_ENV->log_cursor()</code> method returns a created log cursor. 44 </p> 45 <p> 46 The <code class="methodname">DB_ENV->log_cursor()</code> <span> 47 <span> 48 method returns a non-zero error value on failure and 0 on success. 49 </span> 50 51 </span> 52 </p> 53 <div class="sect2" lang="en" xml:lang="en"> 54 <div class="titlepage"> 55 <div> 56 <div> 57 <h3 class="title"><a id="id1681147"></a>Parameters</h3> 58 </div> 59 </div> 60 </div> 61 <div class="sect3" lang="en" xml:lang="en"> 62 <div class="titlepage"> 63 <div> 64 <div> 65 <h4 class="title"><a id="id1680826"></a>cursorp</h4> 66 </div> 67 </div> 68 </div> 69 <p> 70 The <span class="bold"><strong>cursorp</strong></span> parameter references 71 memory into which a pointer to the created log cursor is copied. 72 </p> 73 </div> 74 <div class="sect3" lang="en" xml:lang="en"> 75 <div class="titlepage"> 76 <div> 77 <div> 78 <h4 class="title"><a id="id1680827"></a>flags</h4> 79 </div> 80 </div> 81 </div> 82 <p> 83 The <span class="bold"><strong>flags</strong></span> parameter is currently 84 unused, and must be set to 0. 85 </p> 86 </div> 87 </div> 88 <div class="sect2" lang="en" xml:lang="en"> 89 <div class="titlepage"> 90 <div> 91 <div> 92 <h3 class="title"><a id="id1681222"></a>Errors</h3> 93 </div> 94 </div> 95 </div> 96 <p> 97 The <code class="methodname">DB_ENV->log_cursor()</code> <span> 98 <span> 99 method may fail and return one of the following non-zero errors: 100 </span> 101 102 </span> 103 </p> 104 <div class="sect3" lang="en" xml:lang="en"> 105 <div class="titlepage"> 106 <div> 107 <div> 108 <h4 class="title"><a id="id1681142"></a>EINVAL</h4> 109 </div> 110 </div> 111 </div> 112 <p> 113 An invalid flag value or parameter was specified. 114 </p> 115 </div> 116 </div> 117 <div class="sect2" lang="en" xml:lang="en"> 118 <div class="titlepage"> 119 <div> 120 <div> 121 <h3 class="title"><a id="id1680853"></a>Class</h3> 122 </div> 123 </div> 124 </div> 125 <p> 126 <a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a>, 127 <a class="link" href="logc.html" title="The DB_LOGC Handle">DB_LOGC</a>, 128 <a class="link" href="lsn.html" title="Chapter 7. The DB_LSN Handle">DB_LSN</a> 129 </p> 130 </div> 131 <div class="sect2" lang="en" xml:lang="en"> 132 <div class="titlepage"> 133 <div> 134 <div> 135 <h3 class="title"><a id="id1681236"></a>See Also</h3> 136 </div> 137 </div> 138 </div> 139 <p> 140 <a class="xref" href="lsn.html#loglist" title="Logging Subsystem and Related Methods">Logging Subsystem and Related Methods</a> 141 </p> 142 </div> 143 </div> 144 <div class="navfooter"> 145 <hr /> 146 <table width="100%" summary="Navigation footer"> 147 <tr> 148 <td width="40%" align="left"><a accesskey="p" href="logarchive.html">Prev</a> </td> 149 <td width="20%" align="center"> 150 <a accesskey="u" href="lsn.html">Up</a> 151 </td> 152 <td width="40%" align="right"> <a accesskey="n" href="logfile.html">Next</a></td> 153 </tr> 154 <tr> 155 <td width="40%" align="left" valign="top">DB_ENV->log_archive() </td> 156 <td width="20%" align="center"> 157 <a accesskey="h" href="index.html">Home</a> 158 </td> 159 <td width="40%" align="right" valign="top"> DB_ENV->log_file()</td> 160 </tr> 161 </table> 162 </div> 163 </body> 164</html> 165