evolution-data-server-doc 3.28.1-1ubuntu1 / usr / share / gtk-doc / html / evolution-data-server / evolution-data-server-ESourceSecurity.html

This file is indexed.

/usr/share/gtk-doc/html/evolution-data-server/evolution-data-server-ESourceSecurity.html is in evolution-data-server-doc 3.28.1-1ubuntu1.

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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ESourceSecurity: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch02.html" title="Data Source Extensions">
<link rel="prev" href="evolution-data-server-ESourceRevisionGuards.html" title="ESourceRevisionGuards">
<link rel="next" href="evolution-data-server-ESourceSMIME.html" title="ESourceSMIME">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#evolution-data-server-ESourceSecurity.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-data-server-ESourceRevisionGuards.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-data-server-ESourceSMIME.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-data-server-ESourceSecurity"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-data-server-ESourceSecurity.top_of_page"></a>ESourceSecurity</span></h2>
<p>ESourceSecurity — <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> extension for security settings</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-data-server-ESourceSecurity.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceSecurity.html#e-source-security-get-method" title="e_source_security_get_method ()">e_source_security_get_method</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceSecurity.html#e-source-security-dup-method" title="e_source_security_dup_method ()">e_source_security_dup_method</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceSecurity.html#e-source-security-set-method" title="e_source_security_set_method ()">e_source_security_set_method</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceSecurity.html#e-source-security-get-secure" title="e_source_security_get_secure ()">e_source_security_get_secure</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-ESourceSecurity.html#e-source-security-set-secure" title="e_source_security_set_secure ()">e_source_security_set_secure</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceSecurity.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-data-server-ESourceSecurity.html#E-SOURCE-EXTENSION-SECURITY:CAPS" title="E_SOURCE_EXTENSION_SECURITY">E_SOURCE_EXTENSION_SECURITY</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity">ESourceSecurity</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceSecurity.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libedataserver/libedataserver.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceSecurity.description"></a><h2>Description</h2>
<p>The <a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a> extension tracks settings for establishing a
secure connection with a remote server.</p>
<p>Access the extension as follows:</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="gtkdoc ppc">#include &lt;libedataserver/libedataserver.h&gt;</span>

ESourceSecurity <span class="gtkdoc opt">*</span>extension<span class="gtkdoc opt">;</span>

extension <span class="gtkdoc opt">=</span> <span class="function"><a href="../html/evolution-data-server-ESource.html#e-source-get-extension">e_source_get_extension</a></span> <span class="gtkdoc opt">(</span>source<span class="gtkdoc opt">,</span> E_SOURCE_EXTENSION_SECURITY<span class="gtkdoc opt">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceSecurity.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-source-security-get-method"></a><h3>e_source_security_get_method ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_source_security_get_method (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a> *extension</code></em>);</pre>
<p>Returns the method used to establish a secure network connection to a
remote account.  There are no pre-defined method names; backends are
free to set this however they wish.  If a secure connection is not
desired, the convention is to set <span class="type">“method”</span> to "none".</p>
<div class="refsect3">
<a name="e-source-security-get-method.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-security-get-method.returns"></a><h4>Returns</h4>
<p> the method used to establish a secure network connection</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-security-dup-method"></a><h3>e_source_security_dup_method ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_source_security_dup_method (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a> *extension</code></em>);</pre>
<p>Thread-safe variation of <a class="link" href="evolution-data-server-ESourceSecurity.html#e-source-security-get-method" title="e_source_security_get_method ()"><code class="function">e_source_security_get_method()</code></a>.
Use this function when accessing <em class="parameter"><code>extension</code></em>
 from multiple threads.</p>
<p>The returned string should be freed with <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.</p>
<div class="refsect3">
<a name="e-source-security-dup-method.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-security-dup-method.returns"></a><h4>Returns</h4>
<p> a newly-allocated copy of <span class="type">“method”</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-security-set-method"></a><h3>e_source_security_set_method ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_security_set_method (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a> *extension</code></em>,
                              <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);</pre>
<p>Sets the method used to establish a secure network connection to a
remote account.  There are no pre-defined method names; backends are
free to set this however they wish.  If a secure connection is not
desired, the convention is to set <span class="type">“method”</span> to "none".
In keeping with that convention, <span class="type">“method”</span> will be set
to "none" if <em class="parameter"><code>method</code></em>
 is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or an empty string.</p>
<div class="refsect3">
<a name="e-source-security-set-method.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method</p></td>
<td class="parameter_description"><p>security method, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-security-get-secure"></a><h3>e_source_security_get_secure ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_source_security_get_secure (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a> *extension</code></em>);</pre>
<p>This is a convenience function which returns whether a secure network
connection is desired, regardless of the method used.  This relies on
the convention of setting <span class="type">“method”</span> to "none" when a
secure network connection is <span class="emphasis"><em>not</em></span> desired.</p>
<div class="refsect3">
<a name="e-source-security-get-secure.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-security-get-secure.returns"></a><h4>Returns</h4>
<p> whether a secure network connection is desired</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-security-set-secure"></a><h3>e_source_security_set_secure ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_security_set_secure (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a> *extension</code></em>,
                              <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> secure</code></em>);</pre>
<p>This function provides a simpler way to set <span class="type">“method”</span>
when using a secure network connection is a yes or no option and the
exact method name is unimportant.  If <em class="parameter"><code>secure</code></em>
 is <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, the
<span class="type">“method”</span> property is set to "none".  If <em class="parameter"><code>secure</code></em>
 is
<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the function assumes the backend will use Transport Layer
Security and sets the <span class="type">“method”</span> property to "tls".</p>
<div class="refsect3">
<a name="e-source-security-set-secure.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>secure</p></td>
<td class="parameter_description"><p>whether a secure network connection is desired</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceSecurity.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="E-SOURCE-EXTENSION-SECURITY:CAPS"></a><h3>E_SOURCE_EXTENSION_SECURITY</h3>
<pre class="programlisting">#define E_SOURCE_EXTENSION_SECURITY "Security"
</pre>
<p>Pass this extension name to <a class="link" href="evolution-data-server-ESource.html#e-source-get-extension" title="e_source_get_extension ()"><code class="function">e_source_get_extension()</code></a> to access
<a class="link" href="evolution-data-server-ESourceSecurity.html#ESourceSecurity" title="struct ESourceSecurity"><span class="type">ESourceSecurity</span></a>.  This is also used as a group name in key files.</p>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceSecurity"></a><h3>struct ESourceSecurity</h3>
<pre class="programlisting">struct ESourceSecurity {
};
</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.