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::initial_value()</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="seqget_range.html" title="DbSequence::get_range()" /> 12 <link rel="next" href="seqopen.html" title="DbSequence::open()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbSequence::initial_value()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="seqget_range.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="seqopen.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="seqinitial_value"></a>DbSequence::initial_value()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbSequence::initial_value(db_seq_t value);</pre> 42 <p> 43 Set the initial value for a sequence. This call is only effective 44 when the sequence is being created. 45 </p> 46 <p> 47 The <code class="methodname">DbSequence::initial_value()</code> method may not be called after the 48 <a class="xref" href="seqopen.html" title="DbSequence::open()">DbSequence::open()</a> 49 method is called. 50 </p> 51 <p> 52 The <code class="methodname">DbSequence::initial_value()</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="id1709227"></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="id1710092"></a>value</h4> 74 </div> 75 </div> 76 </div> 77 <p> 78 The initial value to set. 79 </p> 80 </div> 81 </div> 82 <div class="sect2" lang="en" xml:lang="en"> 83 <div class="titlepage"> 84 <div> 85 <div> 86 <h3 class="title"><a id="id1710356"></a>Errors</h3> 87 </div> 88 </div> 89 </div> 90 <p> 91 The <code class="methodname">DbSequence::initial_value()</code> <span> 92 93 <span> 94 method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> 95 exception, encapsulating one of the following non-zero errors, or return one 96 of the following non-zero errors: 97 </span> 98 </span> 99 </p> 100 <div class="sect3" lang="en" xml:lang="en"> 101 <div class="titlepage"> 102 <div> 103 <div> 104 <h4 class="title"><a id="id1710485"></a>EINVAL</h4> 105 </div> 106 </div> 107 </div> 108 <p> 109 An invalid flag value or parameter was specified. 110 </p> 111 </div> 112 </div> 113 <div class="sect2" lang="en" xml:lang="en"> 114 <div class="titlepage"> 115 <div> 116 <div> 117 <h3 class="title"><a id="id1710203"></a>Class</h3> 118 </div> 119 </div> 120 </div> 121 <p> 122 <a class="link" href="seq.html" title="Chapter 12. The DbSequence Handle">DbSequence</a> 123 </p> 124 </div> 125 <div class="sect2" lang="en" xml:lang="en"> 126 <div class="titlepage"> 127 <div> 128 <div> 129 <h3 class="title"><a id="id1710486"></a>See Also</h3> 130 </div> 131 </div> 132 </div> 133 <p> 134 <a class="xref" href="seq.html#seqlist" title="Sequences and Related Methods">Sequences and Related Methods</a> 135 </p> 136 </div> 137 </div> 138 <div class="navfooter"> 139 <hr /> 140 <table width="100%" summary="Navigation footer"> 141 <tr> 142 <td width="40%" align="left"><a accesskey="p" href="seqget_range.html">Prev</a> </td> 143 <td width="20%" align="center"> 144 <a accesskey="u" href="seq.html">Up</a> 145 </td> 146 <td width="40%" align="right"> <a accesskey="n" href="seqopen.html">Next</a></td> 147 </tr> 148 <tr> 149 <td width="40%" align="left" valign="top">DbSequence::get_range() </td> 150 <td width="20%" align="center"> 151 <a accesskey="h" href="index.html">Home</a> 152 </td> 153 <td width="40%" align="right" valign="top"> DbSequence::open()</td> 154 </tr> 155 </table> 156 </div> 157 </body> 158</html> 159