This file is indexed.

/usr/share/gtk-doc/html/libedataserverui/libedataserverui-e-book-auth-util.html is in libedataserverui-3.0-dev 3.2.3-0ubuntu6.

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
<!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-book-auth-util</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)">
<link rel="prev" href="ch01.html" title="Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)">
<link rel="next" href="libedataserverui-ECategoriesDialog.html" title="ECategoriesDialog">
<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="ch01.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: Graphical Utilities (libedataserverui)</th>
<td><a accesskey="n" href="libedataserverui-ECategoriesDialog.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libedataserverui-e-book-auth-util.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libedataserverui-e-book-auth-util.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libedataserverui-e-book-auth-util"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libedataserverui-e-book-auth-util.top_of_page"></a>e-book-auth-util</span></h2>
<p>e-book-auth-util</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libedataserverui-e-book-auth-util.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">EBook</span> *             <a class="link" href="libedataserverui-e-book-auth-util.html#e-load-book-source" title="e_load_book_source ()">e_load_book_source</a>                  (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
                                                         <em class="parameter"><code><span class="type">EBookCallback</span> open_func</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libedataserverui-e-book-auth-util.html#e-load-book-source-async" title="e_load_book_source_async ()">e_load_book_source_async</a>            (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
                                                         <em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>,
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">EBook</span> *             <a class="link" href="libedataserverui-e-book-auth-util.html#e-load-book-source-finish" title="e_load_book_source_finish ()">e_load_book_source_finish</a>           (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libedataserverui-e-book-auth-util.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libedataserverui-e-book-auth-util.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="e-load-book-source"></a><h3>e_load_book_source ()</h3>
<pre class="programlisting"><span class="returnvalue">EBook</span> *             e_load_book_source                  (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
                                                         <em class="parameter"><code><span class="type">EBookCallback</span> open_func</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">e_load_book_source</code> has been deprecated since version 3.0 and should not be used in newly-written code. Use <a class="link" href="libedataserverui-e-book-auth-util.html#e-load-book-source-async" title="e_load_book_source_async ()"><code class="function">e_load_book_source_async()</code></a> instead.</p>
</div>
<p>
Creates a new <span class="type">EBook</span> specified by <em class="parameter"><code>source</code></em>, and starts a non-blocking
open operation on it. If the book requires authorization, presents
a window asking the user for such.
</p>
<p>
When the operation finishes, calls the callback function indicating
if it succeeded or not. If you don't care, you can pass <code class="literal">NULL</code> for
<em class="parameter"><code>open_func</code></em>, and no action will be taken on completion.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>an <span class="type">ESource</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>open_func</code></em> :</span></p></td>
<td>a function to call when the operation finishes, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to callback function</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <span class="type">EBook</span> that is being opened.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-load-book-source-async"></a><h3>e_load_book_source_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                e_load_book_source_async            (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
                                                         <em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>,
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">e_load_book_source_async</code> has been deprecated since version 3.2 and should not be used in newly-written code. Use <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-open-new" title="e_client_utils_open_new ()"><code class="function">e_client_utils_open_new()</code></a>, <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-open-new-finish" title="e_client_utils_open_new_finish ()"><code class="function">e_client_utils_open_new_finish()</code></a> instead.</p>
</div>
<p>
Creates a new <span class="type">EBook</span> specified by <em class="parameter"><code>source</code></em> and opens it, prompting the
user for authentication if necessary.
</p>
<p>
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called.  You can
then call <a class="link" href="libedataserverui-e-book-auth-util.html#e-load-book-source-finish" title="e_load_book_source_finish ()"><code class="function">e_load_book_source_finish()</code></a> to obtain the resulting <span class="type">EBook</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>an <span class="type">ESource</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>parent window for password dialogs, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, <code class="literal">NULL</code> to ignore</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>the data to pass to <em class="parameter"><code>callback</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="e-load-book-source-finish"></a><h3>e_load_book_source_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">EBook</span> *             e_load_book_source_finish           (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">e_load_book_source_finish</code> has been deprecated since version 3.2 and should not be used in newly-written code. Use <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-open-new" title="e_client_utils_open_new ()"><code class="function">e_client_utils_open_new()</code></a>, <a class="link" href="libedataserverui-EClient-Utilities.html#e-client-utils-open-new-finish" title="e_client_utils_open_new_finish ()"><code class="function">e_client_utils_open_new_finish()</code></a> instead.</p>
</div>
<p>
Finishes an asynchronous <span class="type">EBook</span> open operation started with
<a class="link" href="libedataserverui-e-book-auth-util.html#e-load-book-source-async" title="e_load_book_source_async ()"><code class="function">e_load_book_source_async()</code></a>.  If an error occurred, or the user
declined to authenticate, the function will return <code class="literal">NULL</code> and
set <em class="parameter"><code>error</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>an <span class="type">ESource</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <span class="type">GAsyncResult</span>
</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>a ready-to-use <span class="type">EBook</span>, or <code class="literal">NULL</code> or error</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>