File: libgda-libgda.html

package info (click to toggle)
libgda2 1.2.4-1.2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 13,724 kB
  • ctags: 6,979
  • sloc: ansic: 47,166; xml: 19,896; sh: 8,797; makefile: 863; yacc: 202; lex: 129; cpp: 73
file content (174 lines) | stat: -rw-r--r-- 7,457 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libgda</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GNOME Data Access manual">
<link rel="up" href="libgda-api.html" title="Client API Reference">
<link rel="prev" href="libgda-api.html" title="Client API Reference">
<link rel="next" href="libgda-gda-blob.html" title="gda-blob">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="introduction.html" title="Introduction">
<link rel="chapter" href="architecture.html" title="libgda architecture">
<link rel="chapter" href="installation.html" title="Installation">
<link rel="chapter" href="connecting.html" title="Beginning">
<link rel="chapter" href="processing-queries.html" title="Processing queries">
<link rel="chapter" href="ch06.html" title="Transactions and batch processes">
<link rel="chapter" href="managing-errors.html" title="Managing errors">
<link rel="chapter" href="main_example.html" title="Full example">
<link rel="chapter" href="migration.html" title="Some formulae for migration from old version">
<link rel="chapter" href="libgda-api.html" title="Client API Reference">
<link rel="chapter" href="libgda-providers.html" title="GDA Providers">
<link rel="chapter" href="libgda-xql.html" title="XML Queries">
<link rel="chapter" href="libgda-reports.html" title="GDA Report Engine">
<link rel="appendix" href="fdl.html" title="Appendix A. GNU Free Documentation License">
</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="libgda-api.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgda-api.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">GNOME Data Access manual</th>
<td><a accesskey="n" href="libgda-gda-blob.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgda-libgda.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgda-libgda.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgda-libgda"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-libgda.top_of_page"></a>libgda</span></h2>
<p>libgda — Library initialization</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgda-libgda.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
void                <a class="link" href="libgda-libgda.html#gda-init" title="gda_init ()">gda_init</a>                            (const gchar *app_id,
                                                         const gchar *version,
                                                         gint nargs,
                                                         gchar *args[]);
void                (<a class="link" href="libgda-libgda.html#GdaInitFunc" title="GdaInitFunc ()">*GdaInitFunc</a>)                      (gpointer user_data);
void                <a class="link" href="libgda-libgda.html#gda-main-run" title="gda_main_run ()">gda_main_run</a>                        (<a class="link" href="libgda-libgda.html#GdaInitFunc" title="GdaInitFunc ()">GdaInitFunc</a> init_func,
                                                         gpointer user_data);
void                <a class="link" href="libgda-libgda.html#gda-main-quit" title="gda_main_quit ()">gda_main_quit</a>                       (void);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="libgda-libgda.description"></a><h2>Description</h2>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="libgda-libgda.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="gda-init"></a><h3>gda_init ()</h3>
<pre class="programlisting">void                gda_init                            (const gchar *app_id,
                                                         const gchar *version,
                                                         gint nargs,
                                                         gchar *args[]);</pre>
<p>
Initializes the GDA library.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_id</code></em> :</span></p></td>
<td> name of the program.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
<td> revision number of the program.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nargs</code></em> :</span></p></td>
<td> number of arguments, usually argc from <code class="function">main()</code>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
<td> list of arguments, usually argv from <code class="function">main()</code>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GdaInitFunc"></a><h3>GdaInitFunc ()</h3>
<pre class="programlisting">void                (*GdaInitFunc)                      (gpointer user_data);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>


</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-main-run"></a><h3>gda_main_run ()</h3>
<pre class="programlisting">void                gda_main_run                        (<a class="link" href="libgda-libgda.html#GdaInitFunc" title="GdaInitFunc ()">GdaInitFunc</a> init_func,
                                                         gpointer user_data);</pre>
<p>
Runs the GDA main loop, which is nothing more than the Bonobo main
loop, but with internally added stuff specific for applications using
libgda.
</p>
<p>
You can specify a function to be called after everything has been correctly
initialized (that is, for initializing your own stuff).</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>init_func</code></em> :</span></p></td>
<td> function to be called when everything has been initialized.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td> data to be passed to the init function.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-main-quit"></a><h3>gda_main_quit ()</h3>
<pre class="programlisting">void                gda_main_quit                       (void);</pre>
<p>
Exits the main loop.</p>
<p>

</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.10</div>
</body>
</html>