/usr/share/gtk-doc/html/evolution-util/evolution-util-e-source-util.html is in evolution-dev 3.28.1-2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-source-util: Evolution Utilities Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch13.html" title="ESource Support">
<link rel="prev" href="evolution-util-ESourceComboBox.html" title="ESourceComboBox">
<link rel="next" href="evolution-util-EClientCache.html" title="EClientCache">
<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-util-e-source-util.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="ch13.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-util-ESourceComboBox.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-util-EClientCache.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-util-e-source-util"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-util-e-source-util.top_of_page"></a>e-source-util</span></h2>
<p>e-source-util</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-util-e-source-util.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">
<span class="returnvalue">EActivity</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-util-e-source-util.html#e-source-util-remove" title="e_source_util_remove ()">e_source_util_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">EActivity</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-util-e-source-util.html#e-source-util-write" title="e_source_util_write ()">e_source_util_write</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">EActivity</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-util-e-source-util.html#e-source-util-remote-delete" title="e_source_util_remote_delete ()">e_source_util_remote_delete</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-util-e-source-util.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="evolution-util-e-source-util.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-source-util-remove"></a><h3>e_source_util_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">EActivity</span> *
e_source_util_remove (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
<em class="parameter"><code><span class="type">EAlertSink</span> *alert_sink</code></em>);</pre>
<div class="warning"><p><code class="literal">e_source_util_remove</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Requests the D-Bus service to delete the key files for <em class="parameter"><code>source</code></em>
and all of
its descendants and broadcast their removal to all clients. If an error
occurs, an <span class="type">EAlert</span> will be posted to <em class="parameter"><code>alert_sink</code></em>
.</p>
<p>This function does not block. The returned <span class="type">EActivity</span> can either be
ignored or passed to something that can display activity status to the
user, such as <a href="../html/evolution-shell-EShellBackend.html#e-shell-backend-add-activity"><code class="function">e_shell_backend_add_activity()</code></a>.</p>
<div class="refsect3">
<a name="e-source-util-remove.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>source</p></td>
<td class="parameter_description"><p>the <span class="type">ESource</span> to be removed</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alert_sink</p></td>
<td class="parameter_description"><p>an <span class="type">EAlertSink</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-util-remove.returns"></a><h4>Returns</h4>
<p> an <span class="type">EActivity</span> to track the operation</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-source-util-write"></a><h3>e_source_util_write ()</h3>
<pre class="programlisting"><span class="returnvalue">EActivity</span> *
e_source_util_write (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
<em class="parameter"><code><span class="type">EAlertSink</span> *alert_sink</code></em>);</pre>
<div class="warning"><p><code class="literal">e_source_util_write</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Submits the current contents of <em class="parameter"><code>source</code></em>
to the D-Bus service to be
written to disk and broadcast to other clients. If an error occurs,
an <span class="type">EAlert</span> will be posted to <em class="parameter"><code>alert_sink</code></em>
.</p>
<p>This function does not block. The returned <span class="type">EActivity</span> can either be
ignored or passed to something that can display activity status to the
user, such as <a href="../html/evolution-shell-EShellBackend.html#e-shell-backend-add-activity"><code class="function">e_shell_backend_add_activity()</code></a>.</p>
<div class="refsect3">
<a name="e-source-util-write.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>source</p></td>
<td class="parameter_description"><p>an <span class="type">ESource</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alert_sink</p></td>
<td class="parameter_description"><p>an <span class="type">EAlertSink</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-util-write.returns"></a><h4>Returns</h4>
<p> an <span class="type">EActivity</span> to track the operation</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-source-util-remote-delete"></a><h3>e_source_util_remote_delete ()</h3>
<pre class="programlisting"><span class="returnvalue">EActivity</span> *
e_source_util_remote_delete (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
<em class="parameter"><code><span class="type">EAlertSink</span> *alert_sink</code></em>);</pre>
<div class="warning"><p><code class="literal">e_source_util_remote_delete</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Deletes the resource represented by <em class="parameter"><code>source</code></em>
from a remote server.
The <em class="parameter"><code>source</code></em>
must be <span class="type">“remote-deletable”</span>. This will also delete
the key file for <em class="parameter"><code>source</code></em>
and broadcast its removal to all clients,
similar to <a class="link" href="evolution-util-e-source-util.html#e-source-util-remove" title="e_source_util_remove ()"><code class="function">e_source_util_remove()</code></a>. If an error occurs, an <span class="type">EAlert</span>
will be posted to <em class="parameter"><code>alert_sink</code></em>
.</p>
<p>This function does not block. The returned <span class="type">EActivity</span> can either be
ignored or passed to something that can display activity status to the
user, such as <a href="../html/evolution-shell-EShellBackend.html#e-shell-backend-add-activity"><code class="function">e_shell_backend_add_activity()</code></a>.</p>
<div class="refsect3">
<a name="e-source-util-remote-delete.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>source</p></td>
<td class="parameter_description"><p>an <span class="type">ESource</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alert_sink</p></td>
<td class="parameter_description"><p>an <span class="type">EAlertSink</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-util-remote-delete.returns"></a><h4>Returns</h4>
<p> an <span class="type">EActivity</span> to track the operation</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="evolution-util-e-source-util.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|