<?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_ENV->get_backup_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="env.html" title="Chapter 5. The DB_ENV Handle" />
<link rel="prev" href="envget_backup_callbacks.html" title="DB_ENV->get_backup_callbacks()" />
<link rel="next" href="envget_flags.html" title="DB_ENV->get_flags()" />
</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_ENV->get_backup_config()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envget_backup_callbacks.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5.
The DB_ENV Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envget_flags.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_backup_config"></a>DB_ENV->get_backup_config()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db.h>
DB_ENV->get_backup_config(DB_ENV, db_backup_config_t option,
u_int32_t *valuep); </pre>
<p>
The <code class="methodname">DB_ENV->get_backup_config()</code> method
retrieves the value set for hot backup tuning parameters. See the
<a class="xref" href="envbackup.html" title="DB_ENV->backup()">DB_ENV->backup()</a>
and
<a class="xref" href="envdbbackup.html" title="DB_ENV->dbbackup()">DB_ENV->dbbackup()</a>
methods for a description of the hot backup APIs. These tuning
parameters can be set using the
<a class="xref" href="envset_backup_config.html" title="DB_ENV->set_backup_config()">DB_ENV->set_backup_config()</a>
method.
</p>
<p>
The <code class="methodname">DB_ENV->get_backup_config()</code> method may
be called at any time during the life of the application.
</p>
<p>
The <code class="methodname">DB_ENV->get_backup_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="idp59477688"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp59476936"></a>option</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>option</strong></span> parameter
identifies the backup parameter to be retrieved. It
must be one of the following:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">DB_BACKUP_WRITE_DIRECT</code>
</p>
<p>
Turning this on causes direct I/O to be used when
writing pages to the disk.
</p>
</li>
<li>
<p>
<code class="literal">DB_BACKUP_READ_COUNT</code>
</p>
<p>
Configures the number of pages to read before
pausing.
</p>
</li>
<li>
<p>
<code class="literal">DB_BACKUP_READ_SLEEP</code>
</p>
<p>
Configures the number of microseconds to sleep
between batches of reads.
</p>
</li>
<li>
<p>
<code class="literal">DB_BACKUP_SIZE</code>
</p>
<p>
Configures the size of the buffer, in megabytes, to
read from the database.
</p>
</li>
</ul>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp59490632"></a>valuep</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>valuep</strong></span> parameter
references memory into which is copied the current value of the
backup tuning parameter identified by the
<span class="bold"><strong>option</strong></span> parameter.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp59471112"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a>,
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp59493240"></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>,
<a class="xref" href="envset_backup_config.html" title="DB_ENV->set_backup_config()">DB_ENV->set_backup_config()</a>,
<a class="xref" href="envbackup.html" title="DB_ENV->backup()">DB_ENV->backup()</a>,
<a class="xref" href="envdbbackup.html" title="DB_ENV->dbbackup()">DB_ENV->dbbackup()</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_backup_callbacks.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_flags.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_ENV->get_backup_callbacks() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_ENV->get_flags()</td>
</tr>
</table>
</div>
</body>
</html>
