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->set_flags()</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="seqset_cachesize.html" title="DB_SEQUENCE->set_cachesize()" /> 12 <link rel="next" href="seqset_range.html" title="DB_SEQUENCE->set_range()" /> 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->set_flags()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="seqset_cachesize.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_range.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="seqset_flags"></a>DB_SEQUENCE->set_flags()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db.h> 39 40int 41DB_SEQUENCE->set_flags(DB_SEQUENCE *seq, u_int32_t flags); </pre> 42 <p> 43 Configure a sequence. The flags are only effective when creating a 44 sequence. Calling <code class="methodname">DB_SEQUENCE->set_flags()</code> is additive; there is no 45 way to clear flags. 46 </p> 47 <p> 48 The <code class="methodname">DB_SEQUENCE->set_flags()</code> method may not be called after the 49 <a class="xref" href="seqopen.html" title="DB_SEQUENCE->open()">DB_SEQUENCE->open()</a> method is called. 50 </p> 51 <p> 52 The <code class="methodname">DB_SEQUENCE->set_flags()</code> <span> 53 <span> 54 method returns a non-zero error value on failure and 0 on success. 55 </span> 56 57 </span> 58 </p> 59 <div class="sect2" lang="en" xml:lang="en"> 60 <div class="titlepage"> 61 <div> 62 <div> 63 <h3 class="title"><a id="id1706094"></a>Parameters</h3> 64 </div> 65 </div> 66 </div> 67 <div class="sect3" lang="en" xml:lang="en"> 68 <div class="titlepage"> 69 <div> 70 <div> 71 <h4 class="title"><a id="id1706431"></a>flags</h4> 72 </div> 73 </div> 74 </div> 75 <p> 76 The <span class="bold"><strong>flags</strong></span> parameter must be set to 0 77 or by bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing 78 together one or more of the following values: 79 </p> 80 <div class="itemizedlist"> 81 <ul type="disc"> 82 <li> 83 <p> 84 <code class="literal">DB_SEQ_DEC</code> 85 </p> 86 <p> 87 Specify that the sequence should be decremented. 88 </p> 89 </li> 90 <li> 91 <p> 92 <code class="literal">DB_SEQ_INC</code> 93 </p> 94 <p> 95 Specify that the sequence should be incremented. This is the default. 96 </p> 97 </li> 98 <li> 99 <p><a id="seqset_flags_DB_SEQ_WRAP"></a> 100 <code class="literal">DB_SEQ_WRAP</code> 101 </p> 102 <p> 103 Specify that the sequence should wrap around when it is incremented 104 (decremented) past the specified maximum (minimum) value. 105 </p> 106 </li> 107 </ul> 108 </div> 109 </div> 110 </div> 111 <div class="sect2" lang="en" xml:lang="en"> 112 <div class="titlepage"> 113 <div> 114 <div> 115 <h3 class="title"><a id="id1706095"></a>Errors</h3> 116 </div> 117 </div> 118 </div> 119 <p> 120 The <code class="methodname">DB_SEQUENCE->set_flags()</code> <span> 121 <span> 122 method may fail and return one of the following non-zero errors: 123 </span> 124 125 </span> 126 </p> 127 <div class="sect3" lang="en" xml:lang="en"> 128 <div class="titlepage"> 129 <div> 130 <div> 131 <h4 class="title"><a id="id1706584"></a>EINVAL</h4> 132 </div> 133 </div> 134 </div> 135 <p> 136 An invalid flag value or parameter was specified. 137 </p> 138 </div> 139 </div> 140 <div class="sect2" lang="en" xml:lang="en"> 141 <div class="titlepage"> 142 <div> 143 <div> 144 <h3 class="title"><a id="id1706654"></a>Class</h3> 145 </div> 146 </div> 147 </div> 148 <p> 149 <a class="link" href="seq.html" title="Chapter 11. The DB_SEQUENCE Handle">DB_SEQUENCE</a> 150 </p> 151 </div> 152 <div class="sect2" lang="en" xml:lang="en"> 153 <div class="titlepage"> 154 <div> 155 <div> 156 <h3 class="title"><a id="id1706585"></a>See Also</h3> 157 </div> 158 </div> 159 </div> 160 <p> 161 <a class="xref" href="seq.html#seqlist" title="Sequences and Related Methods">Sequences and Related Methods</a> 162 </p> 163 </div> 164 </div> 165 <div class="navfooter"> 166 <hr /> 167 <table width="100%" summary="Navigation footer"> 168 <tr> 169 <td width="40%" align="left"><a accesskey="p" href="seqset_cachesize.html">Prev</a> </td> 170 <td width="20%" align="center"> 171 <a accesskey="u" href="seq.html">Up</a> 172 </td> 173 <td width="40%" align="right"> <a accesskey="n" href="seqset_range.html">Next</a></td> 174 </tr> 175 <tr> 176 <td width="40%" align="left" valign="top">DB_SEQUENCE->set_cachesize() </td> 177 <td width="20%" align="center"> 178 <a accesskey="h" href="index.html">Home</a> 179 </td> 180 <td width="40%" align="right" valign="top"> DB_SEQUENCE->set_range()</td> 181 </tr> 182 </table> 183 </div> 184 </body> 185</html> 186