← Back to branch summary

~ubuntu-branches/ubuntu/precise/evolution-data-server/precise-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): Mathieu Trudel-Lapierre
  • Date: 2011-07-27 11:45:30 UTC
  • mfrom: (1.1.90 upstream)
  • Revision ID: james.westby@ubuntu.com-20110727114530-v4ntbu728os68b0b
Tags: 3.1.4-0ubuntu1
* New upstream version.
* debian/patches/999git_EDS_3_1_3_1_to_f94a069.patch: drop, included in
  the upstream 3.1.4 tarball.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/addressbook/libedata-book/html/EBookBackendSummary.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>EBookBackendSummary</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Address Book Backend (libedata-book)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Address Book Backend (libedata-book)">
9
9
<link rel="prev" href="libedata-book-EBookBackendSqliteDB.html" title="EBookBackendSqliteDB">
10
10
<link rel="next" href="EBookBackendSync.html" title="EBookBackendSync">
11
 
<meta name="generator" content="GTK-Doc V1.17.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
40
40
<div class="refsynopsisdiv">
41
41
<a name="EBookBackendSummary.synopsis"></a><h2>Synopsis</h2>
42
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>,
 
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
44
                                                         <em class="parameter"><code><span class="type">gint</span> flush_timeout_millis</code></em>);
45
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
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
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><a href="/home/chen/opt-unstable/share/gtk-doc/html/libebook/EContact.html"><span class="type">EContact</span></a> *contact</code></em>);
 
48
                                                         <em class="parameter"><code><a href="/home/mbarnes/local/unstable/share/gtk-doc/html/libebook/EContact.html"><span class="type">EContact</span></a> *contact</code></em>);
49
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
50
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
51
51
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
59
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
60
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
61
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>,
 
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
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>
 
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
65
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
66
66
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
67
67
</pre>
89
89
<hr>
90
90
<div class="refsect2">
91
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>,
 
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
93
                                                         <em class="parameter"><code><span class="type">gint</span> flush_timeout_millis</code></em>);</pre>
94
94
<p>
95
95
Creates an <a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> object without loading it
167
167
<div class="refsect2">
168
168
<a name="e-book-backend-summary-add-contact"></a><h3>e_book_backend_summary_add_contact ()</h3>
169
169
<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>,
170
 
                                                         <em class="parameter"><code><a href="/home/chen/opt-unstable/share/gtk-doc/html/libebook/EContact.html"><span class="type">EContact</span></a> *contact</code></em>);</pre>
 
170
                                                         <em class="parameter"><code><a href="/home/mbarnes/local/unstable/share/gtk-doc/html/libebook/EContact.html"><span class="type">EContact</span></a> *contact</code></em>);</pre>
171
171
<p>
172
172
Adds a summary of <em class="parameter"><code>contact</code></em> to <em class="parameter"><code>summary</code></em>. Does not check if
173
173
the contact already has a summary.
182
182
</tr>
183
183
<tr>
184
184
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
185
 
<td>an <a href="/home/chen/opt-unstable/share/gtk-doc/html/libebook/EContact.html"><span class="type">EContact</span></a> to add</td>
 
185
<td>an <a href="/home/mbarnes/local/unstable/share/gtk-doc/html/libebook/EContact.html"><span class="type">EContact</span></a> to add</td>
186
186
</tr>
187
187
</tbody>
188
188
</table></div>
319
319
<hr>
320
320
<div class="refsect2">
321
321
<a name="e-book-backend-summary-search"></a><h3>e_book_backend_summary_search ()</h3>
322
 
<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>,
 
322
<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>,
323
323
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>);</pre>
324
324
<p>
325
325
Searches <em class="parameter"><code>summary</code></em> for contacts matching <em class="parameter"><code>query</code></em>.
346
346
<hr>
347
347
<div class="refsect2">
348
348
<a name="e-book-backend-summary-get-summary-vcard"></a><h3>e_book_backend_summary_get_summary_vcard ()</h3>
349
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_book_backend_summary_get_summary_vcard
 
349
<pre class="programlisting"><span class="returnvalue">gchar</span> *               e_book_backend_summary_get_summary_vcard
350
350
                                                        (<em class="parameter"><code><a class="link" href="EBookBackendSummary.html" title="EBookBackendSummary"><span class="type">EBookBackendSummary</span></a> *summary</code></em>,
351
351
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
352
352
<p>
367
367
</tr>
368
368
<tr>
369
369
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
370
 
<td>A new VCard, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if the contact summary didn't exist.</td>
 
370
<td>A new VCard, or <code class="literal">NULL</code> if the contact summary didn't exist.</td>
371
371
</tr>
372
372
</tbody>
373
373
</table></div>
376
376
</div>
377
377
<div class="footer">
378
378
<hr>
379
 
          Generated by GTK-Doc V1.17.1</div>
 
379
          Generated by GTK-Doc V1.17</div>
380
380
</body>
381
381
</html>
 
 
b'\\ No newline at end of file'