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::remove()</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="seqopen.html" title="DbSequence::open()" /> 12 <link rel="next" href="seqset_cachesize.html" title="DbSequence::set_cachesize()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbSequence::remove()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="seqopen.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="seqset_cachesize.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="seqremove"></a>DbSequence::remove()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbSequence::remove(u_int32_t flags);</pre> 42 <p> 43 The <code class="methodname">DbSequence::remove()</code> method removes the sequence from the 44 database. This method should not be called if there are other open 45 handles on this sequence. 46 </p> 47 <p> 48 The <a class="link" href="seq.html" title="Chapter��12.�� The DbSequence Handle">DbSequence</a> handle 49 may not be accessed again after <code class="methodname">DbSequence::remove()</code> is called, 50 regardless of its return. 51 </p> 52 <p> 53 The <code class="methodname">DbSequence::remove()</code> <span> 54 55 <span> 56 method either returns a non-zero error value or throws an 57 exception that encapsulates a non-zero error value on 58 failure, and returns 0 on success. 59 </span> 60 </span> 61 </p> 62 <div class="sect2" lang="en" xml:lang="en"> 63 <div class="titlepage"> 64 <div> 65 <div> 66 <h3 class="title"><a id="id1710245"></a>Parameters</h3> 67 </div> 68 </div> 69 </div> 70 <div class="sect3" lang="en" xml:lang="en"> 71 <div class="titlepage"> 72 <div> 73 <div> 74 <h4 class="title"><a id="id1710727"></a>flags</h4> 75 </div> 76 </div> 77 </div> 78 <p> 79 The <span class="bold"><strong>flags</strong></span> parameter must be set to 0 80 or by bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing 81 together one or more of the following values: 82 </p> 83 <div class="itemizedlist"> 84 <ul type="disc"> 85 <li> 86 <p> 87 <code class="literal">DB_TXN_NOSYNC</code> 88 </p> 89 <p> 90 If the operation is implicitly transaction protected (the <span class="bold"><strong>txnid</strong></span> argument is NULL but the operation occurs 91 to a transactional database), do not synchronously flush the log when 92 the transaction commits. 93 </p> 94 </li> 95 </ul> 96 </div> 97 </div> 98 <div class="sect3" lang="en" xml:lang="en"> 99 <div class="titlepage"> 100 <div> 101 <div> 102 <h4 class="title"><a id="id1710728"></a>txnid</h4> 103 </div> 104 </div> 105 </div> 106 <p> 107 If the operation is part of an application-specified transaction, the 108 <span class="bold"><strong>txnid</strong></span> parameter is a transaction 109 handle returned from <a class="xref" href="txnbegin.html" title="DbEnv::txn_begin()">DbEnv::txn_begin()</a>; if the 110 operation is part of a Berkeley DB Concurrent Data Store group, the 111 <span class="bold"><strong>txnid</strong></span> parameter is a handle returned 112 from <a class="xref" href="envcdsgroup_begin.html" title="DbEnv::cdsgroup_begin()">DbEnv::cdsgroup_begin()</a>; 113 otherwise NULL. If no transaction handle is specified, but the 114 operation occurs in a transactional database, the operation will be 115 implicitly transaction protected. 116 </p> 117 </div> 118 </div> 119 <div class="sect2" lang="en" xml:lang="en"> 120 <div class="titlepage"> 121 <div> 122 <div> 123 <h3 class="title"><a id="id1711046"></a>Errors</h3> 124 </div> 125 </div> 126 </div> 127 <p> 128 The <code class="methodname">DbSequence::remove()</code> <span> 129 130 <span> 131 method may fail and throw a <a class="link" href="dbexception.html" title="Chapter��6.��The DbException Class">DbException</a> 132 exception, encapsulating one of the following non-zero errors, or return one 133 of the following non-zero errors: 134 </span> 135 </span> 136 </p> 137 <div class="sect3" lang="en" xml:lang="en"> 138 <div class="titlepage"> 139 <div> 140 <div> 141 <h4 class="title"><a id="id1711058"></a>EINVAL</h4> 142 </div> 143 </div> 144 </div> 145 <p> 146 An invalid flag value or parameter was specified. 147 </p> 148 </div> 149 </div> 150 <div class="sect2" lang="en" xml:lang="en"> 151 <div class="titlepage"> 152 <div> 153 <div> 154 <h3 class="title"><a id="id1710562"></a>Class</h3> 155 </div> 156 </div> 157 </div> 158 <p> 159 <a class="link" href="seq.html" title="Chapter��12.�� The DbSequence Handle">DbSequence</a> 160 </p> 161 </div> 162 <div class="sect2" lang="en" xml:lang="en"> 163 <div class="titlepage"> 164 <div> 165 <div> 166 <h3 class="title"><a id="id1710893"></a>See Also</h3> 167 </div> 168 </div> 169 </div> 170 <p> 171 <a class="xref" href="seq.html#seqlist" title="Sequences and Related Methods">Sequences and Related Methods</a> 172 </p> 173 </div> 174 </div> 175 <div class="navfooter"> 176 <hr /> 177 <table width="100%" summary="Navigation footer"> 178 <tr> 179 <td width="40%" align="left"><a accesskey="p" href="seqopen.html">Prev</a>��</td> 180 <td width="20%" align="center"> 181 <a accesskey="u" href="seq.html">Up</a> 182 </td> 183 <td width="40%" align="right">��<a accesskey="n" href="seqset_cachesize.html">Next</a></td> 184 </tr> 185 <tr> 186 <td width="40%" align="left" valign="top">DbSequence::open()��</td> 187 <td width="20%" align="center"> 188 <a accesskey="h" href="index.html">Home</a> 189 </td> 190 <td width="40%" align="right" valign="top">��DbSequence::set_cachesize()</td> 191 </tr> 192 </table> 193 </div> 194 </body> 195</html> 196