seq_set_flags.html [plain text]
<!--$Id: seq_set_flags.so,v 1.7 2004/09/07 15:37:41 bostic Exp $-->
<!--Copyright (c) 1997,2007 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>
<h3>DbSequence::set_flags</h3>
</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>
<h3><pre>
#include <db_cxx.h>
<p>
int
DbSequence::set_flags(u_int32_t flags);
<p>
int DbSequence::get_flags(u_int32_t *flagsp);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DbSequence::set_flags</h3>
<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>
<h3>Parameters</h3>
<dl compact>
<dt><b>flags</b><dd>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:
<dl compact>
<dt><a name="DB_SEQ_DEC">DB_SEQ_DEC</a><dd>Specify that the sequence should be decremented.
</dl>
<dl compact>
<dt><a name="DB_SEQ_INC">DB_SEQ_INC</a><dd>Specify that the sequence should be incremented. This is the default.
</dl>
<dl compact>
<dt><a name="DB_SEQ_WRAP">DB_SEQ_WRAP</a><dd>Specify that the sequence should wrap around when it is incremented
(decremented) past the specified maximum (minimum) value.
</dl>
</dl>
<h3>Errors</h3>
<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>
<dl compact>
<dt>EINVAL<dd>An
invalid flag value or parameter was specified.
</dl>
<hr size=1 noshade>
<h3>Description: DbSequence::get_flags</h3>
<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>
<h3>Parameters</h3>
<dl compact>
<dt><b>flagsp</b><dd>The DbSequence::get_flags method returns the
current flags in <b>flagsp</b>.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_cxx/seq_class.html">DbSequence</a>
<h3>See Also</h3>
<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,2007 Oracle. All rights reserved.</font>
</body>
</html>