This file is indexed.

/usr/share/gtk-doc/html/libebackend/libebackend-e-data-server-module.html is in libebackend1.2-dev 3.2.3-0ubuntu7.1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-data-server-module</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="prev" href="libebackend-e-dbhash.html" title="e-dbhash">
<link rel="next" href="libebackend-e-db3-utils.html" title="e-db3-utils">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libebackend-e-dbhash.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution-Data-Server Manual: Backend Utilities (libebackend)</th>
<td><a accesskey="n" href="libebackend-e-db3-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libebackend-e-data-server-module.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libebackend-e-data-server-module.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libebackend-e-data-server-module"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libebackend-e-data-server-module.top_of_page"></a>e-data-server-module</span></h2>
<p>e-data-server-module — Backend module loader</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libebackend-e-data-server-module.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">gboolean</span>            <a class="link" href="libebackend-e-data-server-module.html#e-data-server-module-init" title="e_data_server_module_init ()">e_data_server_module_init</a>           (<em class="parameter"><code>const <span class="type">gchar</span> *module_path</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GList</span> *             <a class="link" href="libebackend-e-data-server-module.html#e-data-server-get-extensions-for-type" title="e_data_server_get_extensions_for_type ()">e_data_server_get_extensions_for_type</a>
                                                        (<em class="parameter"><code><span class="type">GType</span> type</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libebackend-e-data-server-module.html#e-data-server-extension-list-free" title="e_data_server_extension_list_free ()">e_data_server_extension_list_free</a>   (<em class="parameter"><code><span class="type">GList</span> *extensions</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libebackend-e-data-server-module.html#e-data-server-module-remove-unused" title="e_data_server_module_remove_unused ()">e_data_server_module_remove_unused</a>  (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libebackend-e-data-server-module.html#e-data-server-module-add-type" title="e_data_server_module_add_type ()">e_data_server_module_add_type</a>       (<em class="parameter"><code><span class="type">GType</span> type</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libebackend-e-data-server-module.html#eds-module-initialize" title="eds_module_initialize ()">eds_module_initialize</a>               (<em class="parameter"><code><span class="type">GTypeModule</span> *module</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libebackend-e-data-server-module.html#eds-module-shutdown" title="eds_module_shutdown ()">eds_module_shutdown</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libebackend-e-data-server-module.html#eds-module-list-types" title="eds_module_list_types ()">eds_module_list_types</a>               (<em class="parameter"><code>const <span class="type">GType</span> **types</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *num_types</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libebackend-e-data-server-module.description"></a><h2>Description</h2>
<p>
An <span class="type">EDataServerModule</span> loads backend modules from the directory given
in <a class="link" href="libebackend-e-data-server-module.html#e-data-server-module-init" title="e_data_server_module_init ()"><code class="function">e_data_server_module_init()</code></a>.  Each backend module must export three
functions.  The first two -- <a class="link" href="libebackend-e-data-server-module.html#eds-module-initialize" title="eds_module_initialize ()"><code class="function">eds_module_initialize()</code></a> and
<a class="link" href="libebackend-e-data-server-module.html#eds-module-list-types" title="eds_module_list_types ()"><code class="function">eds_module_list_types()</code></a> -- are called immediately after the backend
module is loaded.  The last one -- <a class="link" href="libebackend-e-data-server-module.html#eds-module-shutdown" title="eds_module_shutdown ()"><code class="function">eds_module_shutdown()</code></a> -- is called
when the backend module is unloaded.
</p>
</div>
<div class="refsect1">
<a name="libebackend-e-data-server-module.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="e-data-server-module-init"></a><h3>e_data_server_module_init ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_data_server_module_init           (<em class="parameter"><code>const <span class="type">gchar</span> *module_path</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Loads all backend modules in <em class="parameter"><code>module_path</code></em>.  If an error occurs,
the function sets <em class="parameter"><code>error</code></em> and returns <code class="literal">FALSE</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>module_path</code></em> :</span></p></td>
<td>directory of backend modules</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-data-server-get-extensions-for-type"></a><h3>e_data_server_get_extensions_for_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *             e_data_server_get_extensions_for_type
                                                        (<em class="parameter"><code><span class="type">GType</span> type</code></em>);</pre>
<p>
Returns a list of objects derived from <em class="parameter"><code>type</code></em> which have been registered
through <a class="link" href="libebackend-e-data-server-module.html#eds-module-list-types" title="eds_module_list_types ()"><code class="function">eds_module_list_types()</code></a> or <a class="link" href="libebackend-e-data-server-module.html#e-data-server-module-add-type" title="e_data_server_module_add_type ()"><code class="function">e_data_server_module_add_type()</code></a>.
</p>
<p>
Free the returned list using <a class="link" href="libebackend-e-data-server-module.html#e-data-server-extension-list-free" title="e_data_server_extension_list_free ()"><code class="function">e_data_server_extension_list_free()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a <span class="type">GType</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of extension objects</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-data-server-extension-list-free"></a><h3>e_data_server_extension_list_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_server_extension_list_free   (<em class="parameter"><code><span class="type">GList</span> *extensions</code></em>);</pre>
<p>
Frees a list of objects returned by
<a class="link" href="libebackend-e-data-server-module.html#e-data-server-get-extensions-for-type" title="e_data_server_get_extensions_for_type ()"><code class="function">e_data_server_get_extensions_for_type()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>extensions</code></em> :</span></p></td>
<td>a list of extension objects</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-data-server-module-remove-unused"></a><h3>e_data_server_module_remove_unused ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_server_module_remove_unused  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Unrefs all loaded modules, so that unused modules are unloaded from the
system.
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-data-server-module-add-type"></a><h3>e_data_server_module_add_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_server_module_add_type       (<em class="parameter"><code><span class="type">GType</span> type</code></em>);</pre>
<p>
Creates an instance of <em class="parameter"><code>type</code></em> and adds the instance to an internal list
which can be queried using <a class="link" href="libebackend-e-data-server-module.html#e-data-server-get-extensions-for-type" title="e_data_server_get_extensions_for_type ()"><code class="function">e_data_server_get_extensions_for_type()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a <span class="type">GType</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="eds-module-initialize"></a><h3>eds_module_initialize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                eds_module_initialize               (<em class="parameter"><code><span class="type">GTypeModule</span> *module</code></em>);</pre>
<p>
Each backend module must define this function.  The module should call
<code class="function">g_type_module_register_type()</code> to register all dynamically-loaded types.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
<td>a <span class="type">GTypeModule</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="eds-module-shutdown"></a><h3>eds_module_shutdown ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                eds_module_shutdown                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Each backend module must define this function.  The module should
release resources and perform any necessary cleanup actions prior
to the service being shut down.
</p>
</div>
<hr>
<div class="refsect2">
<a name="eds-module-list-types"></a><h3>eds_module_list_types ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                eds_module_list_types               (<em class="parameter"><code>const <span class="type">GType</span> **types</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *num_types</code></em>);</pre>
<p>
Each backend module must define this function.  The module should
point <em class="parameter"><code>types</code></em> to a list of types registered in <a class="link" href="libebackend-e-data-server-module.html#eds-module-initialize" title="eds_module_initialize ()"><code class="function">eds_module_initialize()</code></a>
and also set <em class="parameter"><code>num_types</code></em> to the length of that list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>types</code></em> :</span></p></td>
<td>return location for a <span class="type">GType</span> list</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_types</code></em> :</span></p></td>
<td>the length of the <span class="type">GType</span> list</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>