1<!--$Id: seq_initial_value.so,v 1.6 2004/11/29 15:30:23 bostic Exp $-->
2<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
3<!--See the file LICENSE for redistribution information.-->
4<html>
5<head>
6<title>Berkeley DB: DbSequence::initial_value</title>
7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
9</head>
10<body bgcolor=white>
11<table width="100%"><tr valign=top>
12<td>
13<b>DbSequence::initial_value</b>
14</td>
15<td align=right>
16<a href="/api_cxx/api_core.html"><img src="/images/api.gif" alt="API"></a>
17<a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a></td>
18</tr></table>
19<hr size=1 noshade>
20<tt>
21<b><pre>
22#include &lt;db_cxx.h&gt;
23<p>
24int
25DbSequence::initial_value(db_seq_t value);
26</pre></b>
27<hr size=1 noshade>
28<b>Description: DbSequence::initial_value</b>
29<p>Set the initial value for a sequence.  This call is only effective when
30the sequence is being created.</p>
31<p>The DbSequence::initial_value method may not be called after the
32<a href="/api_cxx/seq_open.html">DbSequence::open</a> method is called.</p>
33<p>The DbSequence::initial_value method
34either returns a non-zero error value
35or throws an exception that encapsulates a non-zero error value on
36failure, and returns 0 on success.
37</p>
38<b>Parameters</b> <br>
39 <b>value</b><ul compact><li>The initial value to set.</ul>
40<br>
41<br><b>Errors</b>
42<p>The DbSequence::initial_value method
43may fail and throw
44<a href="/api_cxx/except_class.html">DbException</a>,
45encapsulating one of the following non-zero errors, or return one of
46the following non-zero errors:</p>
47<br>
48<b>EINVAL</b><ul compact><li>An
49invalid flag value or parameter was specified.</ul>
50<br>
51<hr size=1 noshade>
52<br><b>Class</b>
53<a href="/api_cxx/seq_class.html">DbSequence</a>
54<br><b>See Also</b>
55<a href="/api_cxx/seq_list.html">Sequences and Related Methods</a>
56</tt>
57<table width="100%"><tr><td><br></td><td align=right>
58<a href="/api_cxx/api_core.html"><img src="/images/api.gif" alt="API"></a><a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a>
59</td></tr></table>
60<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
61</body>
62</html>
63