libdb/docs/api_reference/CXX/dbget_flags.html
2011-12-19 19:07:10 -05:00

129 lines
4.8 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Db::get_flags()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="db.html" title="Chapter 2.  The Db Handle" />
<link rel="prev" href="dbget_errpfx.html" title="Db::get_errpfx()" />
<link rel="next" href="dbget_h_ffactor.html" title="Db::get_h_ffactor()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Db::get_flags()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbget_errpfx.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2. 
The Db Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbget_h_ffactor.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="dbget_flags"></a>Db::get_flags()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
int Db::get_flags(u_int32_t *flagsp);</pre>
<p>
The <code class="methodname">Db::get_flags()</code> method returns the current database flags as
set by the <a class="xref" href="dbset_flags.html" title="Db::set_flags()">Db::set_flags()</a> method.
</p>
<p>
The <code class="methodname">Db::get_flags()</code> method may be called at any time during the life
of the application.
</p>
<p>
The <code class="methodname">Db::get_flags()</code> <span>
<span>
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.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3564768"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3564757"></a>flagsp</h4>
</div>
</div>
</div>
<p>
The <code class="methodname">Db::get_flags()</code> method returns the current flags in <span class="bold"><strong>flagsp</strong></span>.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3564583"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="db.html" title="Chapter 2.  The Db Handle">Db</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3564782"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>,
<a class="xref" href="dbset_flags.html" title="Db::set_flags()">Db::set_flags()</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dbget_errpfx.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="db.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbget_h_ffactor.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Db::get_errpfx() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Db::get_h_ffactor()</td>
</tr>
</table>
</div>
</body>
</html>