File: EBookBackendSummary.html

package info (click to toggle)
evolution-data-server 2.30.3-2%2Bsqueeze1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 45,704 kB
  • ctags: 26,968
  • sloc: ansic: 223,692; sh: 10,413; makefile: 2,646; xml: 386; perl: 204; python: 30
file content (393 lines) | stat: -rw-r--r-- 24,435 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EBookBackendSummary</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Address Book Backend (libedata-book)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Address Book Backend (libedata-book)">
<link rel="prev" href="EBookBackendSExp.html" title="EBookBackendSExp">
<link rel="next" href="EBookBackendSync.html" title="EBookBackendSync">
<meta name="generator" content="GTK-Doc V1.14 (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="EBookBackendSExp.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: Address Book Backend (libedata-book)</th>
<td><a accesskey="n" href="EBookBackendSync.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EBookBackendSummary.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#EBookBackendSummary.description" class="shortcut">Description</a>
                   | 
                  <a href="#EBookBackendSummary.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="EBookBackendSummary">
<a name="EBookBackendSummary"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EBookBackendSummary.top_of_page"></a>EBookBackendSummary</span></h2>
<p>EBookBackendSummary</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="EBookBackendSummary.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="EBookBackendSummary.html#EBookBackendSummary-struct" title="struct EBookBackendSummary">EBookBackendSummary</a>;
<a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="returnvalue">EBookBackendSummary</span></a>* <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-new" title="e_book_backend_summary_new ()">e_book_backend_summary_new</a>         (<em class="parameter"><code>const <span class="type">gchar</span> *summary_path</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> flush_timeout_millis</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-load" title="e_book_backend_summary_load ()">e_book_backend_summary_load</a>         (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-save" title="e_book_backend_summary_save ()">e_book_backend_summary_save</a>         (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-add-contact" title="e_book_backend_summary_add_contact ()">e_book_backend_summary_add_contact</a>  (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code><a href="/home/mbarnes/local/stable/share/gtk-doc/html/libebook/EContact.html"><span class="type">EContact</span></a> *contact</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-remove-contact" title="e_book_backend_summary_remove_contact ()">e_book_backend_summary_remove_contact</a>
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-check-contact" title="e_book_backend_summary_check_contact ()">e_book_backend_summary_check_contact</a>
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-touch" title="e_book_backend_summary_touch ()">e_book_backend_summary_touch</a>        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-is-up-to-date" title="e_book_backend_summary_is_up_to_date ()">e_book_backend_summary_is_up_to_date</a>
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code><span class="type">time_t</span> t</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-is-summary-query" title="e_book_backend_summary_is_summary_query ()">e_book_backend_summary_is_summary_query</a>
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>);
<span class="returnvalue">GPtrArray</span>*          <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-search" title="e_book_backend_summary_search ()">e_book_backend_summary_search</a>       (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>);
<span class="returnvalue">gchar</span> *             <a class="link" href="EBookBackendSummary.html#e-book-backend-summary-get-summary-vcard" title="e_book_backend_summary_get_summary_vcard ()">e_book_backend_summary_get_summary_vcard</a>
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="EBookBackendSummary.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----EBookBackendSummary
</pre>
</div>
<div class="refsect1" title="Description">
<a name="EBookBackendSummary.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="EBookBackendSummary.details"></a><h2>Details</h2>
<div class="refsect2" title="struct EBookBackendSummary">
<a name="EBookBackendSummary-struct"></a><h3>struct EBookBackendSummary</h3>
<pre class="programlisting">struct EBookBackendSummary;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="e_book_backend_summary_new ()">
<a name="e-book-backend-summary-new"></a><h3>e_book_backend_summary_new ()</h3>
<pre class="programlisting"><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="returnvalue">EBookBackendSummary</span></a>* e_book_backend_summary_new         (<em class="parameter"><code>const <span class="type">gchar</span> *summary_path</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> flush_timeout_millis</code></em>);</pre>
<p>
Creates an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> object without loading it
or otherwise affecting the file. <em class="parameter"><code>flush_timeout_millis</code></em>
specifies how much time should elapse, at a minimum, from
the summary is changed until it is flushed to disk.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>summary_path</code></em> :</span></p></td>
<td>a local file system path
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flush_timeout_millis</code></em> :</span></p></td>
<td>a flush interval, in milliseconds
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_backend_summary_load ()">
<a name="e-book-backend-summary-load"></a><h3>e_book_backend_summary_load ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_book_backend_summary_load         (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>);</pre>
<p>
Attempts to load <em class="parameter"><code>summary</code></em> from disk. The load is successful if
the file was located, it was in the correct format, and it was
not out of date.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the load succeeded, <code class="literal">FALSE</code> if it failed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_backend_summary_save ()">
<a name="e-book-backend-summary-save"></a><h3>e_book_backend_summary_save ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_book_backend_summary_save         (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>);</pre>
<p>
Attempts to save <em class="parameter"><code>summary</code></em> to disk.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the save succeeded, <code class="literal">FALSE</code> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_backend_summary_add_contact ()">
<a name="e-book-backend-summary-add-contact"></a><h3>e_book_backend_summary_add_contact ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                e_book_backend_summary_add_contact  (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code><a href="/home/mbarnes/local/stable/share/gtk-doc/html/libebook/EContact.html"><span class="type">EContact</span></a> *contact</code></em>);</pre>
<p>
Adds a summary of <em class="parameter"><code>contact</code></em> to <em class="parameter"><code>summary</code></em>. Does not check if
the contact already has a summary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
<td>an <a href="/home/mbarnes/local/stable/share/gtk-doc/html/libebook/EContact.html"><span class="type">EContact</span></a> to add
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_backend_summary_remove_contact ()">
<a name="e-book-backend-summary-remove-contact"></a><h3>e_book_backend_summary_remove_contact ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                e_book_backend_summary_remove_contact
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
<p>
Removes the summary of the contact identified by <em class="parameter"><code>id</code></em> from <em class="parameter"><code>summary</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>summary</code></em> :</span></p></td>
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>a unique contact ID string
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_backend_summary_check_contact ()">
<a name="e-book-backend-summary-check-contact"></a><h3>e_book_backend_summary_check_contact ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_book_backend_summary_check_contact
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
<p>
Checks if a summary of the contact identified by <em class="parameter"><code>id</code></em>
exists in <em class="parameter"><code>summary</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>summary</code></em> :</span></p></td>
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>a unique contact ID string
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the summary exists, <code class="literal">FALSE</code> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_backend_summary_touch ()">
<a name="e-book-backend-summary-touch"></a><h3>e_book_backend_summary_touch ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                e_book_backend_summary_touch        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>);</pre>
<p>
Indicates that <em class="parameter"><code>summary</code></em> has changed and should be flushed to disk.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_backend_summary_is_up_to_date ()">
<a name="e-book-backend-summary-is-up-to-date"></a><h3>e_book_backend_summary_is_up_to_date ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_book_backend_summary_is_up_to_date
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code><span class="type">time_t</span> t</code></em>);</pre>
<p>
Checks if <em class="parameter"><code>summary</code></em> is more recent than <em class="parameter"><code>t</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>summary</code></em> :</span></p></td>
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>t</code></em> :</span></p></td>
<td>the time to compare with
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the summary is up to date, <code class="literal">FALSE</code> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_backend_summary_is_summary_query ()">
<a name="e-book-backend-summary-is-summary-query"></a><h3>e_book_backend_summary_is_summary_query ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_book_backend_summary_is_summary_query
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>);</pre>
<p>
Checks if <em class="parameter"><code>query</code></em> can be satisfied by searching only the fields
stored by <em class="parameter"><code>summary</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>summary</code></em> :</span></p></td>
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
<td>an s-expression to check
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the query can be satisfied, <code class="literal">FALSE</code> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_backend_summary_search ()">
<a name="e-book-backend-summary-search"></a><h3>e_book_backend_summary_search ()</h3>
<pre class="programlisting"><span class="returnvalue">GPtrArray</span>*          e_book_backend_summary_search       (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>);</pre>
<p>
Searches <em class="parameter"><code>summary</code></em> for contacts matching <em class="parameter"><code>query</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>summary</code></em> :</span></p></td>
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
<td>an s-expression
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <span class="type">GPtrArray</span> of pointers to contact ID strings.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="e_book_backend_summary_get_summary_vcard ()">
<a name="e-book-backend-summary-get-summary-vcard"></a><h3>e_book_backend_summary_get_summary_vcard ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_book_backend_summary_get_summary_vcard
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
<p>
Constructs and returns a VCard from the contact summary specified
by <em class="parameter"><code>id</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>summary</code></em> :</span></p></td>
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>a unique contact ID
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new VCard, or <code class="literal">NULL</code> if the contact summary didn't exist.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>