/usr/share/gtk-doc/html/camel/CamelIMAPXSearch.html is in evolution-data-server-doc 3.22.7-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelIMAPXSearch: Camel Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="IMAP.html" title="IMAP Service">
<link rel="prev" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse">
<link rel="next" href="CamelIMAPXServer.html" title="CamelIMAPXServer">
<meta name="generator" content="GTK-Doc V1.25 (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="#CamelIMAPXSearch.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#CamelIMAPXSearch.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#CamelIMAPXSearch.properties" class="shortcut">Properties</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="IMAP.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="CamelIMAPXNamespaceResponse.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="CamelIMAPXServer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="CamelIMAPXSearch"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelIMAPXSearch.top_of_page"></a>CamelIMAPXSearch</span></h2>
<p>CamelIMAPXSearch</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="CamelIMAPXSearch.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="CamelFolderSearch.html" title="CamelFolderSearch"><span class="returnvalue">CamelFolderSearch</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXSearch.html#camel-imapx-search-new" title="camel_imapx_search_new ()">camel_imapx_search_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="returnvalue">CamelIMAPXStore</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXSearch.html#camel-imapx-search-ref-store" title="camel_imapx_search_ref_store ()">camel_imapx_search_ref_store</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="CamelIMAPXSearch.html#camel-imapx-search-set-store" title="camel_imapx_search_set_store ()">camel_imapx_search_set_store</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="CamelIMAPXSearch.html#camel-imapx-search-set-cancellable-and-error" title="camel_imapx_search_set_cancellable_and_error ()">camel_imapx_search_set_cancellable_and_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CamelIMAPXSearch.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a> *</td>
<td class="property_name"><a class="link" href="CamelIMAPXSearch.html#CamelIMAPXSearch--store" title="The “store” property">store</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CamelIMAPXSearch.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="CamelIMAPXSearch.html#CamelIMAPXSearch-struct" title="struct CamelIMAPXSearch">CamelIMAPXSearch</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CamelIMAPXSearch.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch">CamelFolderSearch</a>
<span class="lineart">╰──</span> CamelIMAPXSearch
</pre>
</div>
<div class="refsect1">
<a name="CamelIMAPXSearch.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="CamelIMAPXSearch.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="camel-imapx-search-new"></a><h3>camel_imapx_search_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="returnvalue">CamelFolderSearch</span></a> *
camel_imapx_search_new (<em class="parameter"><code><a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a> *imapx_store</code></em>);</pre>
<p>Returns a new <a class="link" href="CamelIMAPXSearch.html" title="CamelIMAPXSearch"><span class="type">CamelIMAPXSearch</span></a> instance.</p>
<div class="refsect3">
<a name="camel-imapx-search-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>imapx_store</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a> to which the search belongs</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-imapx-search-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="CamelIMAPXSearch.html" title="CamelIMAPXSearch"><span class="type">CamelIMAPXSearch</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-search-ref-store"></a><h3>camel_imapx_search_ref_store ()</h3>
<pre class="programlisting"><a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="returnvalue">CamelIMAPXStore</span></a> *
camel_imapx_search_ref_store (<em class="parameter"><code><a class="link" href="CamelIMAPXSearch.html" title="CamelIMAPXSearch"><span class="type">CamelIMAPXSearch</span></a> *search</code></em>);</pre>
<p>Returns a <a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a> to use for server-side searches,
or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> when the store is offline.</p>
<p>The returned <a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a> is referenced for thread-safety and
must be unreferenced with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="camel-imapx-search-ref-store.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>search</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXSearch.html" title="CamelIMAPXSearch"><span class="type">CamelIMAPXSearch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-imapx-search-ref-store.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-search-set-store"></a><h3>camel_imapx_search_set_store ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_search_set_store (<em class="parameter"><code><a class="link" href="CamelIMAPXSearch.html" title="CamelIMAPXSearch"><span class="type">CamelIMAPXSearch</span></a> *search</code></em>,
<em class="parameter"><code><a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a> *imapx_store</code></em>);</pre>
<p>Sets a <a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a> to use for server-side searches. Generally
this is set for the duration of a single search when online, and then
reset to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="camel-imapx-search-set-store.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>search</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXSearch.html" title="CamelIMAPXSearch"><span class="type">CamelIMAPXSearch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>imapx_server</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-search-set-cancellable-and-error"></a><h3>camel_imapx_search_set_cancellable_and_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_search_set_cancellable_and_error
(<em class="parameter"><code><a class="link" href="CamelIMAPXSearch.html" title="CamelIMAPXSearch"><span class="type">CamelIMAPXSearch</span></a> *search</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Sets <em class="parameter"><code>cancellable</code></em>
and <em class="parameter"><code>error</code></em>
to use for server-side searches. This way
the search can return accurate errors and be eventually cancelled by
a user.</p>
<p>Note: The caller is responsible to keep alive both <em class="parameter"><code>cancellable</code></em>
and <em class="parameter"><code>error</code></em>
for the whole run of the search and reset them both to NULL after
the search is finished.</p>
<div class="refsect3">
<a name="camel-imapx-search-set-cancellable-and-error.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>search</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXSearch.html" title="CamelIMAPXSearch"><span class="type">CamelIMAPXSearch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.16.html" title="Index of new symbols in 3.16">3.16</a></p>
</div>
</div>
<div class="refsect1">
<a name="CamelIMAPXSearch.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CamelIMAPXSearch-struct"></a><h3>struct CamelIMAPXSearch</h3>
<pre class="programlisting">struct CamelIMAPXSearch;</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
</div>
<div class="refsect1">
<a name="CamelIMAPXSearch.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="CamelIMAPXSearch--store"></a><h3>The <code class="literal">“store”</code> property</h3>
<pre class="programlisting"> “store” <a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a> *</pre>
<p>IMAPX Store for server-side searches.</p>
<p>Flags: Read / Write</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|