1<!--$Id: seq_set_flags.so,v 1.7 2004/09/07 15:37:41 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::set_flags</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::set_flags</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 <db_cxx.h> 23<p> 24int 25DbSequence::set_flags(u_int32_t flags); 26<p> 27int DbSequence::get_flags(u_int32_t *flagsp); 28</pre></b> 29<hr size=1 noshade> 30<b>Description: DbSequence::set_flags</b> 31<p>Configure a sequence. The flags are only effective when creating a 32sequence. Calling DbSequence::set_flags is additive; there is no way 33to clear flags.</p> 34<p>The DbSequence::set_flags method may not be called after the 35<a href="../api_cxx/seq_open.html">DbSequence::open</a> method is called.</p> 36<p>The DbSequence::set_flags method 37either returns a non-zero error value 38or throws an exception that encapsulates a non-zero error value on 39failure, and returns 0 on success. 40</p> 41<b>Parameters</b> <br> 42 <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 43or more of the following values: 44<br> 45<b><a name="DB_SEQ_DEC">DB_SEQ_DEC</a></b><ul compact><li>Specify that the sequence should be decremented.</ul> 46<br> 47<br> 48<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> 49<br> 50<br> 51<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 52(decremented) past the specified maximum (minimum) value.</ul> 53<br></ul> 54<br> 55<br><b>Errors</b> 56<p>The DbSequence::set_flags method 57may fail and throw 58<a href="../api_cxx/except_class.html">DbException</a>, 59encapsulating one of the following non-zero errors, or return one of 60the following non-zero errors:</p> 61<br> 62<b>EINVAL</b><ul compact><li>An 63invalid flag value or parameter was specified.</ul> 64<br> 65<hr size=1 noshade> 66<b>Description: DbSequence::get_flags</b> 67<p>The DbSequence::get_flags method returns the current flags.</p> 68<p>The DbSequence::get_flags method may be called at any time during the life of the 69application.</p> 70<p>The DbSequence::get_flags method 71either returns a non-zero error value 72or throws an exception that encapsulates a non-zero error value on 73failure, and returns 0 on success. 74</p> 75<b>Parameters</b> <br> 76 <b>flagsp</b><ul compact><li>The DbSequence::get_flags method returns the 77current flags in <b>flagsp</b>.</ul> 78<br> 79<hr size=1 noshade> 80<br><b>Class</b> 81<a href="../api_cxx/seq_class.html">DbSequence</a> 82<br><b>See Also</b> 83<a href="../api_cxx/seq_list.html">Sequences and Related Methods</a> 84</tt> 85<table width="100%"><tr><td><br></td><td align=right> 86<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> 87</td></tr></table> 88<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 89</body> 90</html> 91