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

This file is indexed.

/usr/share/gtk-doc/html/evolution-data-server/evolution-data-server-e-url.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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
<!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-url: 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="ch16.html" title="Common Deprecated Classes">
<link rel="prev" href="evolution-data-server-EProxy.html" title="EProxy">
<link rel="next" href="ch17.html" title="Client Deprecated Classes">
<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-e-url.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="ch16.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-data-server-EProxy.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch17.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-e-url"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-data-server-e-url.top_of_page"></a>e-url</span></h2>
<p>e-url</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-data-server-e-url.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">
<a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="returnvalue">EUri</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-e-url.html#e-uri-new" title="e_uri_new ()">e_uri_new</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-e-url.html#e-uri-free" title="e_uri_free ()">e_uri_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<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-e-url.html#e-uri-get-param" title="e_uri_get_param ()">e_uri_get_param</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="returnvalue">EUri</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-e-url.html#e-uri-copy" title="e_uri_copy ()">e_uri_copy</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-e-url.html#e-uri-to-string" title="e_uri_to_string ()">e_uri_to_string</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-e-url.html#e-url-shroud" title="e_url_shroud ()">e_url_shroud</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-e-url.html#e-url-equal" title="e_url_equal ()">e_url_equal</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-e-url.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="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri">EUri</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-e-url.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="evolution-data-server-e-url.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-uri-new"></a><h3>e_uri_new ()</h3>
<pre class="programlisting"><a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="returnvalue">EUri</span></a> *
e_uri_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri_string</code></em>);</pre>
<div class="warning"><p><code class="literal">e_uri_new</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Creates an <a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> representation of the uri given in <em class="parameter"><code>uri_string</code></em>
.</p>
<div class="refsect3">
<a name="e-uri-new.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>uri_string</p></td>
<td class="parameter_description"><p>The uri to represent as an <a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-uri-new.returns"></a><h4>Returns</h4>
<p> The newly-allocated <a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> structure.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-uri-free"></a><h3>e_uri_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_uri_free (<em class="parameter"><code><a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>);</pre>
<div class="warning"><p><code class="literal">e_uri_free</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Frees the memory of an <a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> structure.</p>
<div class="refsect3">
<a name="e-uri-free.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>uri</p></td>
<td class="parameter_description"><p>A pointer to the <a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> to free.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-uri-get-param"></a><h3>e_uri_get_param ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_uri_get_param (<em class="parameter"><code><a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>,
                 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<div class="warning"><p><code class="literal">e_uri_get_param</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Retrieves the value of the parameter associated with <em class="parameter"><code>name</code></em>
 in <em class="parameter"><code>uri</code></em>
.</p>
<div class="refsect3">
<a name="e-uri-get-param.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>uri</p></td>
<td class="parameter_description"><p>The <a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> to get the parameter from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The name of the parameter to get.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-uri-get-param.returns"></a><h4>Returns</h4>
<p> The value of the parameter.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-uri-copy"></a><h3>e_uri_copy ()</h3>
<pre class="programlisting"><a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="returnvalue">EUri</span></a> *
e_uri_copy (<em class="parameter"><code><a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>);</pre>
<div class="warning"><p><code class="literal">e_uri_copy</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Makes a copy of <em class="parameter"><code>uri</code></em>
.</p>
<div class="refsect3">
<a name="e-uri-copy.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>uri</p></td>
<td class="parameter_description"><p>The <a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> to copy.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-uri-copy.returns"></a><h4>Returns</h4>
<p> The newly-allocated copy of <em class="parameter"><code>uri</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-uri-to-string"></a><h3>e_uri_to_string ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_uri_to_string (<em class="parameter"><code><a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>,
                 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_password</code></em>);</pre>
<div class="warning"><p><code class="literal">e_uri_to_string</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Creates a string representation of <em class="parameter"><code>uri</code></em>
. The password will only be
included in the string if <em class="parameter"><code>show_password</code></em>
 is set to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
<div class="refsect3">
<a name="e-uri-to-string.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>uri</p></td>
<td class="parameter_description"><p>The <a class="link" href="evolution-data-server-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> to convert to a string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_password</p></td>
<td class="parameter_description"><p>Whether or not to show the password in the string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-uri-to-string.returns"></a><h4>Returns</h4>
<p> The string representation of <em class="parameter"><code>uri</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-url-shroud"></a><h3>e_url_shroud ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_url_shroud (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>);</pre>
<div class="warning"><p><code class="literal">e_url_shroud</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Removes the moniker (i.e. mailto:) from a url.</p>
<div class="refsect3">
<a name="e-url-shroud.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>url</p></td>
<td class="parameter_description"><p>The url to shroud.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-url-shroud.returns"></a><h4>Returns</h4>
<p> The newly-allocated shrouded url.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-url-equal"></a><h3>e_url_equal ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_url_equal (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url1</code></em>,
             <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url2</code></em>);</pre>
<div class="warning"><p><code class="literal">e_url_equal</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Checks two urls for equality, after first removing any monikers on
the urls.</p>
<div class="refsect3">
<a name="e-url-equal.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>url1</p></td>
<td class="parameter_description"><p>The first url to compare.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>url2</p></td>
<td class="parameter_description"><p>The second url to compare.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-url-equal.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the urls are equal, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they are not.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="evolution-data-server-e-url.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EUri"></a><h3>struct EUri</h3>
<pre class="programlisting">struct EUri {
	gchar *protocol;
	gchar *user;
	gchar *authmech;
	gchar *passwd;
	gchar *host;
	gint port;
	gchar *path;
	GData *params;
	gchar *query;
	gchar *fragment;
};
</pre>
<div class="warning"><p><code class="literal">EUri</code> is deprecated and should not be used in newly-written code.</p></div>
<p>A structure representing a URI.</p>
<div class="refsect3">
<a name="EUri.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.protocol"></a>protocol</code></em>;</p></td>
<td class="struct_member_description"><p>The protocol to use.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.user"></a>user</code></em>;</p></td>
<td class="struct_member_description"><p>A user name.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.authmech"></a>authmech</code></em>;</p></td>
<td class="struct_member_description"><p>The authentication mechanism.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.passwd"></a>passwd</code></em>;</p></td>
<td class="struct_member_description"><p>The connection password.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.host"></a>host</code></em>;</p></td>
<td class="struct_member_description"><p>The host name.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="EUri.port"></a>port</code></em>;</p></td>
<td class="struct_member_description"><p>The port number.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.path"></a>path</code></em>;</p></td>
<td class="struct_member_description"><p>The file path on the host.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Keyed-Data-Lists.html#GData"><span class="type">GData</span></a> *<em class="structfield"><code><a name="EUri.params"></a>params</code></em>;</p></td>
<td class="struct_member_description"><p>Additional parameters.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.query"></a>query</code></em>;</p></td>
<td class="struct_member_description"><p>The URI query.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.fragment"></a>fragment</code></em>;</p></td>
<td class="struct_member_description"><p>The URI fragment.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.