← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/libebackend/xml/e-dbhash.xml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libebackend/xml/e-dbhash.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="libebackend-e-dbhash">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libebackend-e-dbhash.top_of_page">e-dbhash</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEBACKEND Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>e-dbhash</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libebackend-e-dbhash.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>enum                <link linkend="EDbHashStatus">EDbHashStatus</link>;
21
 
                    <link linkend="EDbHash">EDbHash</link>;
22
 
                    <link linkend="EDbHashPrivate">EDbHashPrivate</link>;
23
 
<link linkend="void"><returnvalue>void</returnvalue></link>                (<link linkend="EDbHashFunc">*EDbHashFunc</link>)                      (<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
24
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);
25
 
<link linkend="EDbHash"><returnvalue>EDbHash</returnvalue></link> *           <link linkend="e-dbhash-new">e_dbhash_new</link>                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *filename</parameter>);
26
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-dbhash-add">e_dbhash_add</link>                        (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>,
27
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
28
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *data</parameter>);
29
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-dbhash-remove">e_dbhash_remove</link>                     (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>,
30
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
31
 
<link linkend="EDbHashStatus"><returnvalue>EDbHashStatus</returnvalue></link>       <link linkend="e-dbhash-compare">e_dbhash_compare</link>                    (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>,
32
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
33
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *compare_data</parameter>);
34
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-dbhash-foreach-key">e_dbhash_foreach_key</link>                (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>,
35
 
                                                         <parameter><link linkend="EDbHashFunc"><type>EDbHashFunc</type></link> func</parameter>,
36
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);
37
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-dbhash-write">e_dbhash_write</link>                      (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>);
38
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-dbhash-destroy">e_dbhash_destroy</link>                    (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>);
39
 
</synopsis>
40
 
</refsynopsisdiv>
41
 
 
42
 
<refsect1 id="libebackend-e-dbhash.description" role="desc">
43
 
<title role="desc.title">Description</title>
44
 
<para>
45
 
</para>
46
 
</refsect1>
47
 
<refsect1 id="libebackend-e-dbhash.details" role="details">
48
 
<title role="details.title">Details</title>
49
 
<refsect2 id="EDbHashStatus" role="enum">
50
 
<title>enum EDbHashStatus</title>
51
 
<indexterm zone="EDbHashStatus"><primary>EDbHashStatus</primary></indexterm>
52
 
<programlisting>typedef enum {
53
 
        E_DBHASH_STATUS_SAME,
54
 
        E_DBHASH_STATUS_DIFFERENT,
55
 
        E_DBHASH_STATUS_NOT_FOUND
56
 
} EDbHashStatus;
57
 
</programlisting>
58
 
<para>
59
 
</para></refsect2>
60
 
<refsect2 id="EDbHash" role="struct">
61
 
<title>EDbHash</title>
62
 
<indexterm zone="EDbHash"><primary>EDbHash</primary></indexterm>
63
 
<programlisting>typedef struct {
64
 
        EDbHashPrivate *priv;
65
 
} EDbHash;
66
 
</programlisting>
67
 
<para>
68
 
</para></refsect2>
69
 
<refsect2 id="EDbHashPrivate" role="struct">
70
 
<title>EDbHashPrivate</title>
71
 
<indexterm zone="EDbHashPrivate"><primary>EDbHashPrivate</primary></indexterm>
72
 
<programlisting>typedef struct _EDbHashPrivate EDbHashPrivate;</programlisting>
73
 
<para>
74
 
</para></refsect2>
75
 
<refsect2 id="EDbHashFunc" role="function">
76
 
<title>EDbHashFunc ()</title>
77
 
<indexterm zone="EDbHashFunc"><primary>EDbHashFunc</primary></indexterm>
78
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                (*EDbHashFunc)                      (<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
79
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting>
80
 
<para>
81
 
</para><variablelist role="params">
82
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
83
 
<listitem><simpara>
84
 
</simpara></listitem></varlistentry>
85
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
86
 
<listitem><simpara>
87
 
</simpara></listitem></varlistentry>
88
 
</variablelist></refsect2>
89
 
<refsect2 id="e-dbhash-new" role="function">
90
 
<title>e_dbhash_new ()</title>
91
 
<indexterm zone="e-dbhash-new"><primary>e_dbhash_new</primary></indexterm>
92
 
<programlisting><link linkend="EDbHash"><returnvalue>EDbHash</returnvalue></link> *           e_dbhash_new                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *filename</parameter>);</programlisting>
93
 
<para>
94
 
</para><variablelist role="params">
95
 
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
96
 
<listitem><simpara>
97
 
</simpara></listitem></varlistentry>
98
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
99
 
</simpara></listitem></varlistentry>
100
 
</variablelist></refsect2>
101
 
<refsect2 id="e-dbhash-add" role="function">
102
 
<title>e_dbhash_add ()</title>
103
 
<indexterm zone="e-dbhash-add"><primary>e_dbhash_add</primary></indexterm>
104
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_dbhash_add                        (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>,
105
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
106
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *data</parameter>);</programlisting>
107
 
<para>
108
 
</para><variablelist role="params">
109
 
<varlistentry><term><parameter>edbh</parameter>&#160;:</term>
110
 
<listitem><simpara>
111
 
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
113
 
<listitem><simpara>
114
 
</simpara></listitem></varlistentry>
115
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
116
 
<listitem><simpara>
117
 
</simpara></listitem></varlistentry>
118
 
</variablelist></refsect2>
119
 
<refsect2 id="e-dbhash-remove" role="function">
120
 
<title>e_dbhash_remove ()</title>
121
 
<indexterm zone="e-dbhash-remove"><primary>e_dbhash_remove</primary></indexterm>
122
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_dbhash_remove                     (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>,
123
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
124
 
<para>
125
 
</para><variablelist role="params">
126
 
<varlistentry><term><parameter>edbh</parameter>&#160;:</term>
127
 
<listitem><simpara>
128
 
</simpara></listitem></varlistentry>
129
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
130
 
<listitem><simpara>
131
 
</simpara></listitem></varlistentry>
132
 
</variablelist></refsect2>
133
 
<refsect2 id="e-dbhash-compare" role="function">
134
 
<title>e_dbhash_compare ()</title>
135
 
<indexterm zone="e-dbhash-compare"><primary>e_dbhash_compare</primary></indexterm>
136
 
<programlisting><link linkend="EDbHashStatus"><returnvalue>EDbHashStatus</returnvalue></link>       e_dbhash_compare                    (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>,
137
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
138
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *compare_data</parameter>);</programlisting>
139
 
<para>
140
 
</para><variablelist role="params">
141
 
<varlistentry><term><parameter>edbh</parameter>&#160;:</term>
142
 
<listitem><simpara>
143
 
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
145
 
<listitem><simpara>
146
 
</simpara></listitem></varlistentry>
147
 
<varlistentry><term><parameter>compare_data</parameter>&#160;:</term>
148
 
<listitem><simpara>
149
 
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
151
 
</simpara></listitem></varlistentry>
152
 
</variablelist></refsect2>
153
 
<refsect2 id="e-dbhash-foreach-key" role="function">
154
 
<title>e_dbhash_foreach_key ()</title>
155
 
<indexterm zone="e-dbhash-foreach-key"><primary>e_dbhash_foreach_key</primary></indexterm>
156
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_dbhash_foreach_key                (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>,
157
 
                                                         <parameter><link linkend="EDbHashFunc"><type>EDbHashFunc</type></link> func</parameter>,
158
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting>
159
 
<para>
160
 
</para><variablelist role="params">
161
 
<varlistentry><term><parameter>edbh</parameter>&#160;:</term>
162
 
<listitem><simpara>
163
 
</simpara></listitem></varlistentry>
164
 
<varlistentry><term><parameter>func</parameter>&#160;:</term>
165
 
<listitem><simpara>
166
 
</simpara></listitem></varlistentry>
167
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
168
 
<listitem><simpara>
169
 
</simpara></listitem></varlistentry>
170
 
</variablelist></refsect2>
171
 
<refsect2 id="e-dbhash-write" role="function">
172
 
<title>e_dbhash_write ()</title>
173
 
<indexterm zone="e-dbhash-write"><primary>e_dbhash_write</primary></indexterm>
174
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_dbhash_write                      (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>);</programlisting>
175
 
<para>
176
 
</para><variablelist role="params">
177
 
<varlistentry><term><parameter>edbh</parameter>&#160;:</term>
178
 
<listitem><simpara>
179
 
</simpara></listitem></varlistentry>
180
 
</variablelist></refsect2>
181
 
<refsect2 id="e-dbhash-destroy" role="function">
182
 
<title>e_dbhash_destroy ()</title>
183
 
<indexterm zone="e-dbhash-destroy"><primary>e_dbhash_destroy</primary></indexterm>
184
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_dbhash_destroy                    (<parameter><link linkend="EDbHash"><type>EDbHash</type></link> *edbh</parameter>);</programlisting>
185
 
<para>
186
 
</para><variablelist role="params">
187
 
<varlistentry><term><parameter>edbh</parameter>&#160;:</term>
188
 
<listitem><simpara>
189
 
</simpara></listitem></varlistentry>
190
 
</variablelist></refsect2>
191
 
 
192
 
</refsect1>
193
 
 
194
 
</refentry>