/usr/share/gtk-doc/html/evolution-data-server/evolution-data-server-ESourceAutoconfig.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ESourceAutoconfig: 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="ch02.html" title="Data Source Extensions">
<link rel="prev" href="ch02.html" title="Data Source Extensions">
<link rel="next" href="evolution-data-server-ESourceExtension.html" title="ESourceExtension">
<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-ESourceAutoconfig.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-data-server-ESourceExtension.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-ESourceAutoconfig"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-data-server-ESourceAutoconfig.top_of_page"></a>ESourceAutoconfig</span></h2>
<p>ESourceAutoconfig — <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> extension for autoconfig settings</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAutoconfig.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">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-ESourceAutoconfig.html#e-source-autoconfig-get-revision" title="e_source_autoconfig_get_revision ()">e_source_autoconfig_get_revision</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<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-ESourceAutoconfig.html#e-source-autoconfig-dup-revision" title="e_source_autoconfig_dup_revision ()">e_source_autoconfig_dup_revision</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="evolution-data-server-ESourceAutoconfig.html#e-source-autoconfig-set-revision" title="e_source_autoconfig_set_revision ()">e_source_autoconfig_set_revision</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAutoconfig.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="evolution-data-server-ESourceAutoconfig.html#E-SOURCE-EXTENSION-AUTOCONFIG:CAPS" title="E_SOURCE_EXTENSION_AUTOCONFIG">E_SOURCE_EXTENSION_AUTOCONFIG</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="evolution-data-server-ESourceAutoconfig.html#ESourceAutoconfig" title="struct ESourceAutoconfig">ESourceAutoconfig</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAutoconfig.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libedataserver/libedataserver.h>
</pre>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAutoconfig.description"></a><h2>Description</h2>
<p>The <a class="link" href="evolution-data-server-ESourceAutoconfig.html#ESourceAutoconfig" title="struct ESourceAutoconfig"><span class="type">ESourceAutoconfig</span></a> extension keeps a mapping between user-specific
sources and system-wide ones.</p>
<p>Access the extension as follows:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc ppc">#include <libedataserver/libedataserver.h></span>
ESourceAutoconfig <span class="gtkdoc opt">*</span>extension<span class="gtkdoc opt">;</span>
extension <span class="gtkdoc opt">=</span> <span class="function"><a href="../html/evolution-data-server-ESource.html#e-source-get-extension">e_source_get_extension</a></span> <span class="gtkdoc opt">(</span>source<span class="gtkdoc opt">,</span> E_SOURCE_EXTENSION_AUTOCONFIG<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAutoconfig.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-source-autoconfig-get-revision"></a><h3>e_source_autoconfig_get_revision ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_source_autoconfig_get_revision (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceAutoconfig.html#ESourceAutoconfig" title="struct ESourceAutoconfig"><span class="type">ESourceAutoconfig</span></a> *extension</code></em>);</pre>
<p>Returns the revision of a data source. This maps a particular version of a
system-wide source to a user-specific source.</p>
<p>If doesn't match, the system-wide source will be copied to the user-specific
evolution config directory, preserving the already present fields that are
not defined by the system-wide source.</p>
<p>If it matches, no copying is done.</p>
<div class="refsect3">
<a name="e-source-autoconfig-get-revision.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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceAutoconfig.html#ESourceAutoconfig" title="struct ESourceAutoconfig"><span class="type">ESourceAutoconfig</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-autoconfig-get-revision.returns"></a><h4>Returns</h4>
<p> revision of the data source</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-autoconfig-dup-revision"></a><h3>e_source_autoconfig_dup_revision ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_source_autoconfig_dup_revision (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceAutoconfig.html#ESourceAutoconfig" title="struct ESourceAutoconfig"><span class="type">ESourceAutoconfig</span></a> *extension</code></em>);</pre>
<p>Thread-safe variation of <a class="link" href="evolution-data-server-ESourceAutoconfig.html#e-source-autoconfig-get-revision" title="e_source_autoconfig_get_revision ()"><code class="function">e_source_autoconfig_get_revision()</code></a>.
Use this function when accessing <em class="parameter"><code>extension</code></em>
from multiple threads.</p>
<p>The returned string should be freed with <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.</p>
<div class="refsect3">
<a name="e-source-autoconfig-dup-revision.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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceAutoconfig.html#ESourceAutoconfig" title="struct ESourceAutoconfig"><span class="type">ESourceAutoconfig</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-source-autoconfig-dup-revision.returns"></a><h4>Returns</h4>
<p>a newly-allocated copy of <span class="type">“revision”</span>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-autoconfig-set-revision"></a><h3>e_source_autoconfig_set_revision ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_autoconfig_set_revision (<em class="parameter"><code><a class="link" href="evolution-data-server-ESourceAutoconfig.html#ESourceAutoconfig" title="struct ESourceAutoconfig"><span class="type">ESourceAutoconfig</span></a> *extension</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *revision</code></em>);</pre>
<p>Sets the revision used to map a particular version of a system-wide source
to a user-specific source.</p>
<p>If doesn't match, the system-wide source will be copied to the user-specific
evolution config directory, preserving the already present fields that are
not defined by the system-wide source.</p>
<p>If it matches, no copying is done.</p>
<p>The internal copy of <em class="parameter"><code>revision</code></em>
is automatically stripped of leading and
trailing whitespace.</p>
<div class="refsect3">
<a name="e-source-autoconfig-set-revision.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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESourceAutoconfig.html#ESourceAutoconfig" title="struct ESourceAutoconfig"><span class="type">ESourceAutoconfig</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>revision</p></td>
<td class="parameter_description"><p>a revision</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
</div>
<div class="refsect1">
<a name="evolution-data-server-ESourceAutoconfig.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="E-SOURCE-EXTENSION-AUTOCONFIG:CAPS"></a><h3>E_SOURCE_EXTENSION_AUTOCONFIG</h3>
<pre class="programlisting">#define E_SOURCE_EXTENSION_AUTOCONFIG "Autoconfig"
</pre>
<p>Pass this extension name to <a class="link" href="evolution-data-server-ESource.html#e-source-get-extension" title="e_source_get_extension ()"><code class="function">e_source_get_extension()</code></a> to access
<a class="link" href="evolution-data-server-ESourceAutoconfig.html#ESourceAutoconfig" title="struct ESourceAutoconfig"><span class="type">ESourceAutoconfig</span></a>. This is also used as a group name in key files.</p>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceAutoconfig"></a><h3>struct ESourceAutoconfig</h3>
<pre class="programlisting">struct ESourceAutoconfig {
};
</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-24.html#api-index-3.24">3.24</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|