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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelLocalSettings</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Services.html" title="Services">
<link rel="prev" href="CamelStoreSettings.html" title="CamelStoreSettings">
<link rel="next" href="CamelOfflineSettings.html" title="CamelOfflineSettings">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="CamelStoreSettings.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Services.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="CamelOfflineSettings.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-CamelLocalSettings.synopsis" class="shortcut">Top</a>
|
<a href="#camel-CamelLocalSettings.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="camel-CamelLocalSettings"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelLocalSettings.top_of_page"></a>CamelLocalSettings</span></h2>
<p>CamelLocalSettings</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="camel-CamelLocalSettings.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="camel-CamelLocalSettings.html#CamelLocalSettings" title="struct CamelLocalSettings">CamelLocalSettings</a>;
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="camel-CamelLocalSettings.html#camel-local-settings-get-path" title="camel_local_settings_get_path ()">camel_local_settings_get_path</a> (<em class="parameter"><code><a class="link" href="camel-CamelLocalSettings.html#CamelLocalSettings" title="struct CamelLocalSettings"><span class="type">CamelLocalSettings</span></a> *settings</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="camel-CamelLocalSettings.html#camel-local-settings-dup-path" title="camel_local_settings_dup_path ()">camel_local_settings_dup_path</a> (<em class="parameter"><code><a class="link" href="camel-CamelLocalSettings.html#CamelLocalSettings" title="struct CamelLocalSettings"><span class="type">CamelLocalSettings</span></a> *settings</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-CamelLocalSettings.html#camel-local-settings-set-path" title="camel_local_settings_set_path ()">camel_local_settings_set_path</a> (<em class="parameter"><code><a class="link" href="camel-CamelLocalSettings.html#CamelLocalSettings" title="struct CamelLocalSettings"><span class="type">CamelLocalSettings</span></a> *settings</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="camel-CamelLocalSettings.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="camel-CamelLocalSettings.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelLocalSettings"></a><h3>struct CamelLocalSettings</h3>
<pre class="programlisting">struct CamelLocalSettings {
CamelStoreSettings parent;
CamelLocalSettingsPrivate *priv;
};
</pre>
<p>
Contains only private data that should be read and manipulated using the
functions below.
</p>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-local-settings-get-path"></a><h3>camel_local_settings_get_path ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * camel_local_settings_get_path (<em class="parameter"><code><a class="link" href="camel-CamelLocalSettings.html#CamelLocalSettings" title="struct CamelLocalSettings"><span class="type">CamelLocalSettings</span></a> *settings</code></em>);</pre>
<p>
Returns the file path to the root of the local mail store.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelLocalSettings.html#CamelLocalSettings" title="struct CamelLocalSettings"><span class="type">CamelLocalSettings</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the file path to the local store</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-local-settings-dup-path"></a><h3>camel_local_settings_dup_path ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * camel_local_settings_dup_path (<em class="parameter"><code><a class="link" href="camel-CamelLocalSettings.html#CamelLocalSettings" title="struct CamelLocalSettings"><span class="type">CamelLocalSettings</span></a> *settings</code></em>);</pre>
<p>
Thread-safe variation of <a class="link" href="camel-CamelLocalSettings.html#camel-local-settings-get-path" title="camel_local_settings_get_path ()"><code class="function">camel_local_settings_get_path()</code></a>.
Use this function when accessing <em class="parameter"><code>settings</code></em> from a worker thread.
</p>
<p>
The returned string should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelLocalSettings.html#CamelLocalSettings" title="struct CamelLocalSettings"><span class="type">CamelLocalSettings</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-allocated copy of <span class="type">"path"</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-local-settings-set-path"></a><h3>camel_local_settings_set_path ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_local_settings_set_path (<em class="parameter"><code><a class="link" href="camel-CamelLocalSettings.html#CamelLocalSettings" title="struct CamelLocalSettings"><span class="type">CamelLocalSettings</span></a> *settings</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre>
<p>
Sets the file path to the root of the local mail store. Any
trailing directory separator characters will be stripped off
of the <span class="type">"path"</span> property.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelLocalSettings.html#CamelLocalSettings" title="struct CamelLocalSettings"><span class="type">CamelLocalSettings</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>the file path to the local store</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
