← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gconf/oneiric-proposed

« back to all changes in this revision

Viewing changes to doc/gconf/html/gconf-gconf-engine.html

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2010-09-01 18:47:35 UTC
  • mfrom: (1.1.23 upstream)
  • Revision ID: james.westby@ubuntu.com-20100901184735-jx0pcr71nnf8xwd4
Tags: 2.31.91-0ubuntu1
* New upstream release
* debian/control:
  - Drop build-depends on libdbus-1-dev, libdbus-glib-1-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/gconf/html/gconf-gconf-engine.html
38
38
<div class="refsynopsisdiv">
39
39
<a name="gconf-gconf-engine.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">                    <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine">GConfEngine</a>;
41
 
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>*        <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-default" title="gconf_engine_get_default ()">gconf_engine_get_default</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
42
 
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>*        <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-for-address" title="gconf_engine_get_for_address ()">gconf_engine_get_for_address</a>        (<em class="parameter"><code>const <span class="type">gchar</span> *address</code></em>,
43
 
                                                         <em class="parameter"><code><span class="type">GError</span> **err</code></em>);
44
 
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>*        <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-for-addresses" title="gconf_engine_get_for_addresses ()">gconf_engine_get_for_addresses</a>      (<em class="parameter"><code><span class="type">GSList</span> *addresses</code></em>,
45
 
                                                         <em class="parameter"><code><span class="type">GError</span> **err</code></em>);
 
41
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> *       <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-default" title="gconf_engine_get_default ()">gconf_engine_get_default</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
 
42
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> *       <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-for-address" title="gconf_engine_get_for_address ()">gconf_engine_get_for_address</a>        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *address</code></em>,
 
43
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
 
44
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> *       <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-for-addresses" title="gconf_engine_get_for_addresses ()">gconf_engine_get_for_addresses</a>      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
 
45
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
46
46
<span class="returnvalue">void</span>                <a class="link" href="gconf-gconf-engine.html#gconf-engine-unref" title="gconf_engine_unref ()">gconf_engine_unref</a>                  (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *conf</code></em>);
47
47
<span class="returnvalue">void</span>                <a class="link" href="gconf-gconf-engine.html#gconf-engine-ref" title="gconf_engine_ref ()">gconf_engine_ref</a>                    (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *conf</code></em>);
48
48
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> *       <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-local" title="gconf_engine_get_local ()">gconf_engine_get_local</a>              (<em class="parameter"><code>const <span class="type">char</span> *address</code></em>,
49
 
                                                         <em class="parameter"><code><span class="type">GError</span> **err</code></em>);
 
49
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
50
50
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> *       <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-local-for-addresses" title="gconf_engine_get_local_for_addresses ()">gconf_engine_get_local_for_addresses</a>
51
 
                                                        (<em class="parameter"><code><span class="type">GSList</span> *addresses</code></em>,
52
 
                                                         <em class="parameter"><code><span class="type">GError</span> **err</code></em>);
 
51
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
 
52
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
53
53
<span class="returnvalue">void</span>                <a class="link" href="gconf-gconf-engine.html#gconf-engine-set-user-data" title="gconf_engine_set_user_data ()">gconf_engine_set_user_data</a>          (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>,
54
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
55
 
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> dnotify</code></em>);
56
 
<span class="returnvalue">gpointer</span>            <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-user-data" title="gconf_engine_get_user_data ()">gconf_engine_get_user_data</a>          (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>);
 
54
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
 
55
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> dnotify</code></em>);
 
56
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-user-data" title="gconf_engine_get_user_data ()">gconf_engine_get_user_data</a>          (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>);
57
57
</pre>
58
58
</div>
59
59
<div class="refsect1">
83
83
<hr>
84
84
<div class="refsect2">
85
85
<a name="gconf-engine-get-default"></a><h3>gconf_engine_get_default ()</h3>
86
 
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>*        gconf_engine_get_default            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
86
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> *       gconf_engine_get_default            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
87
87
<p>
88
88
Returns the default <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>. All clients should use this, unless
89
89
they are special configuration-related tools. The caller of this
105
105
<hr>
106
106
<div class="refsect2">
107
107
<a name="gconf-engine-get-for-address"></a><h3>gconf_engine_get_for_address ()</h3>
108
 
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>*        gconf_engine_get_for_address        (<em class="parameter"><code>const <span class="type">gchar</span> *address</code></em>,
109
 
                                                         <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
 
108
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> *       gconf_engine_get_for_address        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *address</code></em>,
 
109
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
110
110
<p>
111
111
Obtains a special <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>; mostly useful for specialized
112
112
GConf-related tools. Normal clients shouldn't need to use it.
123
123
</tr>
124
124
<tr>
125
125
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
126
 
<td>the return location for an allocated <span class="type">GError</span>, or <span class="symbol">NULL</span> to ignore errors.
 
126
<td>the return location for an allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <span class="symbol">NULL</span> to ignore errors.
127
127
</td>
128
128
</tr>
129
129
<tr>
137
137
<hr>
138
138
<div class="refsect2">
139
139
<a name="gconf-engine-get-for-addresses"></a><h3>gconf_engine_get_for_addresses ()</h3>
140
 
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>*        gconf_engine_get_for_addresses      (<em class="parameter"><code><span class="type">GSList</span> *addresses</code></em>,
141
 
                                                         <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
 
140
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> *       gconf_engine_get_for_addresses      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
 
141
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
142
142
<p>
143
143
Similar to <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-for-address" title="gconf_engine_get_for_address ()"><code class="function">gconf_engine_get_for_address()</code></a> , but takes a list of addresses
144
144
instead of a single address.
153
153
</tr>
154
154
<tr>
155
155
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
156
 
<td>the return location for an allocated <span class="type">GError</span>, or <span class="symbol">NULL</span> to ignore errors.
 
156
<td>the return location for an allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <span class="symbol">NULL</span> to ignore errors.
157
157
</td>
158
158
</tr>
159
159
<tr>
202
202
<div class="refsect2">
203
203
<a name="gconf-engine-get-local"></a><h3>gconf_engine_get_local ()</h3>
204
204
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> *       gconf_engine_get_local              (<em class="parameter"><code>const <span class="type">char</span> *address</code></em>,
205
 
                                                         <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
 
205
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
206
206
<p>
207
207
Obtain a local (non-process-transparent) <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>. Local engines
208
208
do not support notification, and can only access config databases
219
219
</tr>
220
220
<tr>
221
221
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
222
 
<td>return location of an allocated <span class="type">GError</span>.
 
222
<td>return location of an allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>.
223
223
</td>
224
224
</tr>
225
225
<tr>
234
234
<div class="refsect2">
235
235
<a name="gconf-engine-get-local-for-addresses"></a><h3>gconf_engine_get_local_for_addresses ()</h3>
236
236
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> *       gconf_engine_get_local_for_addresses
237
 
                                                        (<em class="parameter"><code><span class="type">GSList</span> *addresses</code></em>,
238
 
                                                         <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
 
237
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
 
238
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
239
239
<p>
240
240
Obtains a local <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> similar to <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-local" title="gconf_engine_get_local ()"><code class="function">gconf_engine_get_local()</code></a>.
241
241
Instead of taking the address of the local database, this function takes
251
251
</tr>
252
252
<tr>
253
253
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
254
 
<td>the return location for an allocated <span class="type">GError</span>, or <span class="symbol">NULL</span> to ignore errors.
 
254
<td>the return location for an allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <span class="symbol">NULL</span> to ignore errors.
255
255
</td>
256
256
</tr>
257
257
<tr>
267
267
<div class="refsect2">
268
268
<a name="gconf-engine-set-user-data"></a><h3>gconf_engine_set_user_data ()</h3>
269
269
<pre class="programlisting"><span class="returnvalue">void</span>                gconf_engine_set_user_data          (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>,
270
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
271
 
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> dnotify</code></em>);</pre>
 
270
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
 
271
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> dnotify</code></em>);</pre>
272
272
<p>
273
273
Sets the user_data and the destroy notification function fields of a <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>.
274
274
</p>
282
282
</tr>
283
283
<tr>
284
284
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
285
 
<td>a <span class="type">gpointer</span>.
 
285
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>.
286
286
</td>
287
287
</tr>
288
288
<tr>
296
296
<hr>
297
297
<div class="refsect2">
298
298
<a name="gconf-engine-get-user-data"></a><h3>gconf_engine_get_user_data ()</h3>
299
 
<pre class="programlisting"><span class="returnvalue">gpointer</span>            gconf_engine_get_user_data          (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>);</pre>
 
299
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            gconf_engine_get_user_data          (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>);</pre>
300
300
<p>
301
301
Returns the user_data field of a <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>.
302
302
</p>