Import BSDDB 4.7.25 (as of svn r89086)
This commit is contained in:
80
docs/api_cxx/seq_set_range.html
Normal file
80
docs/api_cxx/seq_set_range.html
Normal file
@@ -0,0 +1,80 @@
|
||||
<!--$Id: seq_set_range.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_range</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_range</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_range(db_seq_t min, db_seq_t max);
|
||||
<p>
|
||||
int DbSequence::get_range(u_int32_t, db_seq_t *minp, db_seq_t *maxp);
|
||||
</pre></b>
|
||||
<hr size=1 noshade>
|
||||
<b>Description: DbSequence::set_range</b>
|
||||
<p>Configure a sequence range. This call is only effective when the
|
||||
sequence is being created. The range is limited to a signed 64 bit
|
||||
integer.</p>
|
||||
<p>The DbSequence::set_range 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_range 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>min</b><ul compact><li>Specifies the minimum value for the sequence.</ul>
|
||||
<b>max</b><ul compact><li>Specifies the maximum value for the sequence.</ul>
|
||||
<br>
|
||||
<br><b>Errors</b>
|
||||
<p>The DbSequence::set_range 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_range</b>
|
||||
<p>The DbSequence::get_range method returns the range of values in the sequence.</p>
|
||||
<p>The DbSequence::get_range method may be called at any time during the life of the
|
||||
application.</p>
|
||||
<p>The DbSequence::get_range 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>minp</b><ul compact><li>The DbSequence::get_range method returns the minimum value in <b>minp</b>.</ul>
|
||||
<b>maxp</b><ul compact><li>The DbSequence::get_range method returns the maximum value in <b>maxp</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>
|
||||
Reference in New Issue
Block a user