Debian Codegraph @

docs/api_reference/C/repmgr_site_by_eid.html

raw
1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <title>DB_ENV-&gt;repmgr_site_by_eid()</title>
7 <link rel="stylesheet" href="apiReference.css" type="text/css" />
8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
9 <link rel="start" href="index.html" title="Berkeley DB C API Reference" />
10 <link rel="up" href="rep.html" title="Chapter 10.  Replication Methods" />
11 <link rel="prev" href="repmgr_site.html" title="DB_ENV-&gt;repmgr_site()" />
12 <link rel="next" href="repmgrsite_list.html" title="DB_ENV-&gt;repmgr_site_list()" />
13 </head>
14 <body>
15 <div xmlns="" class="navheader">
16 <div class="libver">
17 <p>Library Version 11.2.5.3</p>
18 </div>
19 <table width="100%" summary="Navigation header">
20 <tr>
21 <th colspan="3" align="center">DB_ENV-&gt;repmgr_site_by_eid()</th>
22 </tr>
23 <tr>
24 <td width="20%" align="left"><a accesskey="p" href="repmgr_site.html">Prev</a> </td>
25 <th width="60%" align="center">Chapter 10. 
26 Replication Methods
27 </th>
28 <td width="20%" align="right"> <a accesskey="n" href="repmgrsite_list.html">Next</a></td>
29 </tr>
30 </table>
31 <hr />
32 </div>
33 <div class="sect1" lang="en" xml:lang="en">
34 <div class="titlepage">
35 <div>
36 <div>
37 <h2 class="title" style="clear: both"><a id="repmgr_site_by_eid"></a>DB_ENV-&gt;repmgr_site_by_eid()</h2>
38 </div>
39 </div>
40 </div>
41 <pre class="programlisting">#include &lt;db.h&gt;
42
43 int
44 DB_ENV-&gt;repmgr_site_by_eid(DB_ENV *env, int eid,
45 DB_SITE **sitep); </pre>
46 <p>
47 The <code class="methodname">DB_ENV-&gt;repmgr_site_by_eid()</code> method returns a
48 DB_SITE handle based on the site's Environment ID
49 value. You use the DB_SITE
50 handle to configure and manage replication sites.
51 </p>
52 <p>
53 This method allocates memory for the handle, returning a pointer to
54 the structure in the memory to which
55 <span class="bold"><strong>sitep</strong></span> refers. To release the
56 allocated memory and discard the handle, call the
57 <a class="xref" href="dbsite_close.html" title="DB_SITE-&gt;close()">DB_SITE-&gt;close()</a>
58 method.
59 </p>
60 <p>
61 The <code class="methodname">DB_ENV-&gt;repmgr_site_by_eid()</code> method may
62 be called at any time after environment open time.
63 </p>
64 <p>
65 The <code class="methodname">DB_ENV-&gt;repmgr_site_by_eid()</code> <span>
66 <span>
67 method returns a non-zero error value on failure and 0 on success.
68 </span>
69
70 </span>
71 </p>
72 <div class="sect2" lang="en" xml:lang="en">
73 <div class="titlepage">
74 <div>
75 <div>
76 <h3 class="title"><a id="idp54440064"></a>Parameters</h3>
77 </div>
78 </div>
79 </div>
80 <div class="sect3" lang="en" xml:lang="en">
81 <div class="titlepage">
82 <div>
83 <div>
84 <h4 class="title"><a id="idp54440536"></a>eid</h4>
85 </div>
86 </div>
87 </div>
88 <p>
89 The Environment ID of the site for which you want
90 to create the DB_SITE handle. You can obtain a
91 site's EID by using the
92 <a class="xref" href="dbsite_get_eid.html" title="DB_SITE-&gt;get_eid()">DB_SITE-&gt;get_eid()</a>
93 method.
94 </p>
95 </div>
96 <div class="sect3" lang="en" xml:lang="en">
97 <div class="titlepage">
98 <div>
99 <div>
100 <h4 class="title"><a id="idp54390920"></a>sitep</h4>
101 </div>
102 </div>
103 </div>
104 <p>
105 References memory into which a pointer
106 to the allocated handle is copied.
107 </p>
108 </div>
109 </div>
110 <div class="sect2" lang="en" xml:lang="en">
111 <div class="titlepage">
112 <div>
113 <div>
114 <h3 class="title"><a id="idp54442688"></a>Errors</h3>
115 </div>
116 </div>
117 </div>
118 <p>
119 The <code class="methodname">DB_ENV-&gt;repmgr_site()</code>
120 <span>
121 <span>
122 method may fail and return one of the following non-zero errors:
123 </span>
124
125 </span>
126 </p>
127 <div class="sect3" lang="en" xml:lang="en">
128 <div class="titlepage">
129 <div>
130 <div>
131 <h4 class="title"><a id="idp54446496"></a>EINVAL</h4>
132 </div>
133 </div>
134 </div>
135 <p>
136 If this method is called from a Base API application,
137 or if an invalid flag value or parameter was specified.
138 </p>
139 </div>
140 </div>
141 <div class="sect2" lang="en" xml:lang="en">
142 <div class="titlepage">
143 <div>
144 <div>
145 <h3 class="title"><a id="idp54445416"></a>Class</h3>
146 </div>
147 </div>
148 </div>
149 <p>
150 <a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>
151 </p>
152 </div>
153 <div class="sect2" lang="en" xml:lang="en">
154 <div class="titlepage">
155 <div>
156 <div>
157 <h3 class="title"><a id="idp54440600"></a>See Also</h3>
158 </div>
159 </div>
160 </div>
161 <p>
162 <a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a>
163 </p>
164 </div>
165 </div>
166 <div class="navfooter">
167 <hr />
168 <table width="100%" summary="Navigation footer">
169 <tr>
170 <td width="40%" align="left"><a accesskey="p" href="repmgr_site.html">Prev</a> </td>
171 <td width="20%" align="center">
172 <a accesskey="u" href="rep.html">Up</a>
173 </td>
174 <td width="40%" align="right"> <a accesskey="n" href="repmgrsite_list.html">Next</a></td>
175 </tr>
176 <tr>
177 <td width="40%" align="left" valign="top">DB_ENV-&gt;repmgr_site() </td>
178 <td width="20%" align="center">
179 <a accesskey="h" href="index.html">Home</a>
180 </td>
181 <td width="40%" align="right" valign="top"> DB_ENV-&gt;repmgr_site_list()</td>
182 </tr>
183 </table>
184 </div>
185 </body>
186 </html>