<?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>DbEnv::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 11. Replication Methods" /> <link rel="prev" href="repmgr_site.html" title="DbEnv::repmgr_site()" /> <link rel="next" href="repmgrsite_list.html" title="DbEnv::repmgr_site_list()" /> </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">DbEnv::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 11. 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>DbEnv::repmgr_site_by_eid()</h2> </div> </div> </div> <pre class="programlisting">#include <db_cxx.h> int DbEnv::repmgr_site_by_eid(int eid, DB_SITE **sitep </pre> <p> The <code class="methodname">DbEnv::repmgr_site_by_eid()</code> method returns a DbSite handle based on the site's Environment ID value. You use the DbSite 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="DbSite::close()">DbSite::close()</a> method. </p> <p> The <code class="methodname">DbEnv::repmgr_site_by_eid()</code> method may be called at any time after environment open time. </p> <p> The <code class="methodname">DbEnv::repmgr_site_by_eid()</code> <span> <span> method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success. </span> </span> </p> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp4567192"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp4566544"></a>eid</h4> </div> </div> </div> <p> The Environment ID of the site for which you want to create the DbSite handle. You can obtain a site's EID by using the <a class="xref" href="dbsite_get_eid.html" title="DbSite::get_eid()">DbSite::get_eid()</a> method. </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp4548176"></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="idp4546912"></a>Errors</h3> </div> </div> </div> <p> The <code class="methodname">DbEnv::repmgr_site()</code> <span> <span> method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> exception, encapsulating one of the following non-zero errors, or 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="idp4573504"></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="idp4572424"></a>Class</h3> </div> </div> </div> <p> <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp4574800"></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">DbEnv::repmgr_site() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> DbEnv::repmgr_site_list()</td> </tr> </table> </div> </body> </html>