blob: dcb40090d3ce5f618ce445271b43e102e875a097 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
<?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->repmgr_site_by_eid()</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="repmgr_site.html" title="DB_ENV->repmgr_site()" />
<link rel="next" href="repmgrsite_list.html" title="DB_ENV->repmgr_site_list()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 12.1.6.1</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_ENV->repmgr_site_by_eid()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="repmgr_site.html">Prev</a> </td>
<th width="60%" align="center">Chapter 10.
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="repmgrsite_list.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="repmgr_site_by_eid"></a>DB_ENV->repmgr_site_by_eid()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db.h>
int
DB_ENV->repmgr_site_by_eid(DB_ENV *env, int eid,
DB_SITE **sitep); </pre>
<p>
The <code class="methodname">DB_ENV->repmgr_site_by_eid()</code> method returns a
DB_SITE handle based on the site's environment ID
value. You use the DB_SITE
handle to configure and manage replication sites.
</p>
<p>
This method allocates memory for the handle, returning a pointer to
the structure in the memory to which
<span class="bold"><strong>sitep</strong></span> refers. To release the
allocated memory and discard the handle, call the
<a class="xref" href="dbsite_close.html" title="DB_SITE->close()">DB_SITE->close()</a>
method.
</p>
<p>
The <code class="methodname">DB_ENV->repmgr_site_by_eid()</code> method may
be called at any time after opening the environment.
</p>
<p>
The <code class="methodname">DB_ENV->repmgr_site_by_eid()</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="idp4158160"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp4158632"></a>eid</h4>
</div>
</div>
</div>
<p>
The environment ID of the site for which you want
to create the DB_SITE handle. You can obtain a
site's EID by using the
<a class="xref" href="dbsite_get_eid.html" title="DB_SITE->get_eid()">DB_SITE->get_eid()</a>
method.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp4150136"></a>sitep</h4>
</div>
</div>
</div>
<p>
References memory into which a pointer
to the allocated handle is copied.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp4160784"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DB_ENV->repmgr_site()</code>
<span>
<span>
method may fail and return one of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp4164632"></a>DB_NOTFOUND</h4>
</div>
</div>
</div>
<p>
Returned if there is no site corresponding to the supplied
<span class="bold"><strong>eid</strong></span> value.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp4158696"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If this method is called from a Base API application,
or if an invalid flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp4163552"></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="idp4165648"></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>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="repmgr_site.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="repmgrsite_list.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_ENV->repmgr_site() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_ENV->repmgr_site_list()</td>
</tr>
</table>
</div>
</body>
</html>
|
