mariadb/bdb/docs/api_cxx/dbc_count.html
2001-03-04 19:42:05 -05:00

59 lines
2.8 KiB
HTML

<!--$Id: dbc_count.so,v 10.4 2000/03/01 21:41:29 bostic Exp $-->
<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<html>
<head>
<title>Berkeley DB: Dbc::count</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table><tr valign=top>
<td>
<h1>Dbc::count</h1>
</td>
<td width="1%">
<a href="../api_cxx/cxx_index.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 &lt;db_cxx.h&gt;
<p>
int
Dbc::count(db_recno_t *countp, u_int32_t flags);
</pre></h3>
<h1>Description</h1>
<p>The Dbc::count method returns a count of the number of duplicate data
items for the key referenced by the
cursor into the memory location referenced by <b>countp</b>.
If the underlying database does not support duplicate data items the call
will still succeed and a count of 1 will be returned.
<p>The <b>flags</b> parameter is currently unused, and must be set to 0.
<p>If the <b>cursor</b> argument is not yet initialized, the Dbc::count method either returns EINVAL or throws an exception that encapsulates EINVAL.
<p>Otherwise, the Dbc::count 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.
<h1>Errors</h1>
<p>The Dbc::count method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods.
If a catastrophic error has occurred, the Dbc::count method may fail and either
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating
<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail
in the same way.
<h3>Class</h3>
<a href="../api_cxx/dbc_class.html">Dbc</a>
<h1>See Also</h1>
<a href="../api_cxx/dbc_close.html">Dbc::close</a>,
<a href="../api_cxx/dbc_count.html">Dbc::count</a>,
<a href="../api_cxx/dbc_del.html">Dbc::del</a>,
<a href="../api_cxx/dbc_dup.html">Dbc::dup</a>,
<a href="../api_cxx/dbc_get.html">Dbc::get</a>
and
<a href="../api_cxx/dbc_put.html">Dbc::put</a>.
</tt>
<table><tr><td><br></td><td width="1%">
<a href="../api_cxx/cxx_index.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><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>