libdb/docs/api_reference/CXX/envget_flags.html
2011-09-13 13:44:24 -04:00

132 lines
4.9 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>DbEnv::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="env.html" title="Chapter 5.  The DbEnv Handle" />
<link rel="prev" href="envget_errpfx.html" title="DbEnv::get_errpfx()" />
<link rel="next" href="envget_home.html" title="DbEnv::get_home()" />
</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">DbEnv::get_flags()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envget_errpfx.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5. 
The DbEnv Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envget_home.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="envget_flags"></a>DbEnv::get_flags()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
int
DbEnv::get_flags(u_int32_t *flagsp)</pre>
<p>
The <code class="methodname">DbEnv::get_flags()</code> method returns the configuration flags set for a
<a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a> handle. These flags are set using
the <a class="xref" href="envset_flags.html" title="DbEnv::set_flags()">DbEnv::set_flags()</a>
method.
</p>
<p>
The <code class="methodname">DbEnv::get_flags()</code> method may be called at any time during the
life of the application.
</p>
<p>
The <code class="methodname">DbEnv::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="id3615162"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3615152"></a>flagsp</h4>
</div>
</div>
</div>
<p>
The <code class="methodname">DbEnv::get_flags()</code> method returns the configuration 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="id3614770"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3615185"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="envget_errpfx.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="env.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envget_home.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::get_errpfx() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::get_home()</td>
</tr>
</table>
</div>
</body>
</html>