← 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/camel/xml/camel-groupwise-store-summary.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-08-10 15:05:30 UTC
  • mfrom: (1.1.71 upstream)
  • Revision ID: james.westby@ubuntu.com-20090810150530-91g7v606ee8ir474
Tags: 2.27.90-0ubuntu1
* New upstream version:
  Bug Fixes:
  Calendar:
  - #579965 - calendar file backend, update 'LAST-MODIFIED'
    when removing a recurring event instance 
  - #589984 - eds crash trying to create an event. 
  Mail:
  - #511283 - Some Images Do not Display in Evolution Mail Reader 
  Miscellaneous:
  - #590697 – Build regression detecting com_err.h 
  - #589388 – Build fixes / enhancements for EDS 

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/xml/camel-groupwise-store-summary.xml
1
 
<refentry id="camel-CamelGroupwiseStoreSummary">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="camel-CamelGroupwiseStoreSummary.top_of_page">CamelGroupwiseStoreSummary</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>CAMEL Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>CamelGroupwiseStoreSummary</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="camel-CamelGroupwiseStoreSummary.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
                    <link linkend="CamelGroupwiseStoreInfo">CamelGroupwiseStoreInfo</link>;
18
 
                    <link linkend="CamelGroupwiseStoreNamespace">CamelGroupwiseStoreNamespace</link>;
19
 
                    <link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link>;
20
 
<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> * <link linkend="camel-groupwise-store-summary-new">camel_groupwise_store_summary_new</link>
21
 
                                                        (void);
22
 
<link linkend="CamelGroupwiseStoreInfo">CamelGroupwiseStoreInfo</link> * <link linkend="camel-groupwise-store-summary-full-name">camel_groupwise_store_summary_full_name</link>
23
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
24
 
                                                         const <link linkend="gchar">gchar</link> *full_name);
25
 
<link linkend="CamelGroupwiseStoreInfo">CamelGroupwiseStoreInfo</link> * <link linkend="camel-groupwise-store-summary-add-from-full">camel_groupwise_store_summary_add_from_full</link>
26
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
27
 
                                                         const <link linkend="gchar">gchar</link> *full,
28
 
                                                         <link linkend="gchar">gchar</link> dir_sep);
29
 
<link linkend="gchar">gchar</link> *             <link linkend="camel-groupwise-store-summary-full-to-path">camel_groupwise_store_summary_full_to_path</link>
30
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
31
 
                                                         const <link linkend="gchar">gchar</link> *full_name,
32
 
                                                         <link linkend="gchar">gchar</link> dir_sep);
33
 
<link linkend="gchar">gchar</link> *             <link linkend="camel-groupwise-store-summary-path-to-full">camel_groupwise_store_summary_path_to_full</link>
34
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
35
 
                                                         const <link linkend="gchar">gchar</link> *path,
36
 
                                                         <link linkend="gchar">gchar</link> dir_sep);
37
 
<link linkend="gchar">gchar</link> *             <link linkend="camel-groupwise-store-summary-full-from-path">camel_groupwise_store_summary_full_from_path</link>
38
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
39
 
                                                         const <link linkend="gchar">gchar</link> *path);
40
 
<link linkend="CamelGroupwiseStoreNamespace">CamelGroupwiseStoreNamespace</link> * <link linkend="camel-groupwise-store-summary-namespace-new">camel_groupwise_store_summary_namespace_new</link>
41
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
42
 
                                                         const <link linkend="gchar">gchar</link> *full_name,
43
 
                                                         <link linkend="gchar">gchar</link> dir_sep);
44
 
<link linkend="CamelGroupwiseStoreNamespace">CamelGroupwiseStoreNamespace</link> * <link linkend="camel-groupwise-store-summary-namespace-find-path">camel_groupwise_store_summary_namespace_find_path</link>
45
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
46
 
                                                         const <link linkend="gchar">gchar</link> *path);
47
 
<link linkend="void">void</link>                <link linkend="camel-groupwise-store-summary-namespace-set">camel_groupwise_store_summary_namespace_set</link>
48
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
49
 
                                                         <link linkend="CamelGroupwiseStoreNamespace">CamelGroupwiseStoreNamespace</link> *ns);
50
 
#define             <link linkend="camel-groupwise-store-info-full-name">camel_groupwise_store_info_full_name</link>(s, i)
51
 
</synopsis>
52
 
</refsynopsisdiv>
53
 
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
 
 
62
 
<refsect1 id="camel-CamelGroupwiseStoreSummary.description" role="desc">
63
 
<title role="desc.title">Description</title>
64
 
<para>
65
 
</para>
66
 
</refsect1>
67
 
 
68
 
<refsect1 id="camel-CamelGroupwiseStoreSummary.details" role="details">
69
 
<title role="details.title">Details</title>
70
 
<refsect2 id="CamelGroupwiseStoreInfo" role="struct">
71
 
<title>CamelGroupwiseStoreInfo</title>
72
 
<indexterm zone="CamelGroupwiseStoreInfo"><primary sortas="CamelGroupwiseStoreInfo">CamelGroupwiseStoreInfo</primary></indexterm><programlisting>typedef struct {
73
 
        CamelStoreInfo info;
74
 
        gchar *full_name;
75
 
} CamelGroupwiseStoreInfo;
76
 
</programlisting>
77
 
<para>
78
 
</para></refsect2>
79
 
<refsect2 id="CamelGroupwiseStoreNamespace" role="struct">
80
 
<title>CamelGroupwiseStoreNamespace</title>
81
 
<indexterm zone="CamelGroupwiseStoreNamespace"><primary sortas="CamelGroupwiseStoreNamespace">CamelGroupwiseStoreNamespace</primary></indexterm><programlisting>typedef struct {
82
 
        gchar *path;             /* display path */
83
 
        gchar *full_name;        /* real name */
84
 
        gchar sep;               /* directory separator */
85
 
} CamelGroupwiseStoreNamespace;
86
 
</programlisting>
87
 
<para>
88
 
</para></refsect2>
89
 
<refsect2 id="CamelGroupwiseStoreSummary" role="struct">
90
 
<title>CamelGroupwiseStoreSummary</title>
91
 
<indexterm zone="CamelGroupwiseStoreSummary"><primary sortas="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</primary></indexterm><programlisting>typedef struct {
92
 
        CamelStoreSummary summary;
93
 
 
94
 
        struct _CamelGroupwiseStoreSummaryPrivate *priv;
95
 
 
96
 
        /* header info */
97
 
        guint32 version;        /* version of base part of file */
98
 
        guint32 capabilities;
99
 
        CamelGroupwiseStoreNamespace *namespace; /* eventually to be a list */
100
 
} CamelGroupwiseStoreSummary;
101
 
</programlisting>
102
 
<para>
103
 
</para></refsect2>
104
 
<refsect2 id="camel-groupwise-store-summary-new" role="function">
105
 
<title>camel_groupwise_store_summary_new ()</title>
106
 
<indexterm zone="camel-groupwise-store-summary-new"><primary sortas="camel_groupwise_store_summary_new">camel_groupwise_store_summary_new</primary></indexterm><programlisting><link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> * camel_groupwise_store_summary_new
107
 
                                                        (void);</programlisting>
108
 
<para>
109
 
</para><variablelist role="params">
110
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
111
 
</simpara></listitem></varlistentry>
112
 
</variablelist></refsect2>
113
 
<refsect2 id="camel-groupwise-store-summary-full-name" role="function">
114
 
<title>camel_groupwise_store_summary_full_name ()</title>
115
 
<indexterm zone="camel-groupwise-store-summary-full-name"><primary sortas="camel_groupwise_store_summary_full_name">camel_groupwise_store_summary_full_name</primary></indexterm><programlisting><link linkend="CamelGroupwiseStoreInfo">CamelGroupwiseStoreInfo</link> * camel_groupwise_store_summary_full_name
116
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
117
 
                                                         const <link linkend="gchar">gchar</link> *full_name);</programlisting>
118
 
<para>
119
 
</para><variablelist role="params">
120
 
<varlistentry><term><parameter>s</parameter>&#160;:</term>
121
 
<listitem><simpara>
122
 
</simpara></listitem></varlistentry>
123
 
<varlistentry><term><parameter>full_name</parameter>&#160;:</term>
124
 
<listitem><simpara>
125
 
</simpara></listitem></varlistentry>
126
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
127
 
</simpara></listitem></varlistentry>
128
 
</variablelist></refsect2>
129
 
<refsect2 id="camel-groupwise-store-summary-add-from-full" role="function">
130
 
<title>camel_groupwise_store_summary_add_from_full ()</title>
131
 
<indexterm zone="camel-groupwise-store-summary-add-from-full"><primary sortas="camel_groupwise_store_summary_add_from_full">camel_groupwise_store_summary_add_from_full</primary></indexterm><programlisting><link linkend="CamelGroupwiseStoreInfo">CamelGroupwiseStoreInfo</link> * camel_groupwise_store_summary_add_from_full
132
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
133
 
                                                         const <link linkend="gchar">gchar</link> *full,
134
 
                                                         <link linkend="gchar">gchar</link> dir_sep);</programlisting>
135
 
<para>
136
 
</para><variablelist role="params">
137
 
<varlistentry><term><parameter>s</parameter>&#160;:</term>
138
 
<listitem><simpara>
139
 
</simpara></listitem></varlistentry>
140
 
<varlistentry><term><parameter>full</parameter>&#160;:</term>
141
 
<listitem><simpara>
142
 
</simpara></listitem></varlistentry>
143
 
<varlistentry><term><parameter>dir_sep</parameter>&#160;:</term>
144
 
<listitem><simpara>
145
 
</simpara></listitem></varlistentry>
146
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
147
 
</simpara></listitem></varlistentry>
148
 
</variablelist></refsect2>
149
 
<refsect2 id="camel-groupwise-store-summary-full-to-path" role="function">
150
 
<title>camel_groupwise_store_summary_full_to_path ()</title>
151
 
<indexterm zone="camel-groupwise-store-summary-full-to-path"><primary sortas="camel_groupwise_store_summary_full_to_path">camel_groupwise_store_summary_full_to_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             camel_groupwise_store_summary_full_to_path
152
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
153
 
                                                         const <link linkend="gchar">gchar</link> *full_name,
154
 
                                                         <link linkend="gchar">gchar</link> dir_sep);</programlisting>
155
 
<para>
156
 
</para><variablelist role="params">
157
 
<varlistentry><term><parameter>s</parameter>&#160;:</term>
158
 
<listitem><simpara>
159
 
</simpara></listitem></varlistentry>
160
 
<varlistentry><term><parameter>full_name</parameter>&#160;:</term>
161
 
<listitem><simpara>
162
 
</simpara></listitem></varlistentry>
163
 
<varlistentry><term><parameter>dir_sep</parameter>&#160;:</term>
164
 
<listitem><simpara>
165
 
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
167
 
</simpara></listitem></varlistentry>
168
 
</variablelist></refsect2>
169
 
<refsect2 id="camel-groupwise-store-summary-path-to-full" role="function">
170
 
<title>camel_groupwise_store_summary_path_to_full ()</title>
171
 
<indexterm zone="camel-groupwise-store-summary-path-to-full"><primary sortas="camel_groupwise_store_summary_path_to_full">camel_groupwise_store_summary_path_to_full</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             camel_groupwise_store_summary_path_to_full
172
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
173
 
                                                         const <link linkend="gchar">gchar</link> *path,
174
 
                                                         <link linkend="gchar">gchar</link> dir_sep);</programlisting>
175
 
<para>
176
 
</para><variablelist role="params">
177
 
<varlistentry><term><parameter>s</parameter>&#160;:</term>
178
 
<listitem><simpara>
179
 
</simpara></listitem></varlistentry>
180
 
<varlistentry><term><parameter>path</parameter>&#160;:</term>
181
 
<listitem><simpara>
182
 
</simpara></listitem></varlistentry>
183
 
<varlistentry><term><parameter>dir_sep</parameter>&#160;:</term>
184
 
<listitem><simpara>
185
 
</simpara></listitem></varlistentry>
186
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
187
 
</simpara></listitem></varlistentry>
188
 
</variablelist></refsect2>
189
 
<refsect2 id="camel-groupwise-store-summary-full-from-path" role="function">
190
 
<title>camel_groupwise_store_summary_full_from_path ()</title>
191
 
<indexterm zone="camel-groupwise-store-summary-full-from-path"><primary sortas="camel_groupwise_store_summary_full_from_path">camel_groupwise_store_summary_full_from_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             camel_groupwise_store_summary_full_from_path
192
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
193
 
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
194
 
<para>
195
 
</para><variablelist role="params">
196
 
<varlistentry><term><parameter>s</parameter>&#160;:</term>
197
 
<listitem><simpara>
198
 
</simpara></listitem></varlistentry>
199
 
<varlistentry><term><parameter>path</parameter>&#160;:</term>
200
 
<listitem><simpara>
201
 
</simpara></listitem></varlistentry>
202
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
203
 
</simpara></listitem></varlistentry>
204
 
</variablelist></refsect2>
205
 
<refsect2 id="camel-groupwise-store-summary-namespace-new" role="function">
206
 
<title>camel_groupwise_store_summary_namespace_new ()</title>
207
 
<indexterm zone="camel-groupwise-store-summary-namespace-new"><primary sortas="camel_groupwise_store_summary_namespace_new">camel_groupwise_store_summary_namespace_new</primary></indexterm><programlisting><link linkend="CamelGroupwiseStoreNamespace">CamelGroupwiseStoreNamespace</link> * camel_groupwise_store_summary_namespace_new
208
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
209
 
                                                         const <link linkend="gchar">gchar</link> *full_name,
210
 
                                                         <link linkend="gchar">gchar</link> dir_sep);</programlisting>
211
 
<para>
212
 
</para><variablelist role="params">
213
 
<varlistentry><term><parameter>s</parameter>&#160;:</term>
214
 
<listitem><simpara>
215
 
</simpara></listitem></varlistentry>
216
 
<varlistentry><term><parameter>full_name</parameter>&#160;:</term>
217
 
<listitem><simpara>
218
 
</simpara></listitem></varlistentry>
219
 
<varlistentry><term><parameter>dir_sep</parameter>&#160;:</term>
220
 
<listitem><simpara>
221
 
</simpara></listitem></varlistentry>
222
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
223
 
</simpara></listitem></varlistentry>
224
 
</variablelist></refsect2>
225
 
<refsect2 id="camel-groupwise-store-summary-namespace-find-path" role="function">
226
 
<title>camel_groupwise_store_summary_namespace_find_path ()</title>
227
 
<indexterm zone="camel-groupwise-store-summary-namespace-find-path"><primary sortas="camel_groupwise_store_summary_namespace_find_path">camel_groupwise_store_summary_namespace_find_path</primary></indexterm><programlisting><link linkend="CamelGroupwiseStoreNamespace">CamelGroupwiseStoreNamespace</link> * camel_groupwise_store_summary_namespace_find_path
228
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
229
 
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
230
 
<para>
231
 
</para><variablelist role="params">
232
 
<varlistentry><term><parameter>s</parameter>&#160;:</term>
233
 
<listitem><simpara>
234
 
</simpara></listitem></varlistentry>
235
 
<varlistentry><term><parameter>path</parameter>&#160;:</term>
236
 
<listitem><simpara>
237
 
</simpara></listitem></varlistentry>
238
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
239
 
</simpara></listitem></varlistentry>
240
 
</variablelist></refsect2>
241
 
<refsect2 id="camel-groupwise-store-summary-namespace-set" role="function">
242
 
<title>camel_groupwise_store_summary_namespace_set ()</title>
243
 
<indexterm zone="camel-groupwise-store-summary-namespace-set"><primary sortas="camel_groupwise_store_summary_namespace_set">camel_groupwise_store_summary_namespace_set</primary></indexterm><programlisting><link linkend="void">void</link>                camel_groupwise_store_summary_namespace_set
244
 
                                                        (<link linkend="CamelGroupwiseStoreSummary">CamelGroupwiseStoreSummary</link> *s,
245
 
                                                         <link linkend="CamelGroupwiseStoreNamespace">CamelGroupwiseStoreNamespace</link> *ns);</programlisting>
246
 
<para>
247
 
</para><variablelist role="params">
248
 
<varlistentry><term><parameter>s</parameter>&#160;:</term>
249
 
<listitem><simpara>
250
 
</simpara></listitem></varlistentry>
251
 
<varlistentry><term><parameter>ns</parameter>&#160;:</term>
252
 
<listitem><simpara>
253
 
</simpara></listitem></varlistentry>
254
 
</variablelist></refsect2>
255
 
<refsect2 id="camel-groupwise-store-info-full-name" role="macro">
256
 
<title>camel_groupwise_store_info_full_name()</title>
257
 
<indexterm zone="camel-groupwise-store-info-full-name"><primary sortas="camel_groupwise_store_info_full_name">camel_groupwise_store_info_full_name</primary></indexterm><programlisting>#define camel_groupwise_store_info_full_name(s, i) (camel_store_info_string((CamelStoreSummary *)s, (const CamelStoreInfo *)i, CAMEL_STORE_INFO_LAST))
258
 
</programlisting>
259
 
<para>
260
 
</para><variablelist role="params">
261
 
<varlistentry><term><parameter>s</parameter>&#160;:</term>
262
 
<listitem><simpara>
263
 
</simpara></listitem></varlistentry>
264
 
<varlistentry><term><parameter>i</parameter>&#160;:</term>
265
 
<listitem><simpara>
266
 
</simpara></listitem></varlistentry>
267
 
</variablelist></refsect2>
268
 
 
269
 
</refsect1>
270
 
 
271
 
 
272
 
 
273
 
 
274
 
</refentry>