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