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