← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libedata-book/html/EBookBackendSummary.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/addressbook/libedata-book/html/EBookBackendSummary.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>EBookBackendSummary</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Address Book Backend (libedata-book)">
 
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Address Book Backend (libedata-book)">
 
9
<link rel="prev" href="EBookBackendSExp.html" title="EBookBackendSExp">
 
10
<link rel="next" href="EBookBackendSync.html" title="EBookBackendSync">
 
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="EBookBackendSExp.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Evolution-Data-Server Manual: Address Book Backend (libedata-book)</th>
 
21
<td><a accesskey="n" href="EBookBackendSync.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#EBookBackendSummary.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#EBookBackendSummary.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#EBookBackendSummary.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
</td></tr>
 
30
</table>
 
31
<div class="refentry" title="EBookBackendSummary">
 
32
<a name="EBookBackendSummary"></a><div class="titlepage"></div>
 
33
<div class="refnamediv"><table width="100%"><tr>
 
34
<td valign="top">
 
35
<h2><span class="refentrytitle"><a name="EBookBackendSummary.top_of_page"></a>EBookBackendSummary</span></h2>
 
36
<p>EBookBackendSummary</p>
 
37
</td>
 
38
<td valign="top" align="right"></td>
 
39
</tr></table></div>
 
40
<div class="refsynopsisdiv" title="Synopsis">
 
41
<a name="EBookBackendSummary.synopsis"></a><h2>Synopsis</h2>
 
42
<pre class="synopsis">struct              <a class="link" href="EBookBackendSummary.html#EBookBackendSummary-struct" title="struct EBookBackendSummary">EBookBackendSummary</a>;
 
43
<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>,
 
44
                                                         <em class="parameter"><code><span class="type">gint</span> flush_timeout_millis</code></em>);
 
45
<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>);
 
46
<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>);
 
47
<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>,
 
48
                                                         <em class="parameter"><code><span class="type">EContact</span> *contact</code></em>);
 
49
<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>
 
50
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
 
51
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
 
52
<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>
 
53
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
 
54
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
 
55
<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>);
 
56
<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>
 
57
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
 
58
                                                         <em class="parameter"><code><span class="type">time_t</span> t</code></em>);
 
59
<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>
 
60
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
 
61
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>);
 
62
<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>,
 
63
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>);
 
64
<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>
 
65
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
 
66
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
 
67
</pre>
 
68
</div>
 
69
<div class="refsect1" title="Object Hierarchy">
 
70
<a name="EBookBackendSummary.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
71
<pre class="synopsis">
 
72
  GObject
 
73
   +----EBookBackendSummary
 
74
</pre>
 
75
</div>
 
76
<div class="refsect1" title="Description">
 
77
<a name="EBookBackendSummary.description"></a><h2>Description</h2>
 
78
<p>
 
79
</p>
 
80
</div>
 
81
<div class="refsect1" title="Details">
 
82
<a name="EBookBackendSummary.details"></a><h2>Details</h2>
 
83
<div class="refsect2" title="struct EBookBackendSummary">
 
84
<a name="EBookBackendSummary-struct"></a><h3>struct EBookBackendSummary</h3>
 
85
<pre class="programlisting">struct EBookBackendSummary;</pre>
 
86
<p>
 
87
</p>
 
88
</div>
 
89
<hr>
 
90
<div class="refsect2" title="e_book_backend_summary_new ()">
 
91
<a name="e-book-backend-summary-new"></a><h3>e_book_backend_summary_new ()</h3>
 
92
<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>,
 
93
                                                         <em class="parameter"><code><span class="type">gint</span> flush_timeout_millis</code></em>);</pre>
 
94
<p>
 
95
Creates an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> object without loading it
 
96
or otherwise affecting the file. <em class="parameter"><code>flush_timeout_millis</code></em>
 
97
specifies how much time should elapse, at a minimum, from
 
98
the summary is changed until it is flushed to disk.
 
99
</p>
 
100
<div class="variablelist"><table border="0">
 
101
<col align="left" valign="top">
 
102
<tbody>
 
103
<tr>
 
104
<td><p><span class="term"><em class="parameter"><code>summary_path</code></em> :</span></p></td>
 
105
<td>a local file system path
 
106
</td>
 
107
</tr>
 
108
<tr>
 
109
<td><p><span class="term"><em class="parameter"><code>flush_timeout_millis</code></em> :</span></p></td>
 
110
<td>a flush interval, in milliseconds
 
111
</td>
 
112
</tr>
 
113
<tr>
 
114
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
115
<td> A new <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>.
 
116
</td>
 
117
</tr>
 
118
</tbody>
 
119
</table></div>
 
120
</div>
 
121
<hr>
 
122
<div class="refsect2" title="e_book_backend_summary_load ()">
 
123
<a name="e-book-backend-summary-load"></a><h3>e_book_backend_summary_load ()</h3>
 
124
<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>
 
125
<p>
 
126
Attempts to load <em class="parameter"><code>summary</code></em> from disk. The load is successful if
 
127
the file was located, it was in the correct format, and it was
 
128
not out of date.
 
129
</p>
 
130
<div class="variablelist"><table border="0">
 
131
<col align="left" valign="top">
 
132
<tbody>
 
133
<tr>
 
134
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
 
135
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
136
</td>
 
137
</tr>
 
138
<tr>
 
139
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
140
<td> <code class="literal">TRUE</code> if the load succeeded, <code class="literal">FALSE</code> if it failed.
 
141
</td>
 
142
</tr>
 
143
</tbody>
 
144
</table></div>
 
145
</div>
 
146
<hr>
 
147
<div class="refsect2" title="e_book_backend_summary_save ()">
 
148
<a name="e-book-backend-summary-save"></a><h3>e_book_backend_summary_save ()</h3>
 
149
<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>
 
150
<p>
 
151
Attempts to save <em class="parameter"><code>summary</code></em> to disk.
 
152
</p>
 
153
<div class="variablelist"><table border="0">
 
154
<col align="left" valign="top">
 
155
<tbody>
 
156
<tr>
 
157
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
 
158
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
159
</td>
 
160
</tr>
 
161
<tr>
 
162
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
163
<td> <code class="literal">TRUE</code> if the save succeeded, <code class="literal">FALSE</code> otherwise.
 
164
</td>
 
165
</tr>
 
166
</tbody>
 
167
</table></div>
 
168
</div>
 
169
<hr>
 
170
<div class="refsect2" title="e_book_backend_summary_add_contact ()">
 
171
<a name="e-book-backend-summary-add-contact"></a><h3>e_book_backend_summary_add_contact ()</h3>
 
172
<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>,
 
173
                                                         <em class="parameter"><code><span class="type">EContact</span> *contact</code></em>);</pre>
 
174
<p>
 
175
Adds a summary of <em class="parameter"><code>contact</code></em> to <em class="parameter"><code>summary</code></em>. Does not check if
 
176
the contact already has a summary.
 
177
</p>
 
178
<div class="variablelist"><table border="0">
 
179
<col align="left" valign="top">
 
180
<tbody>
 
181
<tr>
 
182
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
 
183
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
184
</td>
 
185
</tr>
 
186
<tr>
 
187
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
 
188
<td>an <span class="type">EContact</span> to add
 
189
</td>
 
190
</tr>
 
191
</tbody>
 
192
</table></div>
 
193
</div>
 
194
<hr>
 
195
<div class="refsect2" title="e_book_backend_summary_remove_contact ()">
 
196
<a name="e-book-backend-summary-remove-contact"></a><h3>e_book_backend_summary_remove_contact ()</h3>
 
197
<pre class="programlisting"><span class="returnvalue">void</span>                e_book_backend_summary_remove_contact
 
198
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
 
199
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
 
200
<p>
 
201
Removes the summary of the contact identified by <em class="parameter"><code>id</code></em> from <em class="parameter"><code>summary</code></em>.
 
202
</p>
 
203
<div class="variablelist"><table border="0">
 
204
<col align="left" valign="top">
 
205
<tbody>
 
206
<tr>
 
207
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
 
208
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
209
</td>
 
210
</tr>
 
211
<tr>
 
212
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 
213
<td>a unique contact ID string
 
214
</td>
 
215
</tr>
 
216
</tbody>
 
217
</table></div>
 
218
</div>
 
219
<hr>
 
220
<div class="refsect2" title="e_book_backend_summary_check_contact ()">
 
221
<a name="e-book-backend-summary-check-contact"></a><h3>e_book_backend_summary_check_contact ()</h3>
 
222
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_book_backend_summary_check_contact
 
223
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
 
224
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
 
225
<p>
 
226
Checks if a summary of the contact identified by <em class="parameter"><code>id</code></em>
 
227
exists in <em class="parameter"><code>summary</code></em>.
 
228
</p>
 
229
<div class="variablelist"><table border="0">
 
230
<col align="left" valign="top">
 
231
<tbody>
 
232
<tr>
 
233
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
 
234
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
235
</td>
 
236
</tr>
 
237
<tr>
 
238
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 
239
<td>a unique contact ID string
 
240
</td>
 
241
</tr>
 
242
<tr>
 
243
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
244
<td> <code class="literal">TRUE</code> if the summary exists, <code class="literal">FALSE</code> otherwise.
 
245
</td>
 
246
</tr>
 
247
</tbody>
 
248
</table></div>
 
249
</div>
 
250
<hr>
 
251
<div class="refsect2" title="e_book_backend_summary_touch ()">
 
252
<a name="e-book-backend-summary-touch"></a><h3>e_book_backend_summary_touch ()</h3>
 
253
<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>
 
254
<p>
 
255
Indicates that <em class="parameter"><code>summary</code></em> has changed and should be flushed to disk.
 
256
</p>
 
257
<div class="variablelist"><table border="0">
 
258
<col align="left" valign="top">
 
259
<tbody><tr>
 
260
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
 
261
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
262
</td>
 
263
</tr></tbody>
 
264
</table></div>
 
265
</div>
 
266
<hr>
 
267
<div class="refsect2" title="e_book_backend_summary_is_up_to_date ()">
 
268
<a name="e-book-backend-summary-is-up-to-date"></a><h3>e_book_backend_summary_is_up_to_date ()</h3>
 
269
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_book_backend_summary_is_up_to_date
 
270
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
 
271
                                                         <em class="parameter"><code><span class="type">time_t</span> t</code></em>);</pre>
 
272
<p>
 
273
Checks if <em class="parameter"><code>summary</code></em> is more recent than <em class="parameter"><code>t</code></em>.
 
274
</p>
 
275
<div class="variablelist"><table border="0">
 
276
<col align="left" valign="top">
 
277
<tbody>
 
278
<tr>
 
279
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
 
280
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
281
</td>
 
282
</tr>
 
283
<tr>
 
284
<td><p><span class="term"><em class="parameter"><code>t</code></em> :</span></p></td>
 
285
<td>the time to compare with
 
286
</td>
 
287
</tr>
 
288
<tr>
 
289
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
290
<td> <code class="literal">TRUE</code> if the summary is up to date, <code class="literal">FALSE</code> otherwise.
 
291
</td>
 
292
</tr>
 
293
</tbody>
 
294
</table></div>
 
295
</div>
 
296
<hr>
 
297
<div class="refsect2" title="e_book_backend_summary_is_summary_query ()">
 
298
<a name="e-book-backend-summary-is-summary-query"></a><h3>e_book_backend_summary_is_summary_query ()</h3>
 
299
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_book_backend_summary_is_summary_query
 
300
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
 
301
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>);</pre>
 
302
<p>
 
303
Checks if <em class="parameter"><code>query</code></em> can be satisfied by searching only the fields
 
304
stored by <em class="parameter"><code>summary</code></em>.
 
305
</p>
 
306
<div class="variablelist"><table border="0">
 
307
<col align="left" valign="top">
 
308
<tbody>
 
309
<tr>
 
310
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
 
311
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
312
</td>
 
313
</tr>
 
314
<tr>
 
315
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
 
316
<td>an s-expression to check
 
317
</td>
 
318
</tr>
 
319
<tr>
 
320
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
321
<td> <code class="literal">TRUE</code> if the query can be satisfied, <code class="literal">FALSE</code> otherwise.
 
322
</td>
 
323
</tr>
 
324
</tbody>
 
325
</table></div>
 
326
</div>
 
327
<hr>
 
328
<div class="refsect2" title="e_book_backend_summary_search ()">
 
329
<a name="e-book-backend-summary-search"></a><h3>e_book_backend_summary_search ()</h3>
 
330
<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>,
 
331
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>);</pre>
 
332
<p>
 
333
Searches <em class="parameter"><code>summary</code></em> for contacts matching <em class="parameter"><code>query</code></em>.
 
334
</p>
 
335
<div class="variablelist"><table border="0">
 
336
<col align="left" valign="top">
 
337
<tbody>
 
338
<tr>
 
339
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
 
340
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
341
</td>
 
342
</tr>
 
343
<tr>
 
344
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
 
345
<td>an s-expression
 
346
</td>
 
347
</tr>
 
348
<tr>
 
349
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
350
<td> A <span class="type">GPtrArray</span> of pointers to contact ID strings.
 
351
</td>
 
352
</tr>
 
353
</tbody>
 
354
</table></div>
 
355
</div>
 
356
<hr>
 
357
<div class="refsect2" title="e_book_backend_summary_get_summary_vcard ()">
 
358
<a name="e-book-backend-summary-get-summary-vcard"></a><h3>e_book_backend_summary_get_summary_vcard ()</h3>
 
359
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_book_backend_summary_get_summary_vcard
 
360
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
 
361
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
 
362
<p>
 
363
Constructs and returns a VCard from the contact summary specified
 
364
by <em class="parameter"><code>id</code></em>.
 
365
</p>
 
366
<div class="variablelist"><table border="0">
 
367
<col align="left" valign="top">
 
368
<tbody>
 
369
<tr>
 
370
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
 
371
<td>an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a>
 
372
</td>
 
373
</tr>
 
374
<tr>
 
375
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 
376
<td>a unique contact ID
 
377
</td>
 
378
</tr>
 
379
<tr>
 
380
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
381
<td> A new VCard, or <code class="literal">NULL</code> if the contact summary didn't exist.
 
382
</td>
 
383
</tr>
 
384
</tbody>
 
385
</table></div>
 
386
</div>
 
387
</div>
 
388
</div>
 
389
<div class="footer">
 
390
<hr>
 
391
          Generated by GTK-Doc V1.14</div>
 
392
</body>
 
393
</html>
 
 
b'\\ No newline at end of file'