|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21572/root/usr/share/gtk-doc/html/gconf/ |
Upload File : |
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GConfEngine</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GConf Reference Manual">
<link rel="up" href="ch01.html" title="Using the GConf library">
<link rel="prev" href="gconf-gconf-backend.html" title="gconf-backend">
<link rel="next" href="gconf-gconf-error.html" title="GError">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Using the GConf library">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="gconf-gconf-backend.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GConf Reference Manual</th>
<td><a accesskey="n" href="gconf-gconf-error.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="gconf-gconf-engine"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">GConfEngine</span></h2>
<p>GConfEngine —
a GConf "database"</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a>;
<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a>* <a href="gconf-gconf-engine.html#gconf-engine-get-default">gconf_engine_get_default</a> (void);
<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a>* <a href="gconf-gconf-engine.html#gconf-engine-get-for-address">gconf_engine_get_for_address</a> (const gchar *address,
GError **err);
<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a>* <a href="gconf-gconf-engine.html#gconf-engine-get-for-addresses">gconf_engine_get_for_addresses</a> (GSList *addresses,
GError **err);
void <a href="gconf-gconf-engine.html#gconf-engine-unref">gconf_engine_unref</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf);
void <a href="gconf-gconf-engine.html#gconf-engine-ref">gconf_engine_ref</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf);
<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a>* <a href="gconf-gconf-engine.html#gconf-engine-get-local">gconf_engine_get_local</a> (const char *address,
GError **err);
<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a>* <a href="gconf-gconf-engine.html#gconf-engine-get-local-for-addresses">gconf_engine_get_local_for_addresses</a>
(GSList *addresses,
GError **err);
void <a href="gconf-gconf-engine.html#gconf-engine-set-user-data">gconf_engine_set_user_data</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *engine,
gpointer data,
GDestroyNotify dnotify);
gpointer <a href="gconf-gconf-engine.html#gconf-engine-get-user-data">gconf_engine_get_user_data</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *engine);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2556892"></a><h2>Description</h2>
<p>
A <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a> represents a connection to the GConf database. The
default <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>, returned from <a href="gconf-gconf-engine.html#gconf-engine-get-default"><code class="function">gconf_engine_get_default()</code></a>, represents the
user's normal configuration source search path. Configuration-related
utilities, such as a configuration editor tool, might wish to access a
particular configuration source directly; they can obtain a
non-default <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a> with <a href="gconf-gconf-engine.html#gconf-engine-get-for-address"><code class="function">gconf_engine_get_for_address()</code></a>.
</p>
<p>
Once you have a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>, you can query and manipulate
configuration values.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2525079"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2525085"></a><h3>
<a name="GConfEngine"></a>GConfEngine</h3>
<a class="indexterm" name="id2525095"></a><pre class="programlisting">typedef struct _GConfEngine GConfEngine;</pre>
<p>
An opaque data type representing one or more configuration sources.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2525111"></a><h3>
<a name="gconf-engine-get-default"></a>gconf_engine_get_default ()</h3>
<a class="indexterm" name="id2525120"></a><pre class="programlisting"><a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a>* gconf_engine_get_default (void);</pre>
<p>
Returns the default <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>. All clients should use this, unless
they are special configuration-related tools. The caller of this
function assumes one reference count, and must call
<a href="gconf-gconf-engine.html#gconf-engine-unref"><code class="function">gconf_engine_unref()</code></a> at some point. It's fairly important to unref the
<a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>, to cleanly close the connection to
<span class="application">gconfd</span>. So if possible close the connection
before exiting your application. see ? <code class="function">printf()</code> <code class="function"><code class="function">printf()</code></code>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the default <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2525218"></a><h3>
<a name="gconf-engine-get-for-address"></a>gconf_engine_get_for_address ()</h3>
<a class="indexterm" name="id2515862"></a><pre class="programlisting"><a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a>* gconf_engine_get_for_address (const gchar *address,
GError **err);</pre>
<p>
Obtains a special <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>; mostly useful for specialized
GConf-related tools. Normal clients shouldn't need to use it.
As with <a href="gconf-gconf-engine.html#gconf-engine-get-default"><code class="function">gconf_engine_get_default()</code></a>, the returned <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a> should be
unreferenced by the caller of this function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>address</code></em> :</span></td>
<td>a configuration source address.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
<td>the return location for an allocated <span class="type">GError</span>, or <span class="symbol">NULL</span> to ignore errors.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2515983"></a><h3>
<a name="gconf-engine-get-for-addresses"></a>gconf_engine_get_for_addresses ()</h3>
<a class="indexterm" name="id2515994"></a><pre class="programlisting"><a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a>* gconf_engine_get_for_addresses (GSList *addresses,
GError **err);</pre>
<p>
Similar to <a href="gconf-gconf-engine.html#gconf-engine-get-for-address"><code class="function">gconf_engine_get_for_address()</code></a> , but takes a list of addresses
instead of a single address.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>addresses</code></em> :</span></td>
<td>a list of configuration addresses.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
<td>the return location for an allocated <span class="type">GError</span>, or <span class="symbol">NULL</span> to ignore errors.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2516105"></a><h3>
<a name="gconf-engine-unref"></a>gconf_engine_unref ()</h3>
<a class="indexterm" name="id2522644"></a><pre class="programlisting">void gconf_engine_unref (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf);</pre>
<p>
Decreases the reference count of a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a> by one; if the
reference count reaches 0, destroys the <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>conf</code></em> :</span></td>
<td>a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2522712"></a><h3>
<a name="gconf-engine-ref"></a>gconf_engine_ref ()</h3>
<a class="indexterm" name="id2522722"></a><pre class="programlisting">void gconf_engine_ref (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf);</pre>
<p>
Increases the reference count of a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a> by one.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>conf</code></em> :</span></td>
<td>a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2522782"></a><h3>
<a name="gconf-engine-get-local"></a>gconf_engine_get_local ()</h3>
<a class="indexterm" name="id2522791"></a><pre class="programlisting"><a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a>* gconf_engine_get_local (const char *address,
GError **err);</pre>
<p>
Obtain a local (non-process-transparent) <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>. Local engines
do not support notification, and can only access config databases
directly (they do not use the multiple sources in a path system
supported by nonlocal engines).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>address</code></em> :</span></td>
<td>address of local database.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
<td>return location of an allocated <span class="type">GError</span>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2522893"></a><h3>
<a name="gconf-engine-get-local-for-addresses"></a>gconf_engine_get_local_for_addresses ()</h3>
<a class="indexterm" name="id2522904"></a><pre class="programlisting"><a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a>* gconf_engine_get_local_for_addresses
(GSList *addresses,
GError **err);</pre>
<p>
Obtains a local <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a> similar to <a href="gconf-gconf-engine.html#gconf-engine-get-local"><code class="function">gconf_engine_get_local()</code></a>.
Instead of taking the address of the local database, this function takes
the addresses of the sources and gets the <a href="gconf-gconf-sources.html#GConfSources"><span class="type">GConfSources</span></a> using <a href="gconf-gconf-sources.html#gconf-sources-new-from-addresses"><code class="function">gconf_sources_new_from_addresses()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>addresses</code></em> :</span></td>
<td>a list of addresses of <a href="gconf-gconf-sources.html#GConfSources"><span class="type">GConfSources</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
<td>the return location for an allocated <span class="type">GError</span>, or <span class="symbol">NULL</span> to ignore errors.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.8
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564851"></a><h3>
<a name="gconf-engine-set-user-data"></a>gconf_engine_set_user_data ()</h3>
<a class="indexterm" name="id2564861"></a><pre class="programlisting">void gconf_engine_set_user_data (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *engine,
gpointer data,
GDestroyNotify dnotify);</pre>
<p>
Sets the user_data and the destroy notification function fields of a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>engine</code></em> :</span></td>
<td>a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>a <span class="type">gpointer</span>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>dnotify</code></em> :</span></td>
<td>a pointer to the function to be called during destroy.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564972"></a><h3>
<a name="gconf-engine-get-user-data"></a>gconf_engine_get_user_data ()</h3>
<a class="indexterm" name="id2564982"></a><pre class="programlisting">gpointer gconf_engine_get_user_data (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *engine);</pre>
<p>
Returns the user_data field of a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>engine</code></em> :</span></td>
<td>a <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a pointer to the user_data.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="gconf-gconf-backend.html"><b><< gconf-backend</b></a></td>
<td align="right"><a accesskey="n" href="gconf-gconf-error.html"><b>GError >></b></a></td>
</tr></table>
</body>
</html>