← Back to branch summary

~ubuntu-branches/ubuntu/karmic/mergeant/karmic

« back to all changes in this revision

Viewing changes to doc/libmergeant/C/xml/mg-server.xml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo R. Montesino
  • Date: 2007-11-29 08:44:48 UTC
  • mfrom: (2.1.4 hardy)
  • Revision ID: james.westby@ubuntu.com-20071129084448-6aon73d22bv6hzfw
Tags: 0.67-3
* Re-enable installation of the mime files in mergeant.install
* mergeant.dirs: create usr/share/mime/packages to make dh_installmime add
  the update-mime-database code snippets

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/libmergeant/C/xml/mg-server.xml
1
 
<refentry id="MgServer">
2
 
<refmeta>
3
 
<refentrytitle>MgServer</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBMERGEANT Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>MgServer</refname><refpurpose>Manages the connection to a database server.</refpurpose>
10
 
</refnamediv>
11
 
 
12
 
<refsynopsisdiv><title>Synopsis</title>
13
 
 
14
 
<synopsis>
15
 
 
16
 
 
17
 
 
18
 
struct      <link linkend="MgServer-struct">MgServer</link>;
19
 
enum        <link linkend="MgServerQueryType">MgServerQueryType</link>;
20
 
<link linkend="guint">guint</link>       <link linkend="mg-server-get-type">mg_server_get_type</link>              (void);
21
 
<link linkend="GObject">GObject</link>*    <link linkend="mg-server-new">mg_server_new</link>                   (<link linkend="MgConf">MgConf</link> *conf);
22
 
<link linkend="gboolean">gboolean</link>    <link linkend="mg-server-set-datasource">mg_server_set_datasource</link>        (<link linkend="MgServer">MgServer</link> *srv,
23
 
                                             const <link linkend="gchar">gchar</link> *datasource);
24
 
<link linkend="gchar">gchar</link>*      <link linkend="mg-server-get-datasource">mg_server_get_datasource</link>        (<link linkend="MgServer">MgServer</link> *srv);
25
 
<link linkend="gboolean">gboolean</link>    <link linkend="mg-server-set-user-name">mg_server_set_user_name</link>         (<link linkend="MgServer">MgServer</link> *srv,
26
 
                                             const <link linkend="gchar">gchar</link> *username);
27
 
<link linkend="gchar">gchar</link>*      <link linkend="mg-server-get-user-name">mg_server_get_user_name</link>         (<link linkend="MgServer">MgServer</link> *srv);
28
 
<link linkend="gboolean">gboolean</link>    <link linkend="mg-server-set-user-password">mg_server_set_user_password</link>     (<link linkend="MgServer">MgServer</link> *srv,
29
 
                                             const <link linkend="gchar">gchar</link> *password);
30
 
<link linkend="void">void</link>        <link linkend="mg-server-reset">mg_server_reset</link>                 (<link linkend="MgServer">MgServer</link> *srv);
31
 
<link linkend="GdaConnection">GdaConnection</link>* <link linkend="mg-server-get-gda-connection">mg_server_get_gda_connection</link> (<link linkend="MgServer">MgServer</link> *srv);
32
 
<link linkend="gboolean">gboolean</link>    <link linkend="mg-server-open-connect">mg_server_open_connect</link>          (<link linkend="MgServer">MgServer</link> *srv,
33
 
                                             <link linkend="GError">GError</link> **error);
34
 
<link linkend="gboolean">gboolean</link>    <link linkend="mg-server-conn-is-opened">mg_server_conn_is_opened</link>        (<link linkend="MgServer">MgServer</link> *srv);
35
 
<link linkend="void">void</link>        <link linkend="mg-server-close-connect">mg_server_close_connect</link>         (<link linkend="MgServer">MgServer</link> *srv);
36
 
<link linkend="void">void</link>        <link linkend="mg-server-close-connect-no-warn">mg_server_close_connect_no_warn</link> (<link linkend="MgServer">MgServer</link> *srv);
37
 
<link linkend="MgConf">MgConf</link>*     <link linkend="mg-server-get-conf">mg_server_get_conf</link>              (<link linkend="MgServer">MgServer</link> *srv);
38
 
<link linkend="MgServerOpMode">MgServerOpMode</link> <link linkend="mg-server-get-sql-op-mode">mg_server_get_sql_op_mode</link>    (<link linkend="MgServer">MgServer</link> *srv,
39
 
                                             const <link linkend="gchar">gchar</link> *query);
40
 
<link linkend="MgResultSet">MgResultSet</link>* <link linkend="mg-server-do-query">mg_server_do_query</link>             (<link linkend="MgServer">MgServer</link> *srv,
41
 
                                             const <link linkend="gchar">gchar</link> *query,
42
 
                                             <link linkend="MgServerQueryType">MgServerQueryType</link> type,
43
 
                                             <link linkend="GError">GError</link> **error);
44
 
<link linkend="gboolean">gboolean</link>    <link linkend="mg-server-update-dbms-data">mg_server_update_dbms_data</link>      (<link linkend="MgServer">MgServer</link> *srv,
45
 
                                             <link linkend="GError">GError</link> **error);
46
 
<link linkend="void">void</link>        <link linkend="mg-server-stop-update-dbms-data">mg_server_stop_update_dbms_data</link> (<link linkend="MgServer">MgServer</link> *srv);
47
 
<link linkend="MgDataHandler">MgDataHandler</link>* <link linkend="mg-server-get-handler-by-name">mg_server_get_handler_by_name</link>
48
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
49
 
                                             const <link linkend="gchar">gchar</link> *name);
50
 
<link linkend="MgDataHandler">MgDataHandler</link>* <link linkend="mg-server-get-handler-by-type">mg_server_get_handler_by_type</link>
51
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
52
 
                                             <link linkend="MgServerDataType">MgServerDataType</link> *type);
53
 
<link linkend="MgDataHandler">MgDataHandler</link>* <link linkend="mg-server-get-handler-by-gda">mg_server_get_handler_by_gda</link> (<link linkend="MgServer">MgServer</link> *srv,
54
 
                                             <link linkend="GdaValueType">GdaValueType</link> gda_type);
55
 
<link linkend="GSList">GSList</link>*     <link linkend="mg-server-get-plugin-handlers">mg_server_get_plugin_handlers</link>   (<link linkend="MgServer">MgServer</link> *srv);
56
 
<link linkend="MgUser">MgUser</link>*     <link linkend="mg-server-get-user-by-name">mg_server_get_user_by_name</link>      (<link linkend="MgServer">MgServer</link> *srv,
57
 
                                             const <link linkend="gchar">gchar</link> *username);
58
 
<link linkend="GSList">GSList</link>*     <link linkend="mg-server-get-data-types">mg_server_get_data_types</link>        (<link linkend="MgServer">MgServer</link> *srv);
59
 
<link linkend="MgServerDataType">MgServerDataType</link>* <link linkend="mg-server-get-data-type-by-name">mg_server_get_data_type_by_name</link>
60
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
61
 
                                             const <link linkend="gchar">gchar</link> *typename);
62
 
<link linkend="MgServerDataType">MgServerDataType</link>* <link linkend="mg-server-get-data-type-by-xml-id">mg_server_get_data_type_by_xml_id</link>
63
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
64
 
                                             const <link linkend="gchar">gchar</link> *xml_id);
65
 
<link linkend="GSList">GSList</link>*     <link linkend="mg-server-get-functions">mg_server_get_functions</link>         (<link linkend="MgServer">MgServer</link> *srv);
66
 
<link linkend="GSList">GSList</link>*     <link linkend="mg-server-get-functions-by-name">mg_server_get_functions_by_name</link> (<link linkend="MgServer">MgServer</link> *srv,
67
 
                                             const <link linkend="gchar">gchar</link> *funcname);
68
 
<link linkend="MgServerFunction">MgServerFunction</link>* <link linkend="mg-server-get-function-by-name-arg">mg_server_get_function_by_name_arg</link>
69
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
70
 
                                             const <link linkend="gchar">gchar</link> *funcname,
71
 
                                             const <link linkend="GSList">GSList</link> *argtypes);
72
 
<link linkend="MgServerFunction">MgServerFunction</link>* <link linkend="mg-server-get-function-by-dbms-id">mg_server_get_function_by_dbms_id</link>
73
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
74
 
                                             const <link linkend="gchar">gchar</link> *dbms_id);
75
 
<link linkend="MgServerFunction">MgServerFunction</link>* <link linkend="mg-server-get-function-by-xml-id">mg_server_get_function_by_xml_id</link>
76
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
77
 
                                             const <link linkend="gchar">gchar</link> *xml_id);
78
 
<link linkend="GSList">GSList</link>*     <link linkend="mg-server-get-aggregates">mg_server_get_aggregates</link>        (<link linkend="MgServer">MgServer</link> *srv);
79
 
<link linkend="GSList">GSList</link>*     <link linkend="mg-server-get-aggregates-by-name">mg_server_get_aggregates_by_name</link>
80
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
81
 
                                             const <link linkend="gchar">gchar</link> *aggname);
82
 
<link linkend="MgServerAggregate">MgServerAggregate</link>* <link linkend="mg-server-get-aggregate-by-name-arg">mg_server_get_aggregate_by_name_arg</link>
83
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
84
 
                                             const <link linkend="gchar">gchar</link> *aggname,
85
 
                                             <link linkend="MgServerDataType">MgServerDataType</link> *argtype);
86
 
<link linkend="MgServerAggregate">MgServerAggregate</link>* <link linkend="mg-server-get-aggregate-by-dbms-id">mg_server_get_aggregate_by_dbms_id</link>
87
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
88
 
                                             const <link linkend="gchar">gchar</link> *dbms_id);
89
 
<link linkend="MgServerAggregate">MgServerAggregate</link>* <link linkend="mg-server-get-aggregate-by-xml-id">mg_server_get_aggregate_by_xml_id</link>
90
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
91
 
                                             const <link linkend="gchar">gchar</link> *xml_id);
92
 
<link linkend="MgDataHandler">MgDataHandler</link>* <link linkend="mg-server-get-object-handler">mg_server_get_object_handler</link> (<link linkend="MgServer">MgServer</link> *srv,
93
 
                                             <link linkend="GObject">GObject</link> *object);
94
 
<link linkend="void">void</link>        <link linkend="mg-server-set-object-handler">mg_server_set_object_handler</link>    (<link linkend="MgServer">MgServer</link> *srv,
95
 
                                             <link linkend="GObject">GObject</link> *object,
96
 
                                             <link linkend="MgDataHandler">MgDataHandler</link> *handler);
97
 
<link linkend="void">void</link>        <link linkend="mg-server-unset-object-handler">mg_server_unset_object_handler</link>  (<link linkend="MgServer">MgServer</link> *srv,
98
 
                                             <link linkend="GObject">GObject</link> *object);
99
 
<link linkend="gboolean">gboolean</link>    <link linkend="mg-server-object-has-handler">mg_server_object_has_handler</link>    (<link linkend="MgServer">MgServer</link> *srv,
100
 
                                             <link linkend="GObject">GObject</link> *object);
101
 
<link linkend="void">void</link>        <link linkend="mg-server-set-object-func-handler">mg_server_set_object_func_handler</link>
102
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
103
 
                                             <link linkend="MgDataHandler">MgDataHandler</link>* (*func) (MgServer *, GObject *));
104
 
<link linkend="gchar">gchar</link>*      <link linkend="mg-server-stringify-value">mg_server_stringify_value</link>       (<link linkend="MgServer">MgServer</link> *srv,
105
 
                                             const <link linkend="GdaValue">GdaValue</link> *value);
106
 
<link linkend="gchar">gchar</link>*      <link linkend="mg-server-escape-chars">mg_server_escape_chars</link>          (<link linkend="MgServer">MgServer</link> *srv,
107
 
                                             const <link linkend="gchar">gchar</link> *string);
108
 
<link linkend="GdaDataModel">GdaDataModel</link>* <link linkend="mg-server-get-gda-schema">mg_server_get_gda_schema</link>      (<link linkend="MgServer">MgServer</link> *srv,
109
 
                                             <link linkend="GdaConnectionSchema">GdaConnectionSchema</link> schema,
110
 
                                             <link linkend="GdaParameterList">GdaParameterList</link> *params);
111
 
<link linkend="void">void</link>        <link linkend="mg-server-dump">mg_server_dump</link>                  (<link linkend="MgServer">MgServer</link> *srv,
112
 
                                             <link linkend="gint">gint</link> offset);
113
 
</synopsis>
114
 
</refsynopsisdiv>
115
 
 
116
 
<refsect1>
117
 
<title>Object Hierarchy</title>
118
 
<synopsis>
119
 
 
120
 
  <link linkend="GObject">GObject</link>
121
 
   +----<link linkend="GdaClient">GdaClient</link>
122
 
         +----MgServer
123
 
</synopsis>
124
 
 
125
 
</refsect1>
126
 
 
127
 
 
128
 
 
129
 
<refsect1>
130
 
<title>Implemented Interfaces</title>
131
 
<para>
132
 
MgServer implements
133
 
 <link linkend="MgXmlStorage">MgXmlStorage</link>.</para>
134
 
 
135
 
</refsect1>
136
 
 
137
 
 
138
 
<refsect1>
139
 
<title>Properties</title>
140
 
<synopsis>
141
 
 
142
 
  &quot;<link linkend="MgServer--with-functions">with-functions</link>&quot;       <link linkend="gboolean">gboolean</link>             : Read / Write
143
 
</synopsis>
144
 
</refsect1>
145
 
 
146
 
<refsect1>
147
 
<title>Signal Prototypes</title>
148
 
<synopsis>
149
 
 
150
 
&quot;<link linkend="MgServer-conn-closed">conn-closed</link>&quot;
151
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
152
 
                                            <link linkend="gpointer">gpointer</link> user_data);
153
 
&quot;<link linkend="MgServer-conn-opened">conn-opened</link>&quot;
154
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
155
 
                                            <link linkend="gpointer">gpointer</link> user_data);
156
 
&quot;<link linkend="MgServer-conn-to-close">conn-to-close</link>&quot;
157
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
158
 
                                            <link linkend="gpointer">gpointer</link> user_data);
159
 
&quot;<link linkend="MgServer-data-aggregate-added">data-aggregate-added</link>&quot;
160
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
161
 
                                            <link linkend="gpointer">gpointer</link> arg1,
162
 
                                            <link linkend="gpointer">gpointer</link> user_data);
163
 
&quot;<link linkend="MgServer-data-aggregate-removed">data-aggregate-removed</link>&quot;
164
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
165
 
                                            <link linkend="gpointer">gpointer</link> arg1,
166
 
                                            <link linkend="gpointer">gpointer</link> user_data);
167
 
&quot;<link linkend="MgServer-data-aggregate-updated">data-aggregate-updated</link>&quot;
168
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
169
 
                                            <link linkend="gpointer">gpointer</link> arg1,
170
 
                                            <link linkend="gpointer">gpointer</link> user_data);
171
 
&quot;<link linkend="MgServer-data-function-added">data-function-added</link>&quot;
172
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
173
 
                                            <link linkend="gpointer">gpointer</link> arg1,
174
 
                                            <link linkend="gpointer">gpointer</link> user_data);
175
 
&quot;<link linkend="MgServer-data-function-removed">data-function-removed</link>&quot;
176
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
177
 
                                            <link linkend="gpointer">gpointer</link> arg1,
178
 
                                            <link linkend="gpointer">gpointer</link> user_data);
179
 
&quot;<link linkend="MgServer-data-function-updated">data-function-updated</link>&quot;
180
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
181
 
                                            <link linkend="gpointer">gpointer</link> arg1,
182
 
                                            <link linkend="gpointer">gpointer</link> user_data);
183
 
&quot;<link linkend="MgServer-data-type-added">data-type-added</link>&quot;
184
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
185
 
                                            <link linkend="gpointer">gpointer</link> arg1,
186
 
                                            <link linkend="gpointer">gpointer</link> user_data);
187
 
&quot;<link linkend="MgServer-data-type-removed">data-type-removed</link>&quot;
188
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
189
 
                                            <link linkend="gpointer">gpointer</link> arg1,
190
 
                                            <link linkend="gpointer">gpointer</link> user_data);
191
 
&quot;<link linkend="MgServer-data-type-updated">data-type-updated</link>&quot;
192
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
193
 
                                            <link linkend="gpointer">gpointer</link> arg1,
194
 
                                            <link linkend="gpointer">gpointer</link> user_data);
195
 
&quot;<link linkend="MgServer-data-update-finished">data-update-finished</link>&quot;
196
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
197
 
                                            <link linkend="gpointer">gpointer</link> user_data);
198
 
&quot;<link linkend="MgServer-data-update-started">data-update-started</link>&quot;
199
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
200
 
                                            <link linkend="gpointer">gpointer</link> user_data);
201
 
&quot;<link linkend="MgServer-object-handler-updated">object-handler-updated</link>&quot;
202
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
203
 
                                            <link linkend="gpointer">gpointer</link> user_data);
204
 
&quot;<link linkend="MgServer-update-progress">update-progress</link>&quot;
205
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgServer">MgServer</link> *mgserver,
206
 
                                            <link linkend="gpointer">gpointer</link> arg1,
207
 
                                            <link linkend="guint">guint</link> arg2,
208
 
                                            <link linkend="guint">guint</link> arg3,
209
 
                                            <link linkend="gpointer">gpointer</link> user_data);
210
 
</synopsis>
211
 
</refsect1>
212
 
 
213
 
 
214
 
<refsect1>
215
 
<title>Description</title>
216
 
<para>
217
 
This object is the "access point" to the DBMS. It manages lists of the DBMS's attributes (such as
218
 
the available data types, function, ...) and is responsible for opening and closing the connection
219
 
to the DBMS. Also any query sent to the DBMS is done through this object.
220
 
</para>
221
 
<para>
222
 
This object is also responsible for the conversion of data types (data types defined within the database and
223
 
data types known to the Libgda library), and for providing the <link linkend="MgDataHandler"><type>MgDataHandler</type></link> objects to manipulate data of
224
 
each data type.
225
 
</para>
226
 
<para>
227
 
It implements the <link linkend="MgXmlStorage"><type>MgXmlStorage</type></link> interface.
228
 
</para>
229
 
</refsect1>
230
 
 
231
 
<refsect1>
232
 
<title>Details</title>
233
 
<refsect2>
234
 
<title><anchor id="MgServer-struct"/>struct MgServer</title>
235
 
<indexterm><primary>MgServer</primary></indexterm><programlisting>struct MgServer;</programlisting>
236
 
<para>
237
 
 
238
 
</para></refsect2>
239
 
<refsect2>
240
 
<title><anchor id="MgServerQueryType"/>enum MgServerQueryType</title>
241
 
<indexterm><primary>MgServerQueryType</primary></indexterm><programlisting>typedef enum {
242
 
        MG_SERVER_QUERY_SQL,
243
 
        MG_SERVER_QUERY_XML
244
 
} MgServerQueryType;
245
 
</programlisting>
246
 
<para>
247
 
Used to specify which type of query is sent to the DBMS. See the libgda documentation about what XML
248
 
queries are.
249
 
</para></refsect2>
250
 
<refsect2>
251
 
<title><anchor id="mg-server-get-type"/>mg_server_get_type ()</title>
252
 
<indexterm><primary>mg_server_get_type</primary></indexterm><programlisting><link linkend="guint">guint</link>       mg_server_get_type              (void);</programlisting>
253
 
<para>
254
 
 
255
 
</para><variablelist role="params">
256
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
257
 
 
258
 
 
259
 
</simpara></listitem></varlistentry>
260
 
</variablelist></refsect2>
261
 
<refsect2>
262
 
<title><anchor id="mg-server-new"/>mg_server_new ()</title>
263
 
<indexterm><primary>mg_server_new</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*    mg_server_new                   (<link linkend="MgConf">MgConf</link> *conf);</programlisting>
264
 
<para>
265
 
Creates a new MgServer object</para>
266
 
<para>
267
 
 
268
 
</para><variablelist role="params">
269
 
<varlistentry><term><parameter>conf</parameter>&nbsp;:</term>
270
 
<listitem><simpara> a <link linkend="MgConf"><type>MgConf</type></link> object
271
 
</simpara></listitem></varlistentry>
272
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new object
273
 
</simpara></listitem></varlistentry>
274
 
</variablelist></refsect2>
275
 
<refsect2>
276
 
<title><anchor id="mg-server-set-datasource"/>mg_server_set_datasource ()</title>
277
 
<indexterm><primary>mg_server_set_datasource</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    mg_server_set_datasource        (<link linkend="MgServer">MgServer</link> *srv,
278
 
                                             const <link linkend="gchar">gchar</link> *datasource);</programlisting>
279
 
<para>
280
 
Sets the data source of the server. If the connection is already opened,
281
 
then no action is performed at all and FALSE is returned.</para>
282
 
<para>
283
 
 
284
 
</para><variablelist role="params">
285
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
286
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
287
 
</simpara></listitem></varlistentry>
288
 
<varlistentry><term><parameter>datasource</parameter>&nbsp;:</term>
289
 
<listitem><simpara> a gda datasource
290
 
</simpara></listitem></varlistentry>
291
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success
292
 
</simpara></listitem></varlistentry>
293
 
</variablelist></refsect2>
294
 
<refsect2>
295
 
<title><anchor id="mg-server-get-datasource"/>mg_server_get_datasource ()</title>
296
 
<indexterm><primary>mg_server_get_datasource</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      mg_server_get_datasource        (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
297
 
<para>
298
 
Get the data source of the server.</para>
299
 
<para>
300
 
 
301
 
</para><variablelist role="params">
302
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
303
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
304
 
</simpara></listitem></varlistentry>
305
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new string with the datasource, or NULL
306
 
</simpara></listitem></varlistentry>
307
 
</variablelist></refsect2>
308
 
<refsect2>
309
 
<title><anchor id="mg-server-set-user-name"/>mg_server_set_user_name ()</title>
310
 
<indexterm><primary>mg_server_set_user_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    mg_server_set_user_name         (<link linkend="MgServer">MgServer</link> *srv,
311
 
                                             const <link linkend="gchar">gchar</link> *username);</programlisting>
312
 
<para>
313
 
Sets the user name for the connection to the server. If the connection is already opened,
314
 
then no action is performed at all and FALSE is returned.</para>
315
 
<para>
316
 
 
317
 
</para><variablelist role="params">
318
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
319
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
320
 
</simpara></listitem></varlistentry>
321
 
<varlistentry><term><parameter>username</parameter>&nbsp;:</term>
322
 
<listitem><simpara> 
323
 
</simpara></listitem></varlistentry>
324
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success
325
 
</simpara></listitem></varlistentry>
326
 
</variablelist></refsect2>
327
 
<refsect2>
328
 
<title><anchor id="mg-server-get-user-name"/>mg_server_get_user_name ()</title>
329
 
<indexterm><primary>mg_server_get_user_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      mg_server_get_user_name         (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
330
 
<para>
331
 
Get the user name for the connection to the server.</para>
332
 
<para>
333
 
 
334
 
</para><variablelist role="params">
335
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
336
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
337
 
</simpara></listitem></varlistentry>
338
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new string with the user name, or NULL
339
 
</simpara></listitem></varlistentry>
340
 
</variablelist></refsect2>
341
 
<refsect2>
342
 
<title><anchor id="mg-server-set-user-password"/>mg_server_set_user_password ()</title>
343
 
<indexterm><primary>mg_server_set_user_password</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    mg_server_set_user_password     (<link linkend="MgServer">MgServer</link> *srv,
344
 
                                             const <link linkend="gchar">gchar</link> *password);</programlisting>
345
 
<para>
346
 
Sets the user password for the connection to the server. If the connection is already opened,
347
 
then no action is performed at all and FALSE is returned.</para>
348
 
<para>
349
 
 
350
 
</para><variablelist role="params">
351
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
352
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
353
 
</simpara></listitem></varlistentry>
354
 
<varlistentry><term><parameter>password</parameter>&nbsp;:</term>
355
 
<listitem><simpara> 
356
 
</simpara></listitem></varlistentry>
357
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success
358
 
</simpara></listitem></varlistentry>
359
 
</variablelist></refsect2>
360
 
<refsect2>
361
 
<title><anchor id="mg-server-reset"/>mg_server_reset ()</title>
362
 
<indexterm><primary>mg_server_reset</primary></indexterm><programlisting><link linkend="void">void</link>        mg_server_reset                 (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
363
 
<para>
364
 
Reset the MgServer as it was when created; that is: close the connection if opened,
365
 
and get rid of any data type, function and aggregate it has.</para>
366
 
<para>
367
 
 
368
 
</para><variablelist role="params">
369
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
370
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
371
 
</simpara></listitem></varlistentry>
372
 
</variablelist></refsect2>
373
 
<refsect2>
374
 
<title><anchor id="mg-server-get-gda-connection"/>mg_server_get_gda_connection ()</title>
375
 
<indexterm><primary>mg_server_get_gda_connection</primary></indexterm><programlisting><link linkend="GdaConnection">GdaConnection</link>* mg_server_get_gda_connection (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
376
 
<para>
377
 
Get the <link linkend="GdaConnection"><type>GdaConnection</type></link> object used by <parameter>srv</parameter>, if the connection
378
 
is opened.</para>
379
 
<para>
380
 
 
381
 
</para><variablelist role="params">
382
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
383
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
384
 
</simpara></listitem></varlistentry>
385
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="GdaConnection"><type>GdaConnection</type></link>, or <literal>NULL</literal>
386
 
</simpara></listitem></varlistentry>
387
 
</variablelist></refsect2>
388
 
<refsect2>
389
 
<title><anchor id="mg-server-open-connect"/>mg_server_open_connect ()</title>
390
 
<indexterm><primary>mg_server_open_connect</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    mg_server_open_connect          (<link linkend="MgServer">MgServer</link> *srv,
391
 
                                             <link linkend="GError">GError</link> **error);</programlisting>
392
 
<para>
393
 
Opens the connection to the DBMS.</para>
394
 
<para>
395
 
 
396
 
</para><variablelist role="params">
397
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
398
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
399
 
</simpara></listitem></varlistentry>
400
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
401
 
<listitem><simpara> location to store error, or <literal>NULL</literal>
402
 
</simpara></listitem></varlistentry>
403
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if success and FALSE otherwise (and error is positionned)
404
 
</simpara></listitem></varlistentry>
405
 
</variablelist></refsect2>
406
 
<refsect2>
407
 
<title><anchor id="mg-server-conn-is-opened"/>mg_server_conn_is_opened ()</title>
408
 
<indexterm><primary>mg_server_conn_is_opened</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    mg_server_conn_is_opened        (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
409
 
<para>
410
 
Checks wether the connection to the DBMS is opened or not</para>
411
 
<para>
412
 
 
413
 
</para><variablelist role="params">
414
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
415
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
416
 
</simpara></listitem></varlistentry>
417
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the connection is opened
418
 
</simpara></listitem></varlistentry>
419
 
</variablelist></refsect2>
420
 
<refsect2>
421
 
<title><anchor id="mg-server-close-connect"/>mg_server_close_connect ()</title>
422
 
<indexterm><primary>mg_server_close_connect</primary></indexterm><programlisting><link linkend="void">void</link>        mg_server_close_connect         (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
423
 
<para>
424
 
Closes the connection to the DBMS. First the "conn_to_close" signal is emitted.
425
 
This function should preferably be called instead of the <link linkend="mg-server-close-connect-no-warn"><function>mg_server_close_connect_no_warn()</function></link> function.</para>
426
 
<para>
427
 
 
428
 
</para><variablelist role="params">
429
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
430
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
431
 
</simpara></listitem></varlistentry>
432
 
</variablelist></refsect2>
433
 
<refsect2>
434
 
<title><anchor id="mg-server-close-connect-no-warn"/>mg_server_close_connect_no_warn ()</title>
435
 
<indexterm><primary>mg_server_close_connect_no_warn</primary></indexterm><programlisting><link linkend="void">void</link>        mg_server_close_connect_no_warn (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
436
 
<para>
437
 
Closes the connection to the DBMS. Warning: "conn_to_close" signal is NOT emitted.</para>
438
 
<para>
439
 
 
440
 
</para><variablelist role="params">
441
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
442
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
443
 
</simpara></listitem></varlistentry>
444
 
</variablelist></refsect2>
445
 
<refsect2>
446
 
<title><anchor id="mg-server-get-conf"/>mg_server_get_conf ()</title>
447
 
<indexterm><primary>mg_server_get_conf</primary></indexterm><programlisting><link linkend="MgConf">MgConf</link>*     mg_server_get_conf              (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
448
 
<para>
449
 
Fetch the MgConf object to which the MgServer belongs.</para>
450
 
<para>
451
 
 
452
 
</para><variablelist role="params">
453
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
454
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
455
 
</simpara></listitem></varlistentry>
456
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the MgConf object
457
 
</simpara></listitem></varlistentry>
458
 
</variablelist></refsect2>
459
 
<refsect2>
460
 
<title><anchor id="mg-server-get-sql-op-mode"/>mg_server_get_sql_op_mode ()</title>
461
 
<indexterm><primary>mg_server_get_sql_op_mode</primary></indexterm><programlisting><link linkend="MgServerOpMode">MgServerOpMode</link> mg_server_get_sql_op_mode    (<link linkend="MgServer">MgServer</link> *srv,
462
 
                                             const <link linkend="gchar">gchar</link> *query);</programlisting>
463
 
<para>
464
 
Get the operation type (= mode) which is performed by the query given as argument.
465
 
The query MUST contain only one statement, not several separated by ';'</para>
466
 
<para>
467
 
 
468
 
</para><variablelist role="params">
469
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
470
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
471
 
</simpara></listitem></varlistentry>
472
 
<varlistentry><term><parameter>query</parameter>&nbsp;:</term>
473
 
<listitem><simpara> an SQL query
474
 
</simpara></listitem></varlistentry>
475
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the query type (mode).
476
 
</simpara></listitem></varlistentry>
477
 
</variablelist></refsect2>
478
 
<refsect2>
479
 
<title><anchor id="mg-server-do-query"/>mg_server_do_query ()</title>
480
 
<indexterm><primary>mg_server_do_query</primary></indexterm><programlisting><link linkend="MgResultSet">MgResultSet</link>* mg_server_do_query             (<link linkend="MgServer">MgServer</link> *srv,
481
 
                                             const <link linkend="gchar">gchar</link> *query,
482
 
                                             <link linkend="MgServerQueryType">MgServerQueryType</link> type,
483
 
                                             <link linkend="GError">GError</link> **error);</programlisting>
484
 
<para>
485
 
Sends a query to the DBMS to which the connection is established. If the query is a SELECT
486
 
one, then a new <link linkend="MgResultSet"><type>MgResultSet</type></link> is returned (it's up to the caller to unref that object); 
487
 
otherwise NULL is returned. The error variable contains the error code if an error occurred.</para>
488
 
<para>
489
 
 
490
 
</para><variablelist role="params">
491
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
492
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
493
 
</simpara></listitem></varlistentry>
494
 
<varlistentry><term><parameter>query</parameter>&nbsp;:</term>
495
 
<listitem><simpara> the query to be executed
496
 
</simpara></listitem></varlistentry>
497
 
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
498
 
<listitem><simpara> the query type (SQL or XML)
499
 
</simpara></listitem></varlistentry>
500
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
501
 
<listitem><simpara> location to store error, or <literal>NULL</literal>
502
 
</simpara></listitem></varlistentry>
503
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="MgResultSet"><type>MgResultSet</type></link> object or NULL
504
 
</simpara></listitem></varlistentry>
505
 
</variablelist></refsect2>
506
 
<refsect2>
507
 
<title><anchor id="mg-server-update-dbms-data"/>mg_server_update_dbms_data ()</title>
508
 
<indexterm><primary>mg_server_update_dbms_data</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    mg_server_update_dbms_data      (<link linkend="MgServer">MgServer</link> *srv,
509
 
                                             <link linkend="GError">GError</link> **error);</programlisting>
510
 
<para>
511
 
Synchronise the list of data types, functions, etc the MgServer object has
512
 
with what is in the DBMS the connection is opened to. The connection to the DBMS 
513
 
MUST be opened.</para>
514
 
<para>
515
 
 
516
 
</para><variablelist role="params">
517
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
518
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
519
 
</simpara></listitem></varlistentry>
520
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
521
 
<listitem><simpara> location to store error, or <literal>NULL</literal>
522
 
</simpara></listitem></varlistentry>
523
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if no error
524
 
</simpara></listitem></varlistentry>
525
 
</variablelist></refsect2>
526
 
<refsect2>
527
 
<title><anchor id="mg-server-stop-update-dbms-data"/>mg_server_stop_update_dbms_data ()</title>
528
 
<indexterm><primary>mg_server_stop_update_dbms_data</primary></indexterm><programlisting><link linkend="void">void</link>        mg_server_stop_update_dbms_data (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
529
 
<para>
530
 
When the server updates its internal lists of DBMS objects, a call to this function will 
531
 
stop that update process. It has no effect when the server is not updating its DBMS data.</para>
532
 
<para>
533
 
 
534
 
</para><variablelist role="params">
535
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
536
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
537
 
</simpara></listitem></varlistentry>
538
 
</variablelist></refsect2>
539
 
<refsect2>
540
 
<title><anchor id="mg-server-get-handler-by-name"/>mg_server_get_handler_by_name ()</title>
541
 
<indexterm><primary>mg_server_get_handler_by_name</primary></indexterm><programlisting><link linkend="MgDataHandler">MgDataHandler</link>* mg_server_get_handler_by_name
542
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
543
 
                                             const <link linkend="gchar">gchar</link> *name);</programlisting>
544
 
<para>
545
 
Get the MgDataHandler from its name.</para>
546
 
<para>
547
 
 
548
 
</para><variablelist role="params">
549
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
550
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
551
 
</simpara></listitem></varlistentry>
552
 
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
553
 
<listitem><simpara> 
554
 
</simpara></listitem></varlistentry>
555
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the MgDataHandler object
556
 
</simpara></listitem></varlistentry>
557
 
</variablelist></refsect2>
558
 
<refsect2>
559
 
<title><anchor id="mg-server-get-handler-by-type"/>mg_server_get_handler_by_type ()</title>
560
 
<indexterm><primary>mg_server_get_handler_by_type</primary></indexterm><programlisting><link linkend="MgDataHandler">MgDataHandler</link>* mg_server_get_handler_by_type
561
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
562
 
                                             <link linkend="MgServerDataType">MgServerDataType</link> *type);</programlisting>
563
 
<para>
564
 
Get the MgDataHandler for a data type</para>
565
 
<para>
566
 
 
567
 
</para><variablelist role="params">
568
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
569
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
570
 
</simpara></listitem></varlistentry>
571
 
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
572
 
<listitem><simpara> 
573
 
</simpara></listitem></varlistentry>
574
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the MgDataHandler object
575
 
</simpara></listitem></varlistentry>
576
 
</variablelist></refsect2>
577
 
<refsect2>
578
 
<title><anchor id="mg-server-get-handler-by-gda"/>mg_server_get_handler_by_gda ()</title>
579
 
<indexterm><primary>mg_server_get_handler_by_gda</primary></indexterm><programlisting><link linkend="MgDataHandler">MgDataHandler</link>* mg_server_get_handler_by_gda (<link linkend="MgServer">MgServer</link> *srv,
580
 
                                             <link linkend="GdaValueType">GdaValueType</link> gda_type);</programlisting>
581
 
<para>
582
 
Get the MgDataHandler for a gda type: the first DataHandler which can handle
583
 
the requested type is returned.  If no good handler can be found, then a default
584
 
one will be provided. This function never returns NULL.</para>
585
 
<para>
586
 
 
587
 
</para><variablelist role="params">
588
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
589
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
590
 
</simpara></listitem></varlistentry>
591
 
<varlistentry><term><parameter>gda_type</parameter>&nbsp;:</term>
592
 
<listitem><simpara> 
593
 
</simpara></listitem></varlistentry>
594
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the MgDataHandler object
595
 
</simpara></listitem></varlistentry>
596
 
</variablelist></refsect2>
597
 
<refsect2>
598
 
<title><anchor id="mg-server-get-plugin-handlers"/>mg_server_get_plugin_handlers ()</title>
599
 
<indexterm><primary>mg_server_get_plugin_handlers</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*     mg_server_get_plugin_handlers   (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
600
 
<para>
601
 
Get a list of all the MgDataHandler plugins used by the MgServer.</para>
602
 
<para>
603
 
 
604
 
</para><variablelist role="params">
605
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
606
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
607
 
</simpara></listitem></varlistentry>
608
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an allocated list of plugins
609
 
</simpara></listitem></varlistentry>
610
 
</variablelist></refsect2>
611
 
<refsect2>
612
 
<title><anchor id="mg-server-get-user-by-name"/>mg_server_get_user_by_name ()</title>
613
 
<indexterm><primary>mg_server_get_user_by_name</primary></indexterm><programlisting><link linkend="MgUser">MgUser</link>*     mg_server_get_user_by_name      (<link linkend="MgServer">MgServer</link> *srv,
614
 
                                             const <link linkend="gchar">gchar</link> *username);</programlisting>
615
 
<para>
616
 
Find a MgUser from its name.</para>
617
 
<para>
618
 
 
619
 
</para><variablelist role="params">
620
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
621
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
622
 
</simpara></listitem></varlistentry>
623
 
<varlistentry><term><parameter>username</parameter>&nbsp;:</term>
624
 
<listitem><simpara> 
625
 
</simpara></listitem></varlistentry>
626
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a pointer to the requested object, or NULL if the object cannot be found.
627
 
</simpara></listitem></varlistentry>
628
 
</variablelist></refsect2>
629
 
<refsect2>
630
 
<title><anchor id="mg-server-get-data-types"/>mg_server_get_data_types ()</title>
631
 
<indexterm><primary>mg_server_get_data_types</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*     mg_server_get_data_types        (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
632
 
<para>
633
 
Get the list of data types;</para>
634
 
<para>
635
 
 
636
 
</para><variablelist role="params">
637
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
638
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
639
 
</simpara></listitem></varlistentry>
640
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the list (the caller must free the list after usage)
641
 
</simpara></listitem></varlistentry>
642
 
</variablelist></refsect2>
643
 
<refsect2>
644
 
<title><anchor id="mg-server-get-data-type-by-name"/>mg_server_get_data_type_by_name ()</title>
645
 
<indexterm><primary>mg_server_get_data_type_by_name</primary></indexterm><programlisting><link linkend="MgServerDataType">MgServerDataType</link>* mg_server_get_data_type_by_name
646
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
647
 
                                             const <link linkend="gchar">gchar</link> *typename);</programlisting>
648
 
<para>
649
 
Find a data type from its DBMS name</para>
650
 
<para>
651
 
 
652
 
</para><variablelist role="params">
653
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
654
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
655
 
</simpara></listitem></varlistentry>
656
 
<varlistentry><term><parameter>typename</parameter>&nbsp;:</term>
657
 
<listitem><simpara> 
658
 
</simpara></listitem></varlistentry>
659
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the data type or <literal>NULL</literal> if it cannot be found
660
 
</simpara></listitem></varlistentry>
661
 
</variablelist></refsect2>
662
 
<refsect2>
663
 
<title><anchor id="mg-server-get-data-type-by-xml-id"/>mg_server_get_data_type_by_xml_id ()</title>
664
 
<indexterm><primary>mg_server_get_data_type_by_xml_id</primary></indexterm><programlisting><link linkend="MgServerDataType">MgServerDataType</link>* mg_server_get_data_type_by_xml_id
665
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
666
 
                                             const <link linkend="gchar">gchar</link> *xml_id);</programlisting>
667
 
<para>
668
 
To find a <link linkend="MgServerDataType"><type>MgServerDataType</type></link> using its XML id.</para>
669
 
<para>
670
 
 
671
 
</para><variablelist role="params">
672
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
673
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
674
 
</simpara></listitem></varlistentry>
675
 
<varlistentry><term><parameter>xml_id</parameter>&nbsp;:</term>
676
 
<listitem><simpara> the XML identifier of the data type to be found
677
 
</simpara></listitem></varlistentry>
678
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the data type or <literal>NULL</literal> if it cannot be found
679
 
</simpara></listitem></varlistentry>
680
 
</variablelist></refsect2>
681
 
<refsect2>
682
 
<title><anchor id="mg-server-get-functions"/>mg_server_get_functions ()</title>
683
 
<indexterm><primary>mg_server_get_functions</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*     mg_server_get_functions         (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
684
 
<para>
685
 
To get the complete list of functions</para>
686
 
<para>
687
 
 
688
 
</para><variablelist role="params">
689
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
690
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
691
 
</simpara></listitem></varlistentry>
692
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the allocated list of functions
693
 
</simpara></listitem></varlistentry>
694
 
</variablelist></refsect2>
695
 
<refsect2>
696
 
<title><anchor id="mg-server-get-functions-by-name"/>mg_server_get_functions_by_name ()</title>
697
 
<indexterm><primary>mg_server_get_functions_by_name</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*     mg_server_get_functions_by_name (<link linkend="MgServer">MgServer</link> *srv,
698
 
                                             const <link linkend="gchar">gchar</link> *funcname);</programlisting>
699
 
<para>
700
 
To get the list of DBMS functions which match the given name.</para>
701
 
<para>
702
 
 
703
 
</para><variablelist role="params">
704
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
705
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
706
 
</simpara></listitem></varlistentry>
707
 
<varlistentry><term><parameter>funcname</parameter>&nbsp;:</term>
708
 
<listitem><simpara> name of the function
709
 
</simpara></listitem></varlistentry>
710
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the allocated list of functions
711
 
</simpara></listitem></varlistentry>
712
 
</variablelist></refsect2>
713
 
<refsect2>
714
 
<title><anchor id="mg-server-get-function-by-name-arg"/>mg_server_get_function_by_name_arg ()</title>
715
 
<indexterm><primary>mg_server_get_function_by_name_arg</primary></indexterm><programlisting><link linkend="MgServerFunction">MgServerFunction</link>* mg_server_get_function_by_name_arg
716
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
717
 
                                             const <link linkend="gchar">gchar</link> *funcname,
718
 
                                             const <link linkend="GSList">GSList</link> *argtypes);</programlisting>
719
 
<para>
720
 
To find a DBMS functions which is uniquely identified by its name and the type(s)
721
 
of its argument(s).</para>
722
 
<para>
723
 
 
724
 
</para><variablelist role="params">
725
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
726
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
727
 
</simpara></listitem></varlistentry>
728
 
<varlistentry><term><parameter>funcname</parameter>&nbsp;:</term>
729
 
<listitem><simpara> name of the function
730
 
</simpara></listitem></varlistentry>
731
 
<varlistentry><term><parameter>argtypes</parameter>&nbsp;:</term>
732
 
<listitem><simpara> a list of <link linkend="MgServerDataType"><type>MgServerDataType</type></link> objects
733
 
</simpara></listitem></varlistentry>
734
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The function or NULL if not found
735
 
</simpara></listitem></varlistentry>
736
 
</variablelist></refsect2>
737
 
<refsect2>
738
 
<title><anchor id="mg-server-get-function-by-dbms-id"/>mg_server_get_function_by_dbms_id ()</title>
739
 
<indexterm><primary>mg_server_get_function_by_dbms_id</primary></indexterm><programlisting><link linkend="MgServerFunction">MgServerFunction</link>* mg_server_get_function_by_dbms_id
740
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
741
 
                                             const <link linkend="gchar">gchar</link> *dbms_id);</programlisting>
742
 
<para>
743
 
To find a DBMS functions which is uniquely identified by its DBMS identifier</para>
744
 
<para>
745
 
 
746
 
</para><variablelist role="params">
747
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
748
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
749
 
</simpara></listitem></varlistentry>
750
 
<varlistentry><term><parameter>dbms_id</parameter>&nbsp;:</term>
751
 
<listitem><simpara> 
752
 
</simpara></listitem></varlistentry>
753
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The function or NULL if not found
754
 
</simpara></listitem></varlistentry>
755
 
</variablelist></refsect2>
756
 
<refsect2>
757
 
<title><anchor id="mg-server-get-function-by-xml-id"/>mg_server_get_function_by_xml_id ()</title>
758
 
<indexterm><primary>mg_server_get_function_by_xml_id</primary></indexterm><programlisting><link linkend="MgServerFunction">MgServerFunction</link>* mg_server_get_function_by_xml_id
759
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
760
 
                                             const <link linkend="gchar">gchar</link> *xml_id);</programlisting>
761
 
<para>
762
 
To find a DBMS functions which is uniquely identified by its XML identifier</para>
763
 
<para>
764
 
 
765
 
</para><variablelist role="params">
766
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
767
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
768
 
</simpara></listitem></varlistentry>
769
 
<varlistentry><term><parameter>xml_id</parameter>&nbsp;:</term>
770
 
<listitem><simpara> 
771
 
</simpara></listitem></varlistentry>
772
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The function or NULL if not found
773
 
</simpara></listitem></varlistentry>
774
 
</variablelist></refsect2>
775
 
<refsect2>
776
 
<title><anchor id="mg-server-get-aggregates"/>mg_server_get_aggregates ()</title>
777
 
<indexterm><primary>mg_server_get_aggregates</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*     mg_server_get_aggregates        (<link linkend="MgServer">MgServer</link> *srv);</programlisting>
778
 
<para>
779
 
To get the complete list of aggregates</para>
780
 
<para>
781
 
 
782
 
</para><variablelist role="params">
783
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
784
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
785
 
</simpara></listitem></varlistentry>
786
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the allocated list of aggregates
787
 
</simpara></listitem></varlistentry>
788
 
</variablelist></refsect2>
789
 
<refsect2>
790
 
<title><anchor id="mg-server-get-aggregates-by-name"/>mg_server_get_aggregates_by_name ()</title>
791
 
<indexterm><primary>mg_server_get_aggregates_by_name</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*     mg_server_get_aggregates_by_name
792
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
793
 
                                             const <link linkend="gchar">gchar</link> *aggname);</programlisting>
794
 
<para>
795
 
To get the list of DBMS aggregates which match the given name.</para>
796
 
<para>
797
 
 
798
 
</para><variablelist role="params">
799
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
800
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
801
 
</simpara></listitem></varlistentry>
802
 
<varlistentry><term><parameter>aggname</parameter>&nbsp;:</term>
803
 
<listitem><simpara> the name of the aggregate
804
 
</simpara></listitem></varlistentry>
805
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the allocated list of aggregates
806
 
</simpara></listitem></varlistentry>
807
 
</variablelist></refsect2>
808
 
<refsect2>
809
 
<title><anchor id="mg-server-get-aggregate-by-name-arg"/>mg_server_get_aggregate_by_name_arg ()</title>
810
 
<indexterm><primary>mg_server_get_aggregate_by_name_arg</primary></indexterm><programlisting><link linkend="MgServerAggregate">MgServerAggregate</link>* mg_server_get_aggregate_by_name_arg
811
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
812
 
                                             const <link linkend="gchar">gchar</link> *aggname,
813
 
                                             <link linkend="MgServerDataType">MgServerDataType</link> *argtype);</programlisting>
814
 
<para>
815
 
To find a DBMS functions which is uniquely identified by its name and the type
816
 
of its argument.</para>
817
 
<para>
818
 
 
819
 
</para><variablelist role="params">
820
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
821
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
822
 
</simpara></listitem></varlistentry>
823
 
<varlistentry><term><parameter>aggname</parameter>&nbsp;:</term>
824
 
<listitem><simpara> the name of the aggregate
825
 
</simpara></listitem></varlistentry>
826
 
<varlistentry><term><parameter>argtype</parameter>&nbsp;:</term>
827
 
<listitem><simpara> the type of argument or <literal>NULL</literal>
828
 
</simpara></listitem></varlistentry>
829
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The aggregate or NULL if not found
830
 
</simpara></listitem></varlistentry>
831
 
</variablelist></refsect2>
832
 
<refsect2>
833
 
<title><anchor id="mg-server-get-aggregate-by-dbms-id"/>mg_server_get_aggregate_by_dbms_id ()</title>
834
 
<indexterm><primary>mg_server_get_aggregate_by_dbms_id</primary></indexterm><programlisting><link linkend="MgServerAggregate">MgServerAggregate</link>* mg_server_get_aggregate_by_dbms_id
835
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
836
 
                                             const <link linkend="gchar">gchar</link> *dbms_id);</programlisting>
837
 
<para>
838
 
To find a DBMS functions which is uniquely identified by its name and the type
839
 
of its argument.</para>
840
 
<para>
841
 
 
842
 
</para><variablelist role="params">
843
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
844
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
845
 
</simpara></listitem></varlistentry>
846
 
<varlistentry><term><parameter>dbms_id</parameter>&nbsp;:</term>
847
 
<listitem><simpara> 
848
 
</simpara></listitem></varlistentry>
849
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The aggregate or NULL if not found
850
 
</simpara></listitem></varlistentry>
851
 
</variablelist></refsect2>
852
 
<refsect2>
853
 
<title><anchor id="mg-server-get-aggregate-by-xml-id"/>mg_server_get_aggregate_by_xml_id ()</title>
854
 
<indexterm><primary>mg_server_get_aggregate_by_xml_id</primary></indexterm><programlisting><link linkend="MgServerAggregate">MgServerAggregate</link>* mg_server_get_aggregate_by_xml_id
855
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
856
 
                                             const <link linkend="gchar">gchar</link> *xml_id);</programlisting>
857
 
<para>
858
 
To find a DBMS aggregates which is uniquely identified by its XML identifier</para>
859
 
<para>
860
 
 
861
 
</para><variablelist role="params">
862
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
863
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
864
 
</simpara></listitem></varlistentry>
865
 
<varlistentry><term><parameter>xml_id</parameter>&nbsp;:</term>
866
 
<listitem><simpara> 
867
 
</simpara></listitem></varlistentry>
868
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The aggregate or NULL if not found
869
 
</simpara></listitem></varlistentry>
870
 
</variablelist></refsect2>
871
 
<refsect2>
872
 
<title><anchor id="mg-server-get-object-handler"/>mg_server_get_object_handler ()</title>
873
 
<indexterm><primary>mg_server_get_object_handler</primary></indexterm><programlisting><link linkend="MgDataHandler">MgDataHandler</link>* mg_server_get_object_handler (<link linkend="MgServer">MgServer</link> *srv,
874
 
                                             <link linkend="GObject">GObject</link> *object);</programlisting>
875
 
<para>
876
 
Get the right MgDataHandler object reference to manage data which is
877
 
"linked" to the object. The object will usually be a MgServerDataType, 
878
 
a MgServerFunction, or a MgServerAggregate.
879
 
</para>
880
 
<para>
881
 
The returned MgDataHandler depends on the loaded plugins and on the user
882
 
preferences regarding how these plugins are to be used. If the user has not
883
 
set any preference for the object, then some default rules are used:
884
 
<ul>
885
 
<li> for MgServerDataType, the MgDataHandler corresponding to the gda type
886
 
   of the MgServerDataType is returned</li></ul>
887
 
-> for MgServerFunction, the MgDataHandler corresponding to the MgServerDataType
888
 
   returned by the function is returned
889
 
-> ...</para>
890
 
<para>
891
 
 
892
 
</para><variablelist role="params">
893
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
894
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
895
 
</simpara></listitem></varlistentry>
896
 
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
897
 
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> object
898
 
</simpara></listitem></varlistentry>
899
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the MgDataHandler associated to the given object, NEVER returns NULL.
900
 
</simpara></listitem></varlistentry>
901
 
</variablelist></refsect2>
902
 
<refsect2>
903
 
<title><anchor id="mg-server-set-object-handler"/>mg_server_set_object_handler ()</title>
904
 
<indexterm><primary>mg_server_set_object_handler</primary></indexterm><programlisting><link linkend="void">void</link>        mg_server_set_object_handler    (<link linkend="MgServer">MgServer</link> *srv,
905
 
                                             <link linkend="GObject">GObject</link> *object,
906
 
                                             <link linkend="MgDataHandler">MgDataHandler</link> *handler);</programlisting>
907
 
<para>
908
 
This function is the opposite of the <link linkend="mg-server-get-object-handler"><function>mg_server_get_object_handler()</function></link> function:
909
 
it "attaches" a MgDataHandler object to any given object, and a subsequent call
910
 
to mg_server_get_object_handler(object) will return the MgDataHandler object.</para>
911
 
<para>
912
 
 
913
 
</para><variablelist role="params">
914
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
915
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
916
 
</simpara></listitem></varlistentry>
917
 
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
918
 
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link>
919
 
</simpara></listitem></varlistentry>
920
 
<varlistentry><term><parameter>handler</parameter>&nbsp;:</term>
921
 
<listitem><simpara> 
922
 
</simpara></listitem></varlistentry>
923
 
</variablelist></refsect2>
924
 
<refsect2>
925
 
<title><anchor id="mg-server-unset-object-handler"/>mg_server_unset_object_handler ()</title>
926
 
<indexterm><primary>mg_server_unset_object_handler</primary></indexterm><programlisting><link linkend="void">void</link>        mg_server_unset_object_handler  (<link linkend="MgServer">MgServer</link> *srv,
927
 
                                             <link linkend="GObject">GObject</link> *object);</programlisting>
928
 
<para>
929
 
Shortcut to <link linkend="mg-server-set-object-handler"><function>mg_server_set_object_handler()</function></link> with NULL as "handler" argument.</para>
930
 
<para>
931
 
 
932
 
</para><variablelist role="params">
933
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
934
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
935
 
</simpara></listitem></varlistentry>
936
 
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
937
 
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link>
938
 
</simpara></listitem></varlistentry>
939
 
</variablelist></refsect2>
940
 
<refsect2>
941
 
<title><anchor id="mg-server-object-has-handler"/>mg_server_object_has_handler ()</title>
942
 
<indexterm><primary>mg_server_object_has_handler</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    mg_server_object_has_handler    (<link linkend="MgServer">MgServer</link> *srv,
943
 
                                             <link linkend="GObject">GObject</link> *object);</programlisting>
944
 
<para>
945
 
Tells if a MgDataHandler object has been assigned to the object given as argument, or
946
 
if the MgDataHandler which would be returned by the <link linkend="mg-server-get-object-handler"><function>mg_server_get_object_handler()</function></link>
947
 
function is a default one.</para>
948
 
<para>
949
 
 
950
 
</para><variablelist role="params">
951
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
952
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
953
 
</simpara></listitem></varlistentry>
954
 
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
955
 
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link>
956
 
</simpara></listitem></varlistentry>
957
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if a MgDataHandler object has been assigned to the object.
958
 
</simpara></listitem></varlistentry>
959
 
</variablelist></refsect2>
960
 
<refsect2>
961
 
<title><anchor id="mg-server-set-object-func-handler"/>mg_server_set_object_func_handler ()</title>
962
 
<indexterm><primary>mg_server_set_object_func_handler</primary></indexterm><programlisting><link linkend="void">void</link>        mg_server_set_object_func_handler
963
 
                                            (<link linkend="MgServer">MgServer</link> *srv,
964
 
                                             <link linkend="MgDataHandler">MgDataHandler</link>* (*func) (MgServer *, GObject *));</programlisting>
965
 
<para>
966
 
This function provides a way for the MgServer function to apply rules to
967
 
find an appropriate MgDataHandler for an object.</para>
968
 
<para>
969
 
 
970
 
</para><variablelist role="params">
971
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
972
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
973
 
</simpara></listitem></varlistentry>
974
 
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
975
 
<listitem><simpara> a function
976
 
</simpara></listitem></varlistentry>
977
 
</variablelist></refsect2>
978
 
<refsect2>
979
 
<title><anchor id="mg-server-stringify-value"/>mg_server_stringify_value ()</title>
980
 
<indexterm><primary>mg_server_stringify_value</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      mg_server_stringify_value       (<link linkend="MgServer">MgServer</link> *srv,
981
 
                                             const <link linkend="GdaValue">GdaValue</link> *value);</programlisting>
982
 
<para>
983
 
Renders a value as a string, and ensures the string is UTF-8 encoded.</para>
984
 
<para>
985
 
 
986
 
</para><variablelist role="params">
987
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
988
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
989
 
</simpara></listitem></varlistentry>
990
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
991
 
<listitem><simpara> a value to be stringified
992
 
</simpara></listitem></varlistentry>
993
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new string
994
 
</simpara></listitem></varlistentry>
995
 
</variablelist></refsect2>
996
 
<refsect2>
997
 
<title><anchor id="mg-server-escape-chars"/>mg_server_escape_chars ()</title>
998
 
<indexterm><primary>mg_server_escape_chars</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      mg_server_escape_chars          (<link linkend="MgServer">MgServer</link> *srv,
999
 
                                             const <link linkend="gchar">gchar</link> *string);</programlisting>
1000
 
<para>
1001
 
Escapes the special caracters from a string. The new string can then safely be sent
1002
 
to the DBMS.</para>
1003
 
<para>
1004
 
 
1005
 
</para><variablelist role="params">
1006
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
1007
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
1008
 
</simpara></listitem></varlistentry>
1009
 
<varlistentry><term><parameter>string</parameter>&nbsp;:</term>
1010
 
<listitem><simpara> 
1011
 
</simpara></listitem></varlistentry>
1012
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the escaped string
1013
 
</simpara></listitem></varlistentry>
1014
 
</variablelist></refsect2>
1015
 
<refsect2>
1016
 
<title><anchor id="mg-server-get-gda-schema"/>mg_server_get_gda_schema ()</title>
1017
 
<indexterm><primary>mg_server_get_gda_schema</primary></indexterm><programlisting><link linkend="GdaDataModel">GdaDataModel</link>* mg_server_get_gda_schema      (<link linkend="MgServer">MgServer</link> *srv,
1018
 
                                             <link linkend="GdaConnectionSchema">GdaConnectionSchema</link> schema,
1019
 
                                             <link linkend="GdaParameterList">GdaParameterList</link> *params);</programlisting>
1020
 
<para>
1021
 
Get a direct access to the libgda's function call to get a DBMS schema. It should not directely be used
1022
 
since libmergeant hides any necessary call to it.</para>
1023
 
<para>
1024
 
 
1025
 
</para><variablelist role="params">
1026
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
1027
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
1028
 
</simpara></listitem></varlistentry>
1029
 
<varlistentry><term><parameter>schema</parameter>&nbsp;:</term>
1030
 
<listitem><simpara> the requested schema
1031
 
</simpara></listitem></varlistentry>
1032
 
<varlistentry><term><parameter>params</parameter>&nbsp;:</term>
1033
 
<listitem><simpara> some parameters for the requested schema, or NULL
1034
 
</simpara></listitem></varlistentry>
1035
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the data model, or NULL if an error occurred
1036
 
</simpara></listitem></varlistentry>
1037
 
</variablelist></refsect2>
1038
 
<refsect2>
1039
 
<title><anchor id="mg-server-dump"/>mg_server_dump ()</title>
1040
 
<indexterm><primary>mg_server_dump</primary></indexterm><programlisting><link linkend="void">void</link>        mg_server_dump                  (<link linkend="MgServer">MgServer</link> *srv,
1041
 
                                             <link linkend="gint">gint</link> offset);</programlisting>
1042
 
<para>
1043
 
Writes a textual description of the object to STDOUT. This function only
1044
 
exists if libmergeant is compiled with the "--enable-debug" option.</para>
1045
 
<para>
1046
 
 
1047
 
</para><variablelist role="params">
1048
 
<varlistentry><term><parameter>srv</parameter>&nbsp;:</term>
1049
 
<listitem><simpara> a <link linkend="MgServer"><type>MgServer</type></link> object
1050
 
</simpara></listitem></varlistentry>
1051
 
<varlistentry><term><parameter>offset</parameter>&nbsp;:</term>
1052
 
<listitem><simpara> the offset (in caracters) at which the dump will start
1053
 
</simpara></listitem></varlistentry>
1054
 
</variablelist></refsect2>
1055
 
 
1056
 
</refsect1>
1057
 
<refsect1>
1058
 
<title>Properties</title>
1059
 
<variablelist>
1060
 
<varlistentry><term><anchor id="MgServer--with-functions"/>&quot;<literal>with-functions</literal>&quot; (<link linkend="gboolean">gboolean</link> : Read / Write)</term>
1061
 
<listitem>
1062
 
<para></para>
1063
 
</listitem></varlistentry>
1064
 
 
1065
 
</variablelist>
1066
 
</refsect1>
1067
 
 
1068
 
<refsect1>
1069
 
<title>Signals</title>
1070
 
<refsect2><title><anchor id="MgServer-conn-closed"/>The &quot;conn-closed&quot; signal</title>
1071
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1072
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1073
 
<para>
1074
 
 
1075
 
</para><variablelist role="params">
1076
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1077
 
<listitem><simpara>the object which received the signal.
1078
 
 
1079
 
</simpara></listitem></varlistentry>
1080
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1081
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1082
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-conn-opened"/>The &quot;conn-opened&quot; signal</title>
1083
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1084
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1085
 
<para>
1086
 
 
1087
 
</para><variablelist role="params">
1088
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1089
 
<listitem><simpara>the object which received the signal.
1090
 
 
1091
 
</simpara></listitem></varlistentry>
1092
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1093
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1094
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-conn-to-close"/>The &quot;conn-to-close&quot; signal</title>
1095
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1096
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1097
 
<para>
1098
 
 
1099
 
</para><variablelist role="params">
1100
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1101
 
<listitem><simpara>the object which received the signal.
1102
 
 
1103
 
</simpara></listitem></varlistentry>
1104
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1105
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1106
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-data-aggregate-added"/>The &quot;data-aggregate-added&quot; signal</title>
1107
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1108
 
                                            <link linkend="gpointer">gpointer</link> arg1,
1109
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1110
 
<para>
1111
 
 
1112
 
</para><variablelist role="params">
1113
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1114
 
<listitem><simpara>the object which received the signal.
1115
 
</simpara></listitem></varlistentry>
1116
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
1117
 
<listitem><simpara>
1118
 
 
1119
 
</simpara></listitem></varlistentry>
1120
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1121
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1122
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-data-aggregate-removed"/>The &quot;data-aggregate-removed&quot; signal</title>
1123
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1124
 
                                            <link linkend="gpointer">gpointer</link> arg1,
1125
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1126
 
<para>
1127
 
 
1128
 
</para><variablelist role="params">
1129
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1130
 
<listitem><simpara>the object which received the signal.
1131
 
</simpara></listitem></varlistentry>
1132
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
1133
 
<listitem><simpara>
1134
 
 
1135
 
</simpara></listitem></varlistentry>
1136
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1137
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1138
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-data-aggregate-updated"/>The &quot;data-aggregate-updated&quot; signal</title>
1139
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1140
 
                                            <link linkend="gpointer">gpointer</link> arg1,
1141
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1142
 
<para>
1143
 
 
1144
 
</para><variablelist role="params">
1145
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1146
 
<listitem><simpara>the object which received the signal.
1147
 
</simpara></listitem></varlistentry>
1148
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
1149
 
<listitem><simpara>
1150
 
 
1151
 
</simpara></listitem></varlistentry>
1152
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1153
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1154
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-data-function-added"/>The &quot;data-function-added&quot; signal</title>
1155
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1156
 
                                            <link linkend="gpointer">gpointer</link> arg1,
1157
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1158
 
<para>
1159
 
 
1160
 
</para><variablelist role="params">
1161
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1162
 
<listitem><simpara>the object which received the signal.
1163
 
</simpara></listitem></varlistentry>
1164
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
1165
 
<listitem><simpara>
1166
 
 
1167
 
</simpara></listitem></varlistentry>
1168
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1169
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1170
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-data-function-removed"/>The &quot;data-function-removed&quot; signal</title>
1171
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1172
 
                                            <link linkend="gpointer">gpointer</link> arg1,
1173
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1174
 
<para>
1175
 
 
1176
 
</para><variablelist role="params">
1177
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1178
 
<listitem><simpara>the object which received the signal.
1179
 
</simpara></listitem></varlistentry>
1180
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
1181
 
<listitem><simpara>
1182
 
 
1183
 
</simpara></listitem></varlistentry>
1184
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1185
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1186
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-data-function-updated"/>The &quot;data-function-updated&quot; signal</title>
1187
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1188
 
                                            <link linkend="gpointer">gpointer</link> arg1,
1189
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1190
 
<para>
1191
 
 
1192
 
</para><variablelist role="params">
1193
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1194
 
<listitem><simpara>the object which received the signal.
1195
 
</simpara></listitem></varlistentry>
1196
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
1197
 
<listitem><simpara>
1198
 
 
1199
 
</simpara></listitem></varlistentry>
1200
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1201
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1202
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-data-type-added"/>The &quot;data-type-added&quot; signal</title>
1203
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1204
 
                                            <link linkend="gpointer">gpointer</link> arg1,
1205
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1206
 
<para>
1207
 
 
1208
 
</para><variablelist role="params">
1209
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1210
 
<listitem><simpara>the object which received the signal.
1211
 
</simpara></listitem></varlistentry>
1212
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
1213
 
<listitem><simpara>
1214
 
 
1215
 
</simpara></listitem></varlistentry>
1216
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1217
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1218
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-data-type-removed"/>The &quot;data-type-removed&quot; signal</title>
1219
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1220
 
                                            <link linkend="gpointer">gpointer</link> arg1,
1221
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1222
 
<para>
1223
 
 
1224
 
</para><variablelist role="params">
1225
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1226
 
<listitem><simpara>the object which received the signal.
1227
 
</simpara></listitem></varlistentry>
1228
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
1229
 
<listitem><simpara>
1230
 
 
1231
 
</simpara></listitem></varlistentry>
1232
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1233
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1234
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-data-type-updated"/>The &quot;data-type-updated&quot; signal</title>
1235
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1236
 
                                            <link linkend="gpointer">gpointer</link> arg1,
1237
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1238
 
<para>
1239
 
 
1240
 
</para><variablelist role="params">
1241
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1242
 
<listitem><simpara>the object which received the signal.
1243
 
</simpara></listitem></varlistentry>
1244
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
1245
 
<listitem><simpara>
1246
 
 
1247
 
</simpara></listitem></varlistentry>
1248
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1249
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1250
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-data-update-finished"/>The &quot;data-update-finished&quot; signal</title>
1251
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1252
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1253
 
<para>
1254
 
 
1255
 
</para><variablelist role="params">
1256
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1257
 
<listitem><simpara>the object which received the signal.
1258
 
 
1259
 
</simpara></listitem></varlistentry>
1260
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1261
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1262
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-data-update-started"/>The &quot;data-update-started&quot; signal</title>
1263
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1264
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1265
 
<para>
1266
 
 
1267
 
</para><variablelist role="params">
1268
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1269
 
<listitem><simpara>the object which received the signal.
1270
 
 
1271
 
</simpara></listitem></varlistentry>
1272
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1273
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1274
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-object-handler-updated"/>The &quot;object-handler-updated&quot; signal</title>
1275
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1276
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1277
 
<para>
1278
 
 
1279
 
</para><variablelist role="params">
1280
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1281
 
<listitem><simpara>the object which received the signal.
1282
 
 
1283
 
</simpara></listitem></varlistentry>
1284
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1285
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1286
 
</variablelist></refsect2><refsect2><title><anchor id="MgServer-update-progress"/>The &quot;update-progress&quot; signal</title>
1287
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgServer">MgServer</link> *mgserver,
1288
 
                                            <link linkend="gpointer">gpointer</link> arg1,
1289
 
                                            <link linkend="guint">guint</link> arg2,
1290
 
                                            <link linkend="guint">guint</link> arg3,
1291
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
1292
 
<para>
1293
 
 
1294
 
</para><variablelist role="params">
1295
 
<varlistentry><term><parameter>mgserver</parameter>&nbsp;:</term>
1296
 
<listitem><simpara>the object which received the signal.
1297
 
</simpara></listitem></varlistentry>
1298
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
1299
 
<listitem><simpara>
1300
 
</simpara></listitem></varlistentry>
1301
 
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
1302
 
<listitem><simpara>
1303
 
</simpara></listitem></varlistentry>
1304
 
<varlistentry><term><parameter>arg3</parameter>&nbsp;:</term>
1305
 
<listitem><simpara>
1306
 
 
1307
 
</simpara></listitem></varlistentry>
1308
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
1309
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
1310
 
</variablelist></refsect2>
1311
 
</refsect1>
1312
 
 
1313
 
 
1314
 
 
1315
 
</refentry>