summaryrefslogtreecommitdiff
path: root/docs/api_reference/C/dbsite_remove.html
blob: da0658003b7dced1343d4d221f3ca098d94173bb (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
<?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_SITE-&gt;remove()</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="dbsite_get_eid.html" title="DB_SITE-&gt;get_eid()" />
    <link rel="next" href="dbsite_set_config.html" title="DB_SITE-&gt;set_config()" />
  </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_SITE-&gt;remove()</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="dbsite_get_eid.html">Prev</a> </td>
          <th width="60%" align="center">Chapter 10. 
                Replication Methods
        </th>
          <td width="20%" align="right"> <a accesskey="n" href="dbsite_set_config.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="dbsite_remove"></a>DB_SITE-&gt;remove()</h2>
          </div>
        </div>
      </div>
      <pre class="programlisting">#include &lt;db.h&gt;

int
DB_SITE-&gt;remove(DB_SITE *site); </pre>
      <p>
         The <code class="methodname">DB_SITE-&gt;remove()</code> method removes the
         site from the replication group.  If called at the master site,
         Replication Manager updates the group membership database directly. If
         called from a
         client, this method causes a request to be sent to the master to
         perform the operation. The method then awaits confirmation.
    </p>
      <p>
         The DB_SITE handle must not be accessed again after this
         method is called, regardless of the return value.
         This method may not be
         called before starting Replication Manager.
    </p>
      <p>
         The <code class="methodname">DB_SITE-&gt;remove()</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="idp3592480"></a>Errors</h3>
            </div>
          </div>
        </div>
        <p>
             The <code class="methodname">DB_SITE-&gt;remove()</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="idp3595960"></a>DB_REP_UNAVAIL</h4>
              </div>
            </div>
          </div>
          <p>
                The master updated the group membership database but did not
                receive enough
                acknowledgements from clients to meet the current
                acknowledgement policy or there was an attempt to remove the
                current master site from the replication group.
            </p>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp3585456"></a>EINVAL</h4>
              </div>
            </div>
          </div>
          <p>
                If Replication Manager has not been started.
            </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp3585928"></a>Class</h3>
            </div>
          </div>
        </div>
        <p>
            <a class="link" href="db_site.html" title="The DB_SITE Handle">DB_SITE</a>  
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp3572752"></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="dbsite_get_eid.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="dbsite_set_config.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">DB_SITE-&gt;get_eid() </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> DB_SITE-&gt;set_config()</td>
        </tr>
      </table>
    </div>
  </body>
</html>