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
|
<refentry id="libgda-GdaError">
<refmeta>
<refentrytitle role="top_of_page" id="libgda-GdaError.top_of_page">GdaError</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGDA Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GdaError</refname>
<refpurpose>Management of errors</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libgda-GdaError.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GdaErrorPrivate">GdaErrorPrivate</link>;
<link linkend="GdaError">GdaError</link>* <link linkend="gda-error-new">gda_error_new</link> (void);
<link linkend="void">void</link> <link linkend="gda-error-free">gda_error_free</link> (<link linkend="GdaError">GdaError</link> *error);
<link linkend="GList">GList</link>* <link linkend="gda-error-list-copy">gda_error_list_copy</link> (const <link linkend="GList">GList</link> *errors);
<link linkend="void">void</link> <link linkend="gda-error-list-free">gda_error_list_free</link> (<link linkend="GList">GList</link> *errors);
const <link linkend="gchar">gchar</link>* <link linkend="gda-error-get-description">gda_error_get_description</link> (<link linkend="GdaError">GdaError</link> *error);
<link linkend="void">void</link> <link linkend="gda-error-set-description">gda_error_set_description</link> (<link linkend="GdaError">GdaError</link> *error,
const <link linkend="gchar">gchar</link> *description);
<link linkend="glong">glong</link> <link linkend="gda-error-get-number">gda_error_get_number</link> (<link linkend="GdaError">GdaError</link> *error);
<link linkend="void">void</link> <link linkend="gda-error-set-number">gda_error_set_number</link> (<link linkend="GdaError">GdaError</link> *error,
<link linkend="glong">glong</link> number);
const <link linkend="gchar">gchar</link>* <link linkend="gda-error-get-source">gda_error_get_source</link> (<link linkend="GdaError">GdaError</link> *error);
<link linkend="void">void</link> <link linkend="gda-error-set-source">gda_error_set_source</link> (<link linkend="GdaError">GdaError</link> *error,
const <link linkend="gchar">gchar</link> *source);
const <link linkend="gchar">gchar</link>* <link linkend="gda-error-get-sqlstate">gda_error_get_sqlstate</link> (<link linkend="GdaError">GdaError</link> *error);
<link linkend="void">void</link> <link linkend="gda-error-set-sqlstate">gda_error_set_sqlstate</link> (<link linkend="GdaError">GdaError</link> *error,
const <link linkend="gchar">gchar</link> *sqlstate);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libgda-GdaError.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="libgda-GdaError.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GdaErrorPrivate" role="struct">
<title>GdaErrorPrivate</title>
<indexterm zone="GdaErrorPrivate"><primary>GdaErrorPrivate</primary></indexterm><programlisting>typedef struct _GdaErrorPrivate GdaErrorPrivate;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gda-error-new" role="function">
<title>gda_error_new ()</title>
<indexterm zone="gda-error-new"><primary>gda_error_new</primary></indexterm><programlisting><link linkend="GdaError">GdaError</link>* gda_error_new (void);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-error-free" role="function">
<title>gda_error_free ()</title>
<indexterm zone="gda-error-free"><primary>gda_error_free</primary></indexterm><programlisting><link linkend="void">void</link> gda_error_free (<link linkend="GdaError">GdaError</link> *error);</programlisting>
<para>
Frees the memory allocated by the error object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> the error object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-error-list-copy" role="function">
<title>gda_error_list_copy ()</title>
<indexterm zone="gda-error-list-copy"><primary>gda_error_list_copy</primary></indexterm><programlisting><link linkend="GList">GList</link>* gda_error_list_copy (const <link linkend="GList">GList</link> *errors);</programlisting>
<para>
Creates a new list which contains the same errors as <parameter>errors</parameter> and
adds a reference for each error in the list.
</para>
<para>
You must free the list using <link linkend="gda-error-list-free"><type>gda_error_list_free</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>errors</parameter> :</term>
<listitem><simpara> a GList holding error objects.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a list of errors.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-error-list-free" role="function">
<title>gda_error_list_free ()</title>
<indexterm zone="gda-error-list-free"><primary>gda_error_list_free</primary></indexterm><programlisting><link linkend="void">void</link> gda_error_list_free (<link linkend="GList">GList</link> *errors);</programlisting>
<para>
Frees all error objects in the list and the list itself.
After this function has been called, the <parameter>errors</parameter> parameter doesn't point
to valid storage any more.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>errors</parameter> :</term>
<listitem><simpara> a GList holding error objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-error-get-description" role="function">
<title>gda_error_get_description ()</title>
<indexterm zone="gda-error-get-description"><primary>gda_error_get_description</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gda_error_get_description (<link linkend="GdaError">GdaError</link> *error);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> a <link linkend="GdaError"><type>GdaError</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <parameter>error</parameter>'s description.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-error-set-description" role="function">
<title>gda_error_set_description ()</title>
<indexterm zone="gda-error-set-description"><primary>gda_error_set_description</primary></indexterm><programlisting><link linkend="void">void</link> gda_error_set_description (<link linkend="GdaError">GdaError</link> *error,
const <link linkend="gchar">gchar</link> *description);</programlisting>
<para>
Sets <parameter>error</parameter>'s <parameter>description</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> a <link linkend="GdaError"><type>GdaError</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>description</parameter> :</term>
<listitem><simpara> a description.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-error-get-number" role="function">
<title>gda_error_get_number ()</title>
<indexterm zone="gda-error-get-number"><primary>gda_error_get_number</primary></indexterm><programlisting><link linkend="glong">glong</link> gda_error_get_number (<link linkend="GdaError">GdaError</link> *error);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> a <link linkend="GdaError"><type>GdaError</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <parameter>error</parameter>'s number.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-error-set-number" role="function">
<title>gda_error_set_number ()</title>
<indexterm zone="gda-error-set-number"><primary>gda_error_set_number</primary></indexterm><programlisting><link linkend="void">void</link> gda_error_set_number (<link linkend="GdaError">GdaError</link> *error,
<link linkend="glong">glong</link> number);</programlisting>
<para>
Sets <parameter>error</parameter>'s <parameter>number</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> a <link linkend="GdaError"><type>GdaError</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>number</parameter> :</term>
<listitem><simpara> a number.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-error-get-source" role="function">
<title>gda_error_get_source ()</title>
<indexterm zone="gda-error-get-source"><primary>gda_error_get_source</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gda_error_get_source (<link linkend="GdaError">GdaError</link> *error);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> a <link linkend="GdaError"><type>GdaError</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <parameter>error</parameter>'s source.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-error-set-source" role="function">
<title>gda_error_set_source ()</title>
<indexterm zone="gda-error-set-source"><primary>gda_error_set_source</primary></indexterm><programlisting><link linkend="void">void</link> gda_error_set_source (<link linkend="GdaError">GdaError</link> *error,
const <link linkend="gchar">gchar</link> *source);</programlisting>
<para>
Sets <parameter>error</parameter>'s <parameter>source</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> a <link linkend="GdaError"><type>GdaError</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> a source.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-error-get-sqlstate" role="function">
<title>gda_error_get_sqlstate ()</title>
<indexterm zone="gda-error-get-sqlstate"><primary>gda_error_get_sqlstate</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gda_error_get_sqlstate (<link linkend="GdaError">GdaError</link> *error);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> a <link linkend="GdaError"><type>GdaError</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <parameter>error</parameter>'s SQL state.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-error-set-sqlstate" role="function">
<title>gda_error_set_sqlstate ()</title>
<indexterm zone="gda-error-set-sqlstate"><primary>gda_error_set_sqlstate</primary></indexterm><programlisting><link linkend="void">void</link> gda_error_set_sqlstate (<link linkend="GdaError">GdaError</link> *error,
const <link linkend="gchar">gchar</link> *sqlstate);</programlisting>
<para>
Sets <parameter>error</parameter>'s SQL state.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> a <link linkend="GdaError"><type>GdaError</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sqlstate</parameter> :</term>
<listitem><simpara> SQL state.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
