← Back to branch summary

~ubuntu-branches/ubuntu/edgy/rpm/edgy

« back to all changes in this revision

Viewing changes to db/docs/api_c/env_set_rec_init.html

  • Committer: Bazaar Package Importer
  • Author(s): Joey Hess
  • Date: 2002-01-22 20:56:57 UTC
  • Revision ID: james.westby@ubuntu.com-20020122205657-l74j50mr9z8ofcl5
Tags: upstream-4.0.3
Import upstream version 4.0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
db/docs/api_c/env_set_rec_init.html
 
1
<!--$Id: env_set_rec_init.so,v 10.12 2001/05/15 14:44:11 bostic Exp $-->
 
2
<!--Copyright 1997-2001 by Sleepycat Software, Inc.-->
 
3
<!--All rights reserved.-->
 
4
<html>
 
5
<head>
 
6
<title>Berkeley DB: DB_ENV-&gt;set_recovery_init</title>
 
7
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
 
8
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
 
9
</head>
 
10
<body bgcolor=white>
 
11
<a name="2"><!--meow--></a>
 
12
<table width="100%"><tr valign=top>
 
13
<td>
 
14
<h1>DB_ENV-&gt;set_recovery_init</h1>
 
15
</td>
 
16
<td align=right>
 
17
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
18
</td></tr></table>
 
19
<hr size=1 noshade>
 
20
<tt>
 
21
<h3><pre>
 
22
#include &lt;db.h&gt;
 
23
<p>
 
24
int
 
25
DB_ENV-&gt;set_recovery_init(DB_ENV *,
 
26
    int (*db_recovery_init_fcn)(DB_ENV *));
 
27
</pre></h3>
 
28
<h1>Description</h1>
 
29
<p>Applications installing application-specific recovery functions need
 
30
to be called before Berkeley DB performs recovery so they may add their recovery
 
31
functions to Berkeley DB's.
 
32
<p>The DB_ENV-&gt;set_recovery_init function supports this functionality.  The
 
33
<b>db_recovery_init_fcn</b> function must be declared with one
 
34
argument, a reference to the enclosing Berkeley DB environment.  This
 
35
function will be called after the <a href="../api_c/env_open.html">DB_ENV-&gt;open</a> has been called,
 
36
but before recovery is started.
 
37
<p>If the <b>db_recovery_init_fcn</b> function returns a non-zero value,
 
38
no recovery will be performed, and <a href="../api_c/env_open.html">DB_ENV-&gt;open</a> will return the same
 
39
value to its caller.
 
40
<p>The DB_ENV-&gt;set_recovery_init interface may be used only to configure Berkeley DB before
 
41
the <a href="../api_c/env_open.html">DB_ENV-&gt;open</a> interface is called.
 
42
<p>The DB_ENV-&gt;set_recovery_init function returns a non-zero error value on failure and 0 on success.
 
43
<h1>Errors</h1>
 
44
<p>The DB_ENV-&gt;set_recovery_init function may fail and return a non-zero error for the following conditions:
 
45
<p><dl compact>
 
46
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
 
47
<p>Called after <a href="../api_c/env_open.html">DB_ENV-&gt;open</a> was called.
 
48
</dl>
 
49
<p>The DB_ENV-&gt;set_recovery_init function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
 
50
If a catastrophic error has occurred, the DB_ENV-&gt;set_recovery_init function may fail and return
 
51
<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail
 
52
in the same way.
 
53
<h1>See Also</h1>
 
54
<a href="../api_c/env_create.html">db_env_create</a>,
 
55
<a href="../api_c/env_close.html">DB_ENV-&gt;close</a>,
 
56
<a href="../api_c/env_err.html">DB_ENV-&gt;err</a>, <a href="../api_c/env_err.html">DB_ENV-&gt;errx</a>
 
57
<a href="../api_c/env_open.html">DB_ENV-&gt;open</a>,
 
58
<a href="../api_c/env_remove.html">DB_ENV-&gt;remove</a>,
 
59
<a href="../api_c/env_set_alloc.html">DB_ENV-&gt;set_alloc</a>,
 
60
<a href="../api_c/env_set_cachesize.html">DB_ENV-&gt;set_cachesize</a>,
 
61
<a href="../api_c/env_set_data_dir.html">DB_ENV-&gt;set_data_dir</a>,
 
62
<a href="../api_c/env_set_errcall.html">DB_ENV-&gt;set_errcall</a>,
 
63
<a href="../api_c/env_set_errfile.html">DB_ENV-&gt;set_errfile</a>,
 
64
<a href="../api_c/env_set_errpfx.html">DB_ENV-&gt;set_errpfx</a>,
 
65
<a href="../api_c/env_set_feedback.html">DB_ENV-&gt;set_feedback</a>,
 
66
<a href="../api_c/env_set_flags.html">DB_ENV-&gt;set_flags</a>,
 
67
<a href="../api_c/env_set_mutexlocks.html">DB_ENV-&gt;set_mutexlocks</a>,
 
68
<a href="../api_c/env_set_pageyield.html">db_env_set_pageyield</a>,
 
69
<a href="../api_c/env_set_paniccall.html">DB_ENV-&gt;set_paniccall</a>,
 
70
<a href="../api_c/env_set_panicstate.html">db_env_set_panicstate</a>,
 
71
<a href="../api_c/env_set_rec_init.html">DB_ENV-&gt;set_recovery_init</a>,
 
72
<a href="../api_c/env_set_rpc_server.html">DB_ENV-&gt;set_rpc_server</a>,
 
73
<a href="../api_c/env_set_region_init.html">db_env_set_region_init</a>,
 
74
<a href="../api_c/env_set_shm_key.html">DB_ENV-&gt;set_shm_key</a>,
 
75
<a href="../api_c/env_set_tas_spins.html">db_env_set_tas_spins</a>,
 
76
<a href="../api_c/env_set_tmp_dir.html">DB_ENV-&gt;set_tmp_dir</a>,
 
77
<a href="../api_c/env_set_verbose.html">DB_ENV-&gt;set_verbose</a>,
 
78
<a href="../api_c/env_strerror.html">db_strerror</a>
 
79
and
 
80
<a href="../api_c/env_version.html">db_version</a>.
 
81
</tt>
 
82
<table width="100%"><tr><td><br></td><td align=right>
 
83
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
84
</td></tr></table>
 
85
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
 
86
</body>
 
87
</html>