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>DbLogc::close()</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 8. The DbLsn Handle" /> 11 <link rel="prev" href="logc.html" title="The DbLogc Handle" /> 12 <link rel="next" href="logcget.html" title="DbLogc::get()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbLogc::close()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="logc.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 8. 23 The DbLsn Handle 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="logcget.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="logcclose"></a>DbLogc::close()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbLogc::close(u_int32_t flags);</pre> 42 <p> 43 The <code class="methodname">DbLogc::close()</code> method discards the log cursor. After 44 <code class="methodname">DbLogc::close()</code> has been called, regardless of its return, the 45 cursor handle may not be used again. 46 </p> 47 <p> 48 The <code class="methodname">DbLogc::close()</code> <span> 49 50 <span> 51 method either returns a non-zero error value or throws an 52 exception that encapsulates a non-zero error value on 53 failure, and returns 0 on success. 54 </span> 55 </span> 56 </p> 57 <div class="sect2" lang="en" xml:lang="en"> 58 <div class="titlepage"> 59 <div> 60 <div> 61 <h3 class="title"><a id="id1688770"></a>Parameters</h3> 62 </div> 63 </div> 64 </div> 65 <div class="sect3" lang="en" xml:lang="en"> 66 <div class="titlepage"> 67 <div> 68 <div> 69 <h4 class="title"><a id="id1688787"></a>flags</h4> 70 </div> 71 </div> 72 </div> 73 <p> 74 The <span class="bold"><strong>flags</strong></span> parameter is currently 75 unused, and must be set to 0. 76 </p> 77 </div> 78 </div> 79 <div class="sect2" lang="en" xml:lang="en"> 80 <div class="titlepage"> 81 <div> 82 <div> 83 <h3 class="title"><a id="id1688945"></a>Errors</h3> 84 </div> 85 </div> 86 </div> 87 <p> 88 The <code class="methodname">DbLogc::close()</code> <span> 89 90 <span> 91 method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> 92 exception, encapsulating one of the following non-zero errors, or return one 93 of the following non-zero errors: 94 </span> 95 </span> 96 </p> 97 <div class="sect3" lang="en" xml:lang="en"> 98 <div class="titlepage"> 99 <div> 100 <div> 101 <h4 class="title"><a id="id1688731"></a>EINVAL</h4> 102 </div> 103 </div> 104 </div> 105 <p> 106 If the cursor is already closed; or if an invalid flag value or parameter was specified. 107 </p> 108 </div> 109 </div> 110 <div class="sect2" lang="en" xml:lang="en"> 111 <div class="titlepage"> 112 <div> 113 <div> 114 <h3 class="title"><a id="id1688968"></a>Class</h3> 115 </div> 116 </div> 117 </div> 118 <p> 119 <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>, 120 <a class="link" href="logc.html" title="The DbLogc Handle">DbLogc</a>, 121 <a class="link" href="lsn.html" title="Chapter 8. The DbLsn Handle">DbLsn</a> 122 </p> 123 </div> 124 <div class="sect2" lang="en" xml:lang="en"> 125 <div class="titlepage"> 126 <div> 127 <div> 128 <h3 class="title"><a id="id1688876"></a>See Also</h3> 129 </div> 130 </div> 131 </div> 132 <p> 133 <a class="xref" href="lsn.html#loglist" title="Logging Subsystem and Related Methods">Logging Subsystem and Related Methods</a> 134 </p> 135 </div> 136 </div> 137 <div class="navfooter"> 138 <hr /> 139 <table width="100%" summary="Navigation footer"> 140 <tr> 141 <td width="40%" align="left"><a accesskey="p" href="logc.html">Prev</a> </td> 142 <td width="20%" align="center"> 143 <a accesskey="u" href="lsn.html">Up</a> 144 </td> 145 <td width="40%" align="right"> <a accesskey="n" href="logcget.html">Next</a></td> 146 </tr> 147 <tr> 148 <td width="40%" align="left" valign="top"> 149 The DbLogc Handle 150 </td> 151 <td width="20%" align="center"> 152 <a accesskey="h" href="index.html">Home</a> 153 </td> 154 <td width="40%" align="right" valign="top"> DbLogc::get()</td> 155 </tr> 156 </table> 157 </div> 158 </body> 159</html> 160