/usr/share/gtk-doc/html/evolution-data-server/evolution-data-server-EBookBackendSExp.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EBookBackendSExp: 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="ch08.html" title="Addressbook Backend Classes">
<link rel="prev" href="evolution-data-server-EBookBackendFactory.html" title="EBookBackendFactory">
<link rel="next" href="evolution-data-server-EBookCache.html" title="EBookCache">
<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-EBookBackendSExp.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="ch08.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-data-server-EBookBackendFactory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-data-server-EBookCache.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-EBookBackendSExp"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-data-server-EBookBackendSExp.top_of_page"></a>EBookBackendSExp</span></h2>
<p>EBookBackendSExp — A utility for comparing <span class="type">EContact</span> objects or vcards with search expressions.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-data-server-EBookBackendSExp.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-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp"><span class="returnvalue">EBookBackendSExp</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-EBookBackendSExp.html#e-book-backend-sexp-new" title="e_book_backend_sexp_new ()">e_book_backend_sexp_new</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-EBookBackendSExp.html#e-book-backend-sexp-text" title="e_book_backend_sexp_text ()">e_book_backend_sexp_text</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-EBookBackendSExp.html#e-book-backend-sexp-match-vcard" title="e_book_backend_sexp_match_vcard ()">e_book_backend_sexp_match_vcard</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-EBookBackendSExp.html#e-book-backend-sexp-match-contact" title="e_book_backend_sexp_match_contact ()">e_book_backend_sexp_match_contact</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-EBookBackendSExp.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-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp">EBookBackendSExp</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="evolution-data-server-EBookBackendSExp.html#EBookBackendSExpClass" title="struct EBookBackendSExpClass">EBookBackendSExpClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-EBookBackendSExp.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libedata-book/libedata-book.h>
</pre>
</div>
<div class="refsect1">
<a name="evolution-data-server-EBookBackendSExp.description"></a><h2>Description</h2>
<p>This API is an all purpose utility for comparing <span class="type">EContact</span> objects with search expressions generated by <span class="type">EBookQuery</span>.</p>
</div>
<div class="refsect1">
<a name="evolution-data-server-EBookBackendSExp.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-book-backend-sexp-new"></a><h3>e_book_backend_sexp_new ()</h3>
<pre class="programlisting"><a class="link" href="evolution-data-server-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp"><span class="returnvalue">EBookBackendSExp</span></a> *
e_book_backend_sexp_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
<p>Creates a new <a class="link" href="evolution-data-server-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp"><span class="type">EBookBackendSExp</span></a> from <em class="parameter"><code>text</code></em>
.</p>
<div class="refsect3">
<a name="e-book-backend-sexp-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>text</p></td>
<td class="parameter_description"><p>an s-expression to parse</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-book-backend-sexp-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="evolution-data-server-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp"><span class="type">EBookBackendSExp</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-book-backend-sexp-text"></a><h3>e_book_backend_sexp_text ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_book_backend_sexp_text (<em class="parameter"><code><a class="link" href="evolution-data-server-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp"><span class="type">EBookBackendSExp</span></a> *sexp</code></em>);</pre>
<p>Retrieve the text expression for the given <a class="link" href="evolution-data-server-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp"><span class="type">EBookBackendSExp</span></a> object.</p>
<div class="refsect3">
<a name="e-book-backend-sexp-text.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>sexp</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp"><span class="type">EBookBackendSExp</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-book-backend-sexp-text.returns"></a><h4>Returns</h4>
<p> the text expression</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-8.html#api-index-3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-book-backend-sexp-match-vcard"></a><h3>e_book_backend_sexp_match_vcard ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_backend_sexp_match_vcard (<em class="parameter"><code><a class="link" href="evolution-data-server-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp"><span class="type">EBookBackendSExp</span></a> *sexp</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *vcard</code></em>);</pre>
<p>Checks if <em class="parameter"><code>vcard</code></em>
matches <em class="parameter"><code>sexp</code></em>
.</p>
<div class="refsect3">
<a name="e-book-backend-sexp-match-vcard.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>sexp</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp"><span class="type">EBookBackendSExp</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>vcard</p></td>
<td class="parameter_description"><p>a vCard string</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-book-backend-sexp-match-vcard.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the vCard matches, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-book-backend-sexp-match-contact"></a><h3>e_book_backend_sexp_match_contact ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_backend_sexp_match_contact (<em class="parameter"><code><a class="link" href="evolution-data-server-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp"><span class="type">EBookBackendSExp</span></a> *sexp</code></em>,
<em class="parameter"><code><span class="type">EContact</span> *contact</code></em>);</pre>
<p>Checks if <em class="parameter"><code>contact</code></em>
matches <em class="parameter"><code>sexp</code></em>
.</p>
<div class="refsect3">
<a name="e-book-backend-sexp-match-contact.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>sexp</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-EBookBackendSExp.html#EBookBackendSExp" title="struct EBookBackendSExp"><span class="type">EBookBackendSExp</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>contact</p></td>
<td class="parameter_description"><p>an <span class="type">EContact</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-book-backend-sexp-match-contact.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the contact matches, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="evolution-data-server-EBookBackendSExp.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EBookBackendSExp"></a><h3>struct EBookBackendSExp</h3>
<pre class="programlisting">struct EBookBackendSExp {
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EBookBackendSExpClass"></a><h3>struct EBookBackendSExpClass</h3>
<pre class="programlisting">struct EBookBackendSExpClass {
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|