91 lines
3.5 KiB
HTML
91 lines
3.5 KiB
HTML
<!--$Id: seq_set_flags.html 63573 2008-05-23 21:43:21Z trent.nelson $-->
|
|
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
|
|
<!--See the file LICENSE for redistribution information.-->
|
|
<html>
|
|
<head>
|
|
<title>Berkeley DB: DbSequence::set_flags</title>
|
|
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
|
|
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
|
|
</head>
|
|
<body bgcolor=white>
|
|
<table width="100%"><tr valign=top>
|
|
<td>
|
|
<b>DbSequence::set_flags</b>
|
|
</td>
|
|
<td align=right>
|
|
<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></td>
|
|
</tr></table>
|
|
<hr size=1 noshade>
|
|
<tt>
|
|
<b><pre>
|
|
#include <db_cxx.h>
|
|
<p>
|
|
int
|
|
DbSequence::set_flags(u_int32_t flags);
|
|
<p>
|
|
int DbSequence::get_flags(u_int32_t *flagsp);
|
|
</pre></b>
|
|
<hr size=1 noshade>
|
|
<b>Description: DbSequence::set_flags</b>
|
|
<p>Configure a sequence. The flags are only effective when creating a
|
|
sequence. Calling DbSequence::set_flags is additive; there is no way
|
|
to clear flags.</p>
|
|
<p>The DbSequence::set_flags method may not be called after the
|
|
<a href="../api_cxx/seq_open.html">DbSequence::open</a> method is called.</p>
|
|
<p>The DbSequence::set_flags method
|
|
either returns a non-zero error value
|
|
or throws an exception that encapsulates a non-zero error value on
|
|
failure, and returns 0 on success.
|
|
</p>
|
|
<b>Parameters</b> <br>
|
|
<b>flags</b><ul compact><li>The <b>flags</b> parameter must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one
|
|
or more of the following values:
|
|
<br>
|
|
<b><a name="DB_SEQ_DEC">DB_SEQ_DEC</a></b><ul compact><li>Specify that the sequence should be decremented.</ul>
|
|
<br>
|
|
<br>
|
|
<b><a name="DB_SEQ_INC">DB_SEQ_INC</a></b><ul compact><li>Specify that the sequence should be incremented. This is the default.</ul>
|
|
<br>
|
|
<br>
|
|
<b><a name="DB_SEQ_WRAP">DB_SEQ_WRAP</a></b><ul compact><li>Specify that the sequence should wrap around when it is incremented
|
|
(decremented) past the specified maximum (minimum) value.</ul>
|
|
<br></ul>
|
|
<br>
|
|
<br><b>Errors</b>
|
|
<p>The DbSequence::set_flags method
|
|
may fail and throw
|
|
<a href="../api_cxx/except_class.html">DbException</a>,
|
|
encapsulating one of the following non-zero errors, or return one of
|
|
the following non-zero errors:</p>
|
|
<br>
|
|
<b>EINVAL</b><ul compact><li>An
|
|
invalid flag value or parameter was specified.</ul>
|
|
<br>
|
|
<hr size=1 noshade>
|
|
<b>Description: DbSequence::get_flags</b>
|
|
<p>The DbSequence::get_flags method returns the current flags.</p>
|
|
<p>The DbSequence::get_flags method may be called at any time during the life of the
|
|
application.</p>
|
|
<p>The DbSequence::get_flags method
|
|
either returns a non-zero error value
|
|
or throws an exception that encapsulates a non-zero error value on
|
|
failure, and returns 0 on success.
|
|
</p>
|
|
<b>Parameters</b> <br>
|
|
<b>flagsp</b><ul compact><li>The DbSequence::get_flags method returns the
|
|
current flags in <b>flagsp</b>.</ul>
|
|
<br>
|
|
<hr size=1 noshade>
|
|
<br><b>Class</b>
|
|
<a href="../api_cxx/seq_class.html">DbSequence</a>
|
|
<br><b>See Also</b>
|
|
<a href="../api_cxx/seq_list.html">Sequences and Related Methods</a>
|
|
</tt>
|
|
<table width="100%"><tr><td><br></td><td align=right>
|
|
<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>
|
|
</td></tr></table>
|
|
<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
|
|
</body>
|
|
</html>
|