Edit File - File Manager

Edit File: seq_open.html

<html>
<head>
<title>Berkeley DB: DB_SEQUENCE-&gt;open</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>
DB_SEQUENCE-&gt;open
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db.h&gt;

int
DB_SEQUENCE-&gt;open(DB_SEQUENCE *seq, DB_TXN *txnid, DBT *key, u_int32_t flags);

int
DB_SEQUENCE-&gt;get_dbp(DB_SEQUENCE *seq, DB **dbp);

int
DB_SEQUENCE-&gt;get_key(DB_SEQUENCE *seq, DBT *key);

int
</pre>
<hr size=1 noshade>
Description: DB_SEQUENCE-&gt;open
The DB_SEQUENCE-&gt;open method opens the sequence represented by the key.
The key must be compatible with the underlying database specified in the
corresponding call to <a href="../../db4-devel-4.7.25/api_c/seq_class.html">db_sequence_create</a>.
Parameters 
 key<ul compact><li>The key specifies which record in the database stores
the persistent sequence data.</ul>
 flags<ul compact><li>The flags parameter must be set to 0 or by bitwise inclusively OR'ing together one
or more of the following values:
 
<a name="DB_CREATE">DB_CREATE</a><ul compact><li>Create the sequence. If the sequence does not already exist and the
DB_CREATE flag is not specified, the DB_SEQUENCE-&gt;open will fail.</ul>
<a name="DB_EXCL">DB_EXCL</a><ul compact><li>Return an error if the sequence already exists. The <a href="../../db4-devel-4.7.25/api_c/db_open.html#DB_EXCL">DB_EXCL</a>
flag is only meaningful when specified with the <a href="../../db4-devel-4.7.25/api_c/env_open.html#DB_CREATE">DB_CREATE</a>
flag.</ul>
<a name="DB_THREAD">DB_THREAD</a><ul compact><li>Cause the <a href="../../db4-devel-4.7.25/api_c/seq_class.html">DB_SEQUENCE</a> handle returned by DB_SEQUENCE-&gt;open to be
free-threaded; that is, usable by multiple threads within a
single address space. Note that if multiple threads create multiple
sequences using the same database handle that handle must have been
opened specifying <a name="DB_THREAD">DB_THREAD</a>.</ul>
 </ul>
 txnid<ul compact><li>If the operation is part of an application-specified transaction, the
txnid parameter is a transaction handle returned from
<a href="../../db4-devel-4.7.25/api_c/txn_begin.html">DB_ENV-&gt;txn_begin</a>; if the operation is part of a Berkeley DB Concurrent Data Store group, the
txnid parameter is a handle returned from
<a href="../../db4-devel-4.7.25/api_c/env_cdsgroup_begin.html">DB_ENV-&gt;cdsgroup_begin</a>; otherwise NULL.
If no transaction handle is
specified, but the
operation occurs in a transactional
database,
the operation will be implicitly transaction protected.
Transactionally protected operations on a <a href="../../db4-devel-4.7.25/api_c/seq_class.html">DB_SEQUENCE</a> handle
require the <a href="../../db4-devel-4.7.25/api_c/seq_class.html">DB_SEQUENCE</a> handle itself be transactionally
protected during its open if the open creates the sequence.</ul>
 
<hr size=1 noshade>
Description: DB_SEQUENCE-&gt;get_dbp
The DB_SEQUENCE-&gt;get_dbp method returns the database handle.
Parameters 
 dbp<ul compact><li>The dbp parameter references memory into which
a pointer to the database handle is copied.</ul> 
 
The DB_SEQUENCE-&gt;get_dbp method may be called at any time during the life of the
application.
The DB_SEQUENCE-&gt;get_dbp method
returns a non-zero error value on failure
and 0 on success.

<hr size=1 noshade>
Description: DB_SEQUENCE-&gt;get_key
The DB_SEQUENCE-&gt;get_key method returns the key for the sequence.
Parameters 
 key<ul compact><li>The key parameter references memory into which
a pointer to the key data is copied.</ul> 
 
The DB_SEQUENCE-&gt;get_key method may be called at any time during the life of the
application.
The DB_SEQUENCE-&gt;get_key method
returns a non-zero error value on failure
and 0 on success.

<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_c/seq_class.html">DB_SEQUENCE</a>
 See Also
<a href="../../db4-devel-4.7.25/api_c/seq_list.html">Sequences and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager