libdb/docs/api_reference/C/dbsite_get_config.html
2012-11-14 16:35:20 -05:00

154 lines
5.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>DB_SITE-&gt;get_config()</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="rep.html" title="Chapter 10.  Replication Methods" />
<link rel="prev" href="dbsite_close.html" title="DB_SITE-&gt;close()" />
<link rel="next" href="dbsite_get_address.html" title="DB_SITE-&gt;get_address()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_SITE-&gt;get_config()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbsite_close.html">Prev</a> </td>
<th width="60%" align="center">Chapter 10. 
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbsite_get_address.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="dbsite_get_config"></a>DB_SITE-&gt;get_config()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB_SITE-&gt;get_config(DB_SITE *site, u_int32_t which,
u_int32_t *valuep); </pre>
<p>
The <code class="methodname">DB_SITE-&gt;get_config()</code> method returns
whether the specified <span class="bold"><strong>which</strong></span>
parameter is currently set. See the
<a class="xref" href="dbsite_set_config.html" title="DB_SITE-&gt;set_config()">DB_SITE-&gt;set_config()</a>
method for the configuration flags that can be set for a
DB_SITE handle.
</p>
<p>
The <code class="methodname">DB_SITE-&gt;get_config()</code> method may be
called at any time during the life of the application.
</p>
<p>
The <code class="methodname">DB_SITE-&gt;get_config()</code> <span>
<span>
method returns a non-zero error value on failure and 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp61874296"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp61874768"></a>which</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>which</strong></span> parameter is
the configuration flag to check. See the
<a class="xref" href="dbsite_set_config.html" title="DB_SITE-&gt;set_config()">DB_SITE-&gt;set_config()</a>
method for a list of configuration flags that you can
provide to this parameter.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp61868552"></a>valuep</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>valuep</strong></span> parameter references
memory into which the configuration of the specified <span class="bold"><strong>which</strong></span> parameter is copied.
</p>
<p>
If the returned value is zero, the parameter is off;
otherwise it is on.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp61854152"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="db_site.html" title="The DB_SITE Handle">DB_SITE</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp61857608"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a>,
<a class="xref" href="dbsite_set_config.html" title="DB_SITE-&gt;set_config()">DB_SITE-&gt;set_config()</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dbsite_close.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="rep.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbsite_get_address.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_SITE-&gt;close() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_SITE-&gt;get_address()</td>
</tr>
</table>
</div>
</body>
</html>