← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-updates

« back to all changes in this revision

Viewing changes to docs/reference/libebackend/xml/e-file-cache.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libebackend/xml/e-file-cache.xml
1
1
<?xml version="1.0"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="EFileCache">
 
4
<refentry id="libebackend-e-file-cache">
5
5
<refmeta>
6
 
<refentrytitle role="top_of_page" id="EFileCache.top_of_page">EFileCache</refentrytitle>
 
6
<refentrytitle role="top_of_page" id="libebackend-e-file-cache.top_of_page">EFileCache</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBEBACKEND Library</refmiscinfo>
 
8
<refmiscinfo>
 
9
  LIBEBACKEND Library
 
10
</refmiscinfo>
9
11
</refmeta>
10
 
 
11
12
<refnamediv>
12
13
<refname>EFileCache</refname>
13
14
<refpurpose></refpurpose>
14
15
</refnamediv>
15
16
 
16
 
<refsynopsisdiv id="EFileCache.synopsis" role="synopsis">
 
17
<refsynopsisdiv id="libebackend-e-file-cache.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
18
 
 
19
 
<synopsis>
20
 
                    <link linkend="EFileCachePrivate">EFileCachePrivate</link>;
 
19
<anchor id="EFileCache"/>
 
20
<synopsis>                    <link linkend="EFileCachePrivate">EFileCachePrivate</link>;
21
21
                    <link linkend="EFileCache-struct">EFileCache</link>;
22
 
<link linkend="EFileCache">EFileCache</link> *        <link linkend="e-file-cache-new">e_file_cache_new</link>                    (const <link linkend="gchar">gchar</link> *filename);
23
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-file-cache-remove">e_file_cache_remove</link>                 (<link linkend="EFileCache">EFileCache</link> *cache);
24
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-file-cache-clean">e_file_cache_clean</link>                  (<link linkend="EFileCache">EFileCache</link> *cache);
25
 
const <link linkend="gchar">gchar</link> *       <link linkend="e-file-cache-get-object">e_file_cache_get_object</link>             (<link linkend="EFileCache">EFileCache</link> *cache,
26
 
                                                         const <link linkend="gchar">gchar</link> *key);
27
 
<link linkend="GSList">GSList</link> *            <link linkend="e-file-cache-get-objects">e_file_cache_get_objects</link>            (<link linkend="EFileCache">EFileCache</link> *cache);
28
 
<link linkend="GSList">GSList</link> *            <link linkend="e-file-cache-get-keys">e_file_cache_get_keys</link>               (<link linkend="EFileCache">EFileCache</link> *cache);
29
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-file-cache-add-object">e_file_cache_add_object</link>             (<link linkend="EFileCache">EFileCache</link> *cache,
30
 
                                                         const <link linkend="gchar">gchar</link> *key,
31
 
                                                         const <link linkend="gchar">gchar</link> *value);
32
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-file-cache-replace-object">e_file_cache_replace_object</link>         (<link linkend="EFileCache">EFileCache</link> *cache,
33
 
                                                         const <link linkend="gchar">gchar</link> *key,
34
 
                                                         const <link linkend="gchar">gchar</link> *new_value);
35
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-file-cache-remove-object">e_file_cache_remove_object</link>          (<link linkend="EFileCache">EFileCache</link> *cache,
36
 
                                                         const <link linkend="gchar">gchar</link> *key);
37
 
<link linkend="void">void</link>                <link linkend="e-file-cache-freeze-changes">e_file_cache_freeze_changes</link>         (<link linkend="EFileCache">EFileCache</link> *cache);
38
 
<link linkend="void">void</link>                <link linkend="e-file-cache-thaw-changes">e_file_cache_thaw_changes</link>           (<link linkend="EFileCache">EFileCache</link> *cache);
39
 
const <link linkend="gchar">gchar</link> *       <link linkend="e-file-cache-get-filename">e_file_cache_get_filename</link>           (<link linkend="EFileCache">EFileCache</link> *cache);
 
22
<link linkend="EFileCache"><returnvalue>EFileCache</returnvalue></link> *        <link linkend="e-file-cache-new">e_file_cache_new</link>                    (<parameter>const <link linkend="gchar"><type>gchar</type></link> *filename</parameter>);
 
23
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-file-cache-remove">e_file_cache_remove</link>                 (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
 
24
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-file-cache-clean">e_file_cache_clean</link>                  (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
 
25
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-file-cache-get-object">e_file_cache_get_object</link>             (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
 
26
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
 
27
<link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            <link linkend="e-file-cache-get-objects">e_file_cache_get_objects</link>            (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
 
28
<link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            <link linkend="e-file-cache-get-keys">e_file_cache_get_keys</link>               (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
 
29
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-file-cache-add-object">e_file_cache_add_object</link>             (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
 
30
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
 
31
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);
 
32
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-file-cache-replace-object">e_file_cache_replace_object</link>         (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
 
33
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
 
34
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *new_value</parameter>);
 
35
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-file-cache-remove-object">e_file_cache_remove_object</link>          (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
 
36
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
 
37
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-file-cache-freeze-changes">e_file_cache_freeze_changes</link>         (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
 
38
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-file-cache-thaw-changes">e_file_cache_thaw_changes</link>           (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
 
39
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-file-cache-get-filename">e_file_cache_get_filename</link>           (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);
40
40
</synopsis>
41
41
</refsynopsisdiv>
42
 
 
43
 
<refsect1 id="EFileCache.object-hierarchy" role="object_hierarchy">
 
42
<refsect1 id="libebackend-e-file-cache.object-hierarchy" role="object_hierarchy">
44
43
<title role="object_hierarchy.title">Object Hierarchy</title>
45
44
<synopsis>
46
45
  <link linkend="GObject">GObject</link>
47
46
   +----EFileCache
48
47
</synopsis>
49
48
</refsect1>
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
 
<refsect1 id="EFileCache.properties" role="properties">
 
49
<refsect1 id="libebackend-e-file-cache.properties" role="properties">
56
50
<title role="properties.title">Properties</title>
57
51
<synopsis>
58
 
  &quot;<link linkend="EFileCache--filename">filename</link>&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
 
52
  &quot;<link linkend="EFileCache--filename">filename</link>&quot;                 <link linkend="gchar"><type>gchar</type></link>*                : Read / Write / Construct Only
59
53
</synopsis>
60
54
</refsect1>
61
55
 
62
 
 
63
 
 
64
 
<refsect1 id="EFileCache.description" role="desc">
 
56
<refsect1 id="libebackend-e-file-cache.description" role="desc">
65
57
<title role="desc.title">Description</title>
66
58
<para>
67
59
</para>
68
60
</refsect1>
69
 
 
70
 
<refsect1 id="EFileCache.details" role="details">
 
61
<refsect1 id="libebackend-e-file-cache.details" role="details">
71
62
<title role="details.title">Details</title>
72
63
<refsect2 id="EFileCachePrivate" role="struct">
73
64
<title>EFileCachePrivate</title>
74
 
<indexterm zone="EFileCachePrivate"><primary sortas="EFileCachePrivate">EFileCachePrivate</primary></indexterm><programlisting>typedef struct _EFileCachePrivate EFileCachePrivate;</programlisting>
 
65
<indexterm zone="EFileCachePrivate"><primary>EFileCachePrivate</primary></indexterm>
 
66
<programlisting>typedef struct _EFileCachePrivate EFileCachePrivate;</programlisting>
75
67
<para>
76
68
</para></refsect2>
77
69
<refsect2 id="EFileCache-struct" role="struct">
78
70
<title>EFileCache</title>
79
 
<indexterm zone="EFileCache-struct"><primary sortas="EFileCache">EFileCache</primary></indexterm><programlisting>typedef struct _EFileCache EFileCache;</programlisting>
 
71
<indexterm zone="EFileCache-struct"><primary>EFileCache</primary></indexterm>
 
72
<programlisting>typedef struct _EFileCache EFileCache;</programlisting>
80
73
<para>
81
74
</para></refsect2>
82
75
<refsect2 id="e-file-cache-new" role="function">
83
76
<title>e_file_cache_new ()</title>
84
 
<indexterm zone="e-file-cache-new"><primary sortas="e_file_cache_new">e_file_cache_new</primary></indexterm><programlisting><link linkend="EFileCache">EFileCache</link> *        e_file_cache_new                    (const <link linkend="gchar">gchar</link> *filename);</programlisting>
 
77
<indexterm zone="e-file-cache-new"><primary>e_file_cache_new</primary></indexterm>
 
78
<programlisting><link linkend="EFileCache"><returnvalue>EFileCache</returnvalue></link> *        e_file_cache_new                    (<parameter>const <link linkend="gchar"><type>gchar</type></link> *filename</parameter>);</programlisting>
85
79
<para>
86
80
Creates a new <link linkend="EFileCache"><type>EFileCache</type></link> object, which implements a cache of
87
81
objects, very useful for remote backends.</para>
88
 
<para>
89
 
</para><variablelist role="params">
 
82
<variablelist role="params">
90
83
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
91
 
<listitem><simpara> filename where the cache is kept.
 
84
<listitem><simpara>filename where the cache is kept.
92
85
</simpara></listitem></varlistentry>
93
86
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly created object.
94
87
</simpara></listitem></varlistentry>
95
88
</variablelist></refsect2>
96
89
<refsect2 id="e-file-cache-remove" role="function">
97
90
<title>e_file_cache_remove ()</title>
98
 
<indexterm zone="e-file-cache-remove"><primary sortas="e_file_cache_remove">e_file_cache_remove</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_file_cache_remove                 (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
 
91
<indexterm zone="e-file-cache-remove"><primary>e_file_cache_remove</primary></indexterm>
 
92
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_file_cache_remove                 (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
99
93
<para>
100
94
Remove the cache from disk.</para>
101
 
<para>
102
 
</para><variablelist role="params">
 
95
<variablelist role="params">
103
96
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
104
 
<listitem><simpara> A <link linkend="EFileCache"><type>EFileCache</type></link> object.
 
97
<listitem><simpara>A <link linkend="EFileCache"><type>EFileCache</type></link> object.
105
98
</simpara></listitem></varlistentry>
106
99
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if successful, FALSE otherwise.
107
100
</simpara></listitem></varlistentry>
108
101
</variablelist></refsect2>
109
102
<refsect2 id="e-file-cache-clean" role="function">
110
103
<title>e_file_cache_clean ()</title>
111
 
<indexterm zone="e-file-cache-clean"><primary sortas="e_file_cache_clean">e_file_cache_clean</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_file_cache_clean                  (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
 
104
<indexterm zone="e-file-cache-clean"><primary>e_file_cache_clean</primary></indexterm>
 
105
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_file_cache_clean                  (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
112
106
<para>
113
107
Clean up the cache's contents.</para>
114
 
<para>
115
 
</para><variablelist role="params">
 
108
<variablelist role="params">
116
109
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
117
 
<listitem><simpara> A <link linkend="EFileCache"><type>EFileCache</type></link> object.
 
110
<listitem><simpara>A <link linkend="EFileCache"><type>EFileCache</type></link> object.
118
111
</simpara></listitem></varlistentry>
119
112
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if successful, FALSE otherwise.
120
113
</simpara></listitem></varlistentry>
121
114
</variablelist></refsect2>
122
115
<refsect2 id="e-file-cache-get-object" role="function">
123
116
<title>e_file_cache_get_object ()</title>
124
 
<indexterm zone="e-file-cache-get-object"><primary sortas="e_file_cache_get_object">e_file_cache_get_object</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       e_file_cache_get_object             (<link linkend="EFileCache">EFileCache</link> *cache,
125
 
                                                         const <link linkend="gchar">gchar</link> *key);</programlisting>
126
 
<para>
127
 
</para>
128
 
<para>
129
 
</para><variablelist role="params">
 
117
<indexterm zone="e-file-cache-get-object"><primary>e_file_cache_get_object</primary></indexterm>
 
118
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_file_cache_get_object             (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
 
119
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
 
120
<variablelist role="params">
130
121
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
131
122
<listitem><simpara>
132
123
</simpara></listitem></varlistentry>
138
129
</variablelist></refsect2>
139
130
<refsect2 id="e-file-cache-get-objects" role="function">
140
131
<title>e_file_cache_get_objects ()</title>
141
 
<indexterm zone="e-file-cache-get-objects"><primary sortas="e_file_cache_get_objects">e_file_cache_get_objects</primary></indexterm><programlisting><link linkend="GSList">GSList</link> *            e_file_cache_get_objects            (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
142
 
<para>
143
 
</para>
144
 
<para>
145
 
</para><variablelist role="params">
 
132
<indexterm zone="e-file-cache-get-objects"><primary>e_file_cache_get_objects</primary></indexterm>
 
133
<programlisting><link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            e_file_cache_get_objects            (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
 
134
<variablelist role="params">
146
135
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
147
136
<listitem><simpara>
148
137
</simpara></listitem></varlistentry>
151
140
</variablelist></refsect2>
152
141
<refsect2 id="e-file-cache-get-keys" role="function">
153
142
<title>e_file_cache_get_keys ()</title>
154
 
<indexterm zone="e-file-cache-get-keys"><primary sortas="e_file_cache_get_keys">e_file_cache_get_keys</primary></indexterm><programlisting><link linkend="GSList">GSList</link> *            e_file_cache_get_keys               (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
155
 
<para>
156
 
</para>
157
 
<para>
158
 
</para><variablelist role="params">
 
143
<indexterm zone="e-file-cache-get-keys"><primary>e_file_cache_get_keys</primary></indexterm>
 
144
<programlisting><link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            e_file_cache_get_keys               (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
 
145
<variablelist role="params">
159
146
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
160
147
<listitem><simpara>
161
148
</simpara></listitem></varlistentry>
164
151
</variablelist></refsect2>
165
152
<refsect2 id="e-file-cache-add-object" role="function">
166
153
<title>e_file_cache_add_object ()</title>
167
 
<indexterm zone="e-file-cache-add-object"><primary sortas="e_file_cache_add_object">e_file_cache_add_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_file_cache_add_object             (<link linkend="EFileCache">EFileCache</link> *cache,
168
 
                                                         const <link linkend="gchar">gchar</link> *key,
169
 
                                                         const <link linkend="gchar">gchar</link> *value);</programlisting>
170
 
<para>
171
 
</para>
172
 
<para>
173
 
</para><variablelist role="params">
 
154
<indexterm zone="e-file-cache-add-object"><primary>e_file_cache_add_object</primary></indexterm>
 
155
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_file_cache_add_object             (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
 
156
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
 
157
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting>
 
158
<variablelist role="params">
174
159
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
175
160
<listitem><simpara>
176
161
</simpara></listitem></varlistentry>
185
170
</variablelist></refsect2>
186
171
<refsect2 id="e-file-cache-replace-object" role="function">
187
172
<title>e_file_cache_replace_object ()</title>
188
 
<indexterm zone="e-file-cache-replace-object"><primary sortas="e_file_cache_replace_object">e_file_cache_replace_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_file_cache_replace_object         (<link linkend="EFileCache">EFileCache</link> *cache,
189
 
                                                         const <link linkend="gchar">gchar</link> *key,
190
 
                                                         const <link linkend="gchar">gchar</link> *new_value);</programlisting>
191
 
<para>
192
 
</para>
193
 
<para>
194
 
</para><variablelist role="params">
 
173
<indexterm zone="e-file-cache-replace-object"><primary>e_file_cache_replace_object</primary></indexterm>
 
174
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_file_cache_replace_object         (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
 
175
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
 
176
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *new_value</parameter>);</programlisting>
 
177
<variablelist role="params">
195
178
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
196
179
<listitem><simpara>
197
180
</simpara></listitem></varlistentry>
206
189
</variablelist></refsect2>
207
190
<refsect2 id="e-file-cache-remove-object" role="function">
208
191
<title>e_file_cache_remove_object ()</title>
209
 
<indexterm zone="e-file-cache-remove-object"><primary sortas="e_file_cache_remove_object">e_file_cache_remove_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_file_cache_remove_object          (<link linkend="EFileCache">EFileCache</link> *cache,
210
 
                                                         const <link linkend="gchar">gchar</link> *key);</programlisting>
211
 
<para>
212
 
</para>
213
 
<para>
214
 
</para><variablelist role="params">
 
192
<indexterm zone="e-file-cache-remove-object"><primary>e_file_cache_remove_object</primary></indexterm>
 
193
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_file_cache_remove_object          (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>,
 
194
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
 
195
<variablelist role="params">
215
196
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
216
197
<listitem><simpara>
217
198
</simpara></listitem></varlistentry>
223
204
</variablelist></refsect2>
224
205
<refsect2 id="e-file-cache-freeze-changes" role="function">
225
206
<title>e_file_cache_freeze_changes ()</title>
226
 
<indexterm zone="e-file-cache-freeze-changes"><primary sortas="e_file_cache_freeze_changes">e_file_cache_freeze_changes</primary></indexterm><programlisting><link linkend="void">void</link>                e_file_cache_freeze_changes         (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
 
207
<indexterm zone="e-file-cache-freeze-changes"><primary>e_file_cache_freeze_changes</primary></indexterm>
 
208
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_file_cache_freeze_changes         (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
227
209
<para>
228
210
Disables temporarily all writes to disk for the given cache object.</para>
229
 
<para>
230
 
</para><variablelist role="params">
 
211
<variablelist role="params">
231
212
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
232
 
<listitem><simpara> An <link linkend="EFileCache"><type>EFileCache</type></link> object.
 
213
<listitem><simpara>An <link linkend="EFileCache"><type>EFileCache</type></link> object.
233
214
</simpara></listitem></varlistentry>
234
215
</variablelist></refsect2>
235
216
<refsect2 id="e-file-cache-thaw-changes" role="function">
236
217
<title>e_file_cache_thaw_changes ()</title>
237
 
<indexterm zone="e-file-cache-thaw-changes"><primary sortas="e_file_cache_thaw_changes">e_file_cache_thaw_changes</primary></indexterm><programlisting><link linkend="void">void</link>                e_file_cache_thaw_changes           (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
 
218
<indexterm zone="e-file-cache-thaw-changes"><primary>e_file_cache_thaw_changes</primary></indexterm>
 
219
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_file_cache_thaw_changes           (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
238
220
<para>
239
221
Enables again writes to disk on every change.</para>
240
 
<para>
241
 
</para><variablelist role="params">
 
222
<variablelist role="params">
242
223
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
243
 
<listitem><simpara> An <link linkend="EFileCache"><type>EFileCache</type></link> object.
 
224
<listitem><simpara>An <link linkend="EFileCache"><type>EFileCache</type></link> object.
244
225
</simpara></listitem></varlistentry>
245
226
</variablelist></refsect2>
246
227
<refsect2 id="e-file-cache-get-filename" role="function">
247
228
<title>e_file_cache_get_filename ()</title>
248
 
<indexterm zone="e-file-cache-get-filename"><primary sortas="e_file_cache_get_filename">e_file_cache_get_filename</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       e_file_cache_get_filename           (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
 
229
<indexterm zone="e-file-cache-get-filename"><primary>e_file_cache_get_filename</primary></indexterm>
 
230
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_file_cache_get_filename           (<parameter><link linkend="EFileCache"><type>EFileCache</type></link> *cache</parameter>);</programlisting>
249
231
<para>
250
232
Gets the name of the file where the cache is being stored.</para>
251
 
<para>
252
 
</para><variablelist role="params">
 
233
<variablelist role="params">
253
234
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
254
 
<listitem><simpara> A <link linkend="EFileCache"><literal>EFileCache</literal></link> object.
 
235
<listitem><simpara>A <link linkend="EFileCache"><literal>EFileCache</literal></link> object.
255
236
</simpara></listitem></varlistentry>
256
237
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The name of the cache.
257
238
</simpara></listitem></varlistentry>
258
239
</variablelist></refsect2>
259
240
 
260
241
</refsect1>
261
 
<refsect1 id="EFileCache.property-details" role="property_details">
 
242
<refsect1 id="libebackend-e-file-cache.property-details" role="property_details">
262
243
<title role="property_details.title">Property Details</title>
263
244
<refsect2 id="EFileCache--filename" role="property"><title>The <literal>&quot;filename&quot;</literal> property</title>
264
 
<indexterm zone="EFileCache--filename"><primary sortas="EFileCache:filename">EFileCache:filename</primary></indexterm><programlisting>  &quot;filename&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
 
245
<indexterm zone="EFileCache--filename"><primary>EFileCache:filename</primary></indexterm>
 
246
<programlisting>  &quot;filename&quot;                 <link linkend="gchar"><type>gchar</type></link>*                : Read / Write / Construct Only</programlisting>
265
247
<para></para><para>Default value: ""</para>
266
248
</refsect2>
267
249
</refsect1>
268
250
 
269
 
 
270
 
 
271
 
 
272
251
</refentry>