|
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>GConf Core Interfaces</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-value.html" title="GConfValue, GConfEntry, GConfMetaInfo">
<link rel="next" href="gconf-gconf-locale.html" title="gconf-locale">
<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-value.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-locale.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"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">GConf Core Interfaces</span></h2>
<p>GConf Core Interfaces —
Basic functions to initialize GConf and get/set values</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
gboolean <a href="gconf-gconf.html#gconf-init">gconf_init</a> (int argc,
char **argv,
GError **err);
void <a href="gconf-gconf.html#gconf-preinit">gconf_preinit</a> (gpointer app,
gpointer mod_info);
void <a href="gconf-gconf.html#gconf-postinit">gconf_postinit</a> (gpointer app,
gpointer mod_info);
gboolean <a href="gconf-gconf.html#gconf-is-initialized">gconf_is_initialized</a> (void);
void (<a href="gconf-gconf.html#GConfNotifyFunc">*GConfNotifyFunc</a>) (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
guint cnxn_id,
<a href="gconf-gconf-value.html#GConfEntry">GConfEntry</a> *entry,
gpointer user_data);
guint <a href="gconf-gconf.html#gconf-engine-notify-add">gconf_engine_notify_add</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *namespace_section,
<a href="gconf-gconf.html#GConfNotifyFunc">GConfNotifyFunc</a> func,
gpointer user_data,
GError **err);
void <a href="gconf-gconf.html#gconf-engine-notify-remove">gconf_engine_notify_remove</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
guint cnxn);
<a href="gconf-gconf-value.html#GConfValue">GConfValue</a>* <a href="gconf-gconf.html#gconf-engine-get">gconf_engine_get</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);
<a href="gconf-gconf-value.html#GConfValue">GConfValue</a>* <a href="gconf-gconf.html#gconf-engine-get-without-default">gconf_engine_get_without_default</a>
(<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);
<a href="gconf-gconf-value.html#GConfEntry">GConfEntry</a>* <a href="gconf-gconf.html#gconf-engine-get-entry">gconf_engine_get_entry</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const gchar *locale,
gboolean use_schema_default,
GError **err);
<a href="gconf-gconf-value.html#GConfValue">GConfValue</a>* <a href="gconf-gconf.html#gconf-engine-get-with-locale">gconf_engine_get_with_locale</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const gchar *locale,
GError **err);
<a href="gconf-gconf-value.html#GConfValue">GConfValue</a>* <a href="gconf-gconf.html#gconf-engine-get-default-from-schema">gconf_engine_get_default_from_schema</a>
(<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-set">gconf_engine_set</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const <a href="gconf-gconf-value.html#GConfValue">GConfValue</a> *value,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-unset">gconf_engine_unset</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-associate-schema">gconf_engine_associate_schema</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const gchar *schema_key,
GError **err);
GSList* <a href="gconf-gconf.html#gconf-engine-all-entries">gconf_engine_all_entries</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *dir,
GError **err);
GSList* <a href="gconf-gconf.html#gconf-engine-all-dirs">gconf_engine_all_dirs</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *dir,
GError **err);
void <a href="gconf-gconf.html#gconf-engine-suggest-sync">gconf_engine_suggest_sync</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-dir-exists">gconf_engine_dir_exists</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *dir,
GError **err);
void <a href="gconf-gconf.html#gconf-engine-remove-dir">gconf_engine_remove_dir</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *dir,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-key-is-writable">gconf_engine_key_is_writable</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-valid-key">gconf_valid_key</a> (const gchar *key,
gchar **why_invalid);
gboolean <a href="gconf-gconf.html#gconf-key-is-below">gconf_key_is_below</a> (const gchar *above,
const gchar *below);
gchar* <a href="gconf-gconf.html#gconf-concat-dir-and-key">gconf_concat_dir_and_key</a> (const gchar *dir,
const gchar *key);
gchar* <a href="gconf-gconf.html#gconf-unique-key">gconf_unique_key</a> (void);
char* <a href="gconf-gconf.html#gconf-escape-key">gconf_escape_key</a> (const char *arbitrary_text,
int len);
char* <a href="gconf-gconf.html#gconf-unescape-key">gconf_unescape_key</a> (const char *escaped_key,
int len);
gdouble <a href="gconf-gconf.html#gconf-engine-get-float">gconf_engine_get_float</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);
gint <a href="gconf-gconf.html#gconf-engine-get-int">gconf_engine_get_int</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);
gchar* <a href="gconf-gconf.html#gconf-engine-get-string">gconf_engine_get_string</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-get-bool">gconf_engine_get_bool</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);
<a href="gconf-gconf-schema.html#GConfSchema">GConfSchema</a>* <a href="gconf-gconf.html#gconf-engine-get-schema">gconf_engine_get_schema</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);
GSList* <a href="gconf-gconf.html#gconf-engine-get-list">gconf_engine_get_list</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> list_type,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-get-pair">gconf_engine_get_pair</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> car_type,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> cdr_type,
gpointer car_retloc,
gpointer cdr_retloc,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-set-float">gconf_engine_set_float</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
gdouble val,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-set-int">gconf_engine_set_int</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
gint val,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-set-string">gconf_engine_set_string</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const gchar *val,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-set-bool">gconf_engine_set_bool</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
gboolean val,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-set-schema">gconf_engine_set_schema</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const <a href="gconf-gconf-schema.html#GConfSchema">GConfSchema</a> *val,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-set-list">gconf_engine_set_list</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> list_type,
GSList *list,
GError **err);
gboolean <a href="gconf-gconf.html#gconf-engine-set-pair">gconf_engine_set_pair</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> car_type,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> cdr_type,
gconstpointer address_of_car,
gconstpointer address_of_cdr,
GError **err);
<a href="gconf-gconf.html#GConfEnumStringPair">GConfEnumStringPair</a>;
gboolean <a href="gconf-gconf.html#gconf-string-to-enum">gconf_string_to_enum</a> (<a href="gconf-gconf.html#GConfEnumStringPair">GConfEnumStringPair</a> lookup_table[],
const gchar *str,
gint *enum_value_retloc);
const gchar* <a href="gconf-gconf.html#gconf-enum-to-string">gconf_enum_to_string</a> (<a href="gconf-gconf.html#GConfEnumStringPair">GConfEnumStringPair</a> lookup_table[],
gint enum_value);
void <a href="gconf-gconf.html#gconf-clear-cache">gconf_clear_cache</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
GError **err);
void <a href="gconf-gconf.html#gconf-synchronous-sync">gconf_synchronous_sync</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
GError **err);
<a href="gconf-gconf-value.html#GConfValue">GConfValue</a>* <a href="gconf-gconf.html#gconf-engine-get-full">gconf_engine_get_full</a> (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const gchar *locale,
gboolean use_schema_default,
gboolean *is_default_p,
gboolean *is_writable_p,
GError **err);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2599252"></a><h2>Description</h2>
<p>
These functions initialize GConf, and communicate with the
<span class="application">gconfd</span> server via a
<a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a> object. You can install a notification
request on the server, get values, set values, list directories, and associate
schema names with keys.
</p>
<p>
Most of this interface is replicated in the <span class="type">GObject</span> wrapper
(<span class="type">GConfClient</span> object); an alternative to the value-setting functions
is the <a href="gconf-gconf-changeset.html#GConfChangeSet"><span class="type">GConfChangeSet</span></a> interface.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2599306"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2599313"></a><h3>
<a name="gconf-init"></a>gconf_init ()</h3>
<a class="indexterm" name="id2550723"></a><pre class="programlisting">gboolean gconf_init (int argc,
char **argv,
GError **err);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gconf_init</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Initializes the GConf library. Creates a connection to a CORBA ORB, and
initializes OAF (the object activation framework) if it isn't already
initialized.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
<td>
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599424"></a><h3>
<a name="gconf-preinit"></a>gconf_preinit ()</h3>
<a class="indexterm" name="id2599432"></a><pre class="programlisting">void gconf_preinit (gpointer app,
gpointer mod_info);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gconf_preinit</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599503"></a><h3>
<a name="gconf-postinit"></a>gconf_postinit ()</h3>
<a class="indexterm" name="id2599511"></a><pre class="programlisting">void gconf_postinit (gpointer app,
gpointer mod_info);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gconf_postinit</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>app</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mod_info</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599582"></a><h3>
<a name="gconf-is-initialized"></a>gconf_is_initialized ()</h3>
<a class="indexterm" name="id2599591"></a><pre class="programlisting">gboolean gconf_is_initialized (void);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gconf_is_initialized</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Asks whether the library has been initialized.
</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>
<span class="symbol">TRUE</span> if the library has been initialized.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599638"></a><h3>
<a name="GConfNotifyFunc"></a>GConfNotifyFunc ()</h3>
<a class="indexterm" name="id2599647"></a><pre class="programlisting">void (*GConfNotifyFunc) (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
guint cnxn_id,
<a href="gconf-gconf-value.html#GConfEntry">GConfEntry</a> *entry,
gpointer user_data);</pre>
<p>
A callback function invoked when a key's value changes. The <em class="parameter"><code>cnxn_id</code></em> parameter
will be the connection ID returned from <a href="gconf-gconf.html#gconf-engine-notify-add"><code class="function">gconf_engine_notify_add()</code></a>. <em class="parameter"><code>key</code></em> will be the
full path of the changed key, <em class="parameter"><code>value</code></em> will be the new value if the key is set.
If the key is unset, <em class="parameter"><code>value</code></em> will be the default value if one exists, or
<span class="symbol">NULL</span> otherwise. <em class="parameter"><code>is_default</code></em> indicates whether a value is a
default setting or a user setting. If <em class="parameter"><code>value</code></em> is <span class="symbol">NULL</span>,
<em class="parameter"><code>is_default</code></em> will be <span class="symbol">TRUE</span>. <em class="parameter"><code>user_data</code></em> is the data passed to
<a href="gconf-gconf.html#gconf-engine-notify-add"><code class="function">gconf_engine_notify_add()</code></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>the <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a> passed to <a href="gconf-gconf.html#gconf-engine-notify-add"><code class="function">gconf_engine_notify_add()</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>cnxn_id</code></em> :</span></td>
<td>the ID returned from <a href="gconf-gconf.html#gconf-engine-notify-add"><code class="function">gconf_engine_notify_add()</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>the user data passed to <a href="gconf-gconf.html#gconf-engine-notify-add"><code class="function">gconf_engine_notify_add()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599849"></a><h3>
<a name="gconf-engine-notify-add"></a>gconf_engine_notify_add ()</h3>
<a class="indexterm" name="id2599858"></a><pre class="programlisting">guint gconf_engine_notify_add (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *namespace_section,
<a href="gconf-gconf.html#GConfNotifyFunc">GConfNotifyFunc</a> func,
gpointer user_data,
GError **err);</pre>
<p>
Registers a notification request with the <span class="application">gconfd</span>
server. The server will notify the client when any key at or below
<em class="parameter"><code>namespace_section</code></em> is set or unset. Try to watch the smallest possible part of
the namespace; otherwise you will slow down the server and your application with
unnecessary notifications. Note that you should prefer <a href="gconf-GConfClient.html#gconf-client-notify-add"><code class="function">gconf_client_notify_add()</code></a>
if you're using the <span class="type">GObject</span> wrapper library, because
<a href="gconf-GConfClient.html#gconf-client-notify-add"><code class="function">gconf_client_notify_add()</code></a> does not require a client-server conversation for
every callback. <a href="gconf-gconf.html#gconf-engine-notify-add"><code class="function">gconf_engine_notify_add()</code></a> requests a different server notification for
every callback. The function returns an ID you can use to remove the
notification request; 0 is an invalid ID, and is returned if an error occurs.
</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> to monitor for changes.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>namespace_section</code></em> :</span></td>
<td>the directory or key to watch; you will be notified of changes at or below this point.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>func</code></em> :</span></td>
<td>the callback to invoke when a notification is received from the server.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>the data to pass to the callback.
</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>an ID for the notification request, or 0 on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600056"></a><h3>
<a name="gconf-engine-notify-remove"></a>gconf_engine_notify_remove ()</h3>
<a class="indexterm" name="id2600064"></a><pre class="programlisting">void gconf_engine_notify_remove (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
guint cnxn);</pre>
<p>
Removes a notification request.
</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>the <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a> you were monitoring for changes.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>cnxn</code></em> :</span></td>
<td>The ID returned by <a href="gconf-gconf.html#gconf-engine-notify-add"><code class="function">gconf_engine_notify_add()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600140"></a><h3>
<a name="gconf-engine-get"></a>gconf_engine_get ()</h3>
<a class="indexterm" name="id2600148"></a><pre class="programlisting"><a href="gconf-gconf-value.html#GConfValue">GConfValue</a>* gconf_engine_get (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);</pre>
<p>
Returns the <a href="gconf-gconf-value.html#GConfValue"><span class="type">GConfValue</span></a> stored at <em class="parameter"><code>key</code></em>, or <span class="symbol">NULL</span> if no value is
set. You must call <a href="gconf-gconf-value.html#gconf-value-free"><code class="function">gconf_value_free()</code></a> to free the returned value. If you know
the expected type of the value, you probably want to use the type-specific
convenience wrappers (<a href="gconf-gconf.html#gconf-engine-get-int"><code class="function">gconf_engine_get_int()</code></a>, etc.) because they will do the
type-checking for you and return the appropriate type. Automatically returns the
default value for a key, if the key is unset and a default exists.
</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> to get the value from.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>the key to get.
</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>newly-allocated <a href="gconf-gconf-value.html#GConfValue"><span class="type">GConfValue</span></a>, or <span class="symbol">NULL</span> if unset and no default exists.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600300"></a><h3>
<a name="gconf-engine-get-without-default"></a>gconf_engine_get_without_default ()</h3>
<a class="indexterm" name="id2600310"></a><pre class="programlisting"><a href="gconf-gconf-value.html#GConfValue">GConfValue</a>* gconf_engine_get_without_default
(<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);</pre>
<p>
Identical to <a href="gconf-gconf.html#gconf-engine-get"><code class="function">gconf_engine_get()</code></a>, except that it will return <span class="symbol">NULL</span> in
place of the default value if the key is unset. Note that <a href="gconf-gconf.html#gconf-engine-get"><code class="function">gconf_engine_get()</code></a> can also
return <span class="symbol">NULL</span> if no default exists or an error occurs.
</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> to get the value from.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>the key to get.
</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>newly-allocated <a href="gconf-gconf-value.html#GConfValue"><span class="type">GConfValue</span></a>, or <span class="symbol">NULL</span> if unset.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600451"></a><h3>
<a name="gconf-engine-get-entry"></a>gconf_engine_get_entry ()</h3>
<a class="indexterm" name="id2600460"></a><pre class="programlisting"><a href="gconf-gconf-value.html#GConfEntry">GConfEntry</a>* gconf_engine_get_entry (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const gchar *locale,
gboolean use_schema_default,
GError **err);</pre>
<p>
Obtain the full <a href="gconf-gconf-value.html#GConfEntry"><span class="type">GConfEntry</span></a> for a value.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>the key to get.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>locale</code></em> :</span></td>
<td>preferred locale (as in the locale-related environment variables).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>use_schema_default</code></em> :</span></td>
<td>a <span class="type">gboolean</span> value indicating whether the default value associated with schema
should be used.
</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-value.html#GConfEntry"><span class="type">GConfEntry</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600624"></a><h3>
<a name="gconf-engine-get-with-locale"></a>gconf_engine_get_with_locale ()</h3>
<a class="indexterm" name="id2600634"></a><pre class="programlisting"><a href="gconf-gconf-value.html#GConfValue">GConfValue</a>* gconf_engine_get_with_locale (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const gchar *locale,
GError **err);</pre>
<p>
Requests the value appropriate for a particular locale. Right now,
only values of type <code class="literal">GCONF_VALUE_SCHEMA</code> are localized; the locale is
meaningless for other value types. Also, <a href="gconf-gconf.html#gconf-engine-get"><code class="function">gconf_engine_get()</code></a> automatically
requests the value in the user's current locale. So this function is
only useful if you want a schema for some locale other than the user's
current locale. Except for the additional argument, this function is
identical to <a href="gconf-gconf.html#gconf-engine-get"><code class="function">gconf_engine_get()</code></a> in all respects.
</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> to get the value from.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>the key to get.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>locale</code></em> :</span></td>
<td>preferred locale (as in the locale-related environment variables).
</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>newly-allocated <a href="gconf-gconf-value.html#GConfValue"><span class="type">GConfValue</span></a>, or <span class="symbol">NULL</span> if unset.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600797"></a><h3>
<a name="gconf-engine-get-default-from-schema"></a>gconf_engine_get_default_from_schema ()</h3>
<a class="indexterm" name="id2600808"></a><pre class="programlisting"><a href="gconf-gconf-value.html#GConfValue">GConfValue</a>* gconf_engine_get_default_from_schema
(<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);</pre>
<p>
Returns the default value stored in the key's schema, if the key has a schema
associated and the schema exists and the schema contains a default value. Note
that <a href="gconf-gconf.html#gconf-engine-get"><code class="function">gconf_engine_get()</code></a>, <a href="gconf-gconf.html#gconf-engine-get-string"><code class="function">gconf_engine_get_string()</code></a>, and so on already return the default value
if no other value is found, so normally you do not need this function. This
function is just for convenience; you could also get the <a href="gconf-gconf-value.html#GConfMetaInfo"><span class="type">GConfMetaInfo</span></a> for the
key, read the schema name from there, then look up the schema by name and
extract the default value.
</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> to get the value from.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>the key to get the default value for.
</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>newly-allocated <a href="gconf-gconf-value.html#GConfValue"><span class="type">GConfValue</span></a>, or <span class="symbol">NULL</span> if unset.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600955"></a><h3>
<a name="gconf-engine-set"></a>gconf_engine_set ()</h3>
<a class="indexterm" name="id2600964"></a><pre class="programlisting">gboolean gconf_engine_set (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const <a href="gconf-gconf-value.html#GConfValue">GConfValue</a> *value,
GError **err);</pre>
<p>
Sets the value of <em class="parameter"><code>key</code></em> to <em class="parameter"><code>value</code></em>. Does not modify the passed-in
<a href="gconf-gconf-value.html#GConfValue"><span class="type">GConfValue</span></a>, you must free it yourself. You may prefer a type-specific
convenience wrapper, such as <a href="gconf-gconf.html#gconf-engine-set-int"><code class="function">gconf_engine_set_int()</code></a>.
</p>
<p>
An error of note is <code class="literal">GCONF_OVERRIDDEN</code>, indicating that the system
administrator has "forced" a value for this key. If no writable
configuration sources exist, it is not an error, but GConf will just
forget all your values; this allows users to have a configuration-free
setup without a constant barrage of error messages.
</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> to set the value in.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>the key to set.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td>the new value of <em class="parameter"><code>key</code></em>.
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601138"></a><h3>
<a name="gconf-engine-unset"></a>gconf_engine_unset ()</h3>
<a class="indexterm" name="id2601147"></a><pre class="programlisting">gboolean gconf_engine_unset (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);</pre>
<p>
Unsets the value of <em class="parameter"><code>key</code></em>; if <em class="parameter"><code>key</code></em> is already unset, has no effect. An
error of note is <code class="literal">GCONF_OVERRIDDEN</code>, indicating that the system
administrator has "forced" a value for this key.
</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> to affect.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>the key to unset.
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601275"></a><h3>
<a name="gconf-engine-associate-schema"></a>gconf_engine_associate_schema ()</h3>
<a class="indexterm" name="id2601285"></a><pre class="programlisting">gboolean gconf_engine_associate_schema (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const gchar *schema_key,
GError **err);</pre>
<p>
Directs GConf to find the schema for <em class="parameter"><code>key</code></em> at location
<em class="parameter"><code>schema_key</code></em>. That is, the value stored at <em class="parameter"><code>schema_key</code></em> should have type
<span class="type">GCONF_VALUE_SCHEMA</span>, and be descriptive of <em class="parameter"><code>key</code></em>. Normally you don't
call this function from C code; you can ship a special file with your
application and ask <span class="application">gconftool</span> to install
schema associations into the database during "make install."
</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> to affect.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>the key to associate the schema with.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>schema_key</code></em> :</span></td>
<td>the key where the schema will be stored.
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601453"></a><h3>
<a name="gconf-engine-all-entries"></a>gconf_engine_all_entries ()</h3>
<a class="indexterm" name="id2601462"></a><pre class="programlisting">GSList* gconf_engine_all_entries (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *dir,
GError **err);</pre>
<p>
Lists the key-value pairs in <em class="parameter"><code>dir</code></em>. Does not list subdirectories; for
that use <a href="gconf-gconf.html#gconf-engine-all-dirs"><code class="function">gconf_engine_all_dirs()</code></a>. The returned list contains <a href="gconf-gconf-value.html#GConfEntry"><span class="type">GConfEntry</span></a>
objects. A <a href="gconf-gconf-value.html#GConfEntry"><span class="type">GConfEntry</span></a> contains an <span class="emphasis"><em>absolute</em></span> key
and a value. The list is not recursive, it contains only the immediate
children of <em class="parameter"><code>dir</code></em>. To free the returned list, <a href="gconf-gconf-value.html#gconf-entry-free"><code class="function">gconf_entry_free()</code></a>
each list element, then <code class="function">g_slist_free()</code> the list itself.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td>Directory to list.
</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>List of <a href="gconf-gconf-value.html#GConfEntry"><span class="type">GConfEntry</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601628"></a><h3>
<a name="gconf-engine-all-dirs"></a>gconf_engine_all_dirs ()</h3>
<a class="indexterm" name="id2601636"></a><pre class="programlisting">GSList* gconf_engine_all_dirs (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *dir,
GError **err);</pre>
<p>
Lists the subdirectories in <em class="parameter"><code>dir</code></em>. The returned list contains allocated
strings. Each string is the absolute path of a subdirectory. You should <code class="function">g_free()</code> each string in the list, then <code class="function">g_slist_free()</code> the list itself.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td>Directory to get subdirectories from.
</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>List of allocated subdirectory names.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601768"></a><h3>
<a name="gconf-engine-suggest-sync"></a>gconf_engine_suggest_sync ()</h3>
<a class="indexterm" name="id2601777"></a><pre class="programlisting">void gconf_engine_suggest_sync (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
GError **err);</pre>
<p>
Suggests to <span class="application">gconfd</span> that you've just finished
a block of changes, and it would be an optimal time to sync to
permanent storage. This is only a suggestion; and
<span class="application">gconfd</span> will eventually sync even if you
don't call <a href="gconf-gconf.html#gconf-engine-suggest-sync"><code class="function">gconf_engine_suggest_sync()</code></a>. This function is just a "hint"
provided to <span class="application">gconfd</span> to maximize efficiency
and minimize data loss.
</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>the <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a> to suggest syncing to.
</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>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601893"></a><h3>
<a name="gconf-engine-dir-exists"></a>gconf_engine_dir_exists ()</h3>
<a class="indexterm" name="id2601905"></a><pre class="programlisting">gboolean gconf_engine_dir_exists (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *dir,
GError **err);</pre>
<p>
Queries whether the directory <em class="parameter"><code>dir</code></em> exists in the GConf
database. Returns <span class="symbol">TRUE</span> or <span class="symbol">FALSE</span>.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td>Directory to check for.
</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>
<span class="symbol">TRUE</span> or <span class="symbol">FALSE</span>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602043"></a><h3>
<a name="gconf-engine-remove-dir"></a>gconf_engine_remove_dir ()</h3>
<a class="indexterm" name="id2602055"></a><pre class="programlisting">void gconf_engine_remove_dir (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *dir,
GError **err);</pre>
<p>
This function first checks the validity of the gconf key. In case of a local <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a> it removes
the directory from the source backend calling <a href="gconf-gconf-sources.html#gconf-sources-remove-dir"><code class="function">gconf_sources_remove_dir()</code></a>. Otherwise it obtains the
configuration database using <code class="function">gconf_engine_get_database()</code> and removes the directory from the database
calling <code class="function">ConfigDatabase_remove_dir()</code>.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td>the name of the directory to be removed.
</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>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602202"></a><h3>
<a name="gconf-engine-key-is-writable"></a>gconf_engine_key_is_writable ()</h3>
<a class="indexterm" name="id2602214"></a><pre class="programlisting">gboolean gconf_engine_key_is_writable (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);</pre>
<p>
Checks whether the key is writable.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>the value to be changed.
</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>
<span class="symbol">TRUE</span> if the key is writable, <span class="symbol">FALSE</span> if the key is read only.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602339"></a><h3>
<a name="gconf-valid-key"></a>gconf_valid_key ()</h3>
<a class="indexterm" name="id2602350"></a><pre class="programlisting">gboolean gconf_valid_key (const gchar *key,
gchar **why_invalid);</pre>
<p>
Asks whether a key is syntactically correct, that is, it ensures that
the key consists of slash-separated strings and contains only legal
characters. Normally you shouldn't need to call this function; the
GConf functions all check this for you and return an error if the key
is invalid. However, it may be useful to validate input to an entry
field or the like. If you pass a non-<span class="symbol">NULL</span> address as
the <em class="parameter"><code>why_invalid</code></em> argument, an allocated string is returned explaining
why the key is invalid, if it is. If the key is valid the <em class="parameter"><code>why_invalid</code></em>
argument is unused.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key to check.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>why_invalid</code></em> :</span></td>
<td>return location for an explanation of the problem, if any. <code class="function">g_free()</code> the returned string.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
<span class="symbol">TRUE</span> if the key is valid, or <span class="symbol">FALSE</span> if not.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602469"></a><h3>
<a name="gconf-key-is-below"></a>gconf_key_is_below ()</h3>
<a class="indexterm" name="id2602481"></a><pre class="programlisting">gboolean gconf_key_is_below (const gchar *above,
const gchar *below);</pre>
<p>
Asks whether the key <em class="parameter"><code>below</code></em> would be found below the key <em class="parameter"><code>above</code></em>, were
they both to exist in the database. For example, <span class="symbol">/foo</span>
is always found below <span class="symbol">/</span> and above
<span class="symbol">/foo/bar</span>. This probably isn't useful but GConf uses
it internally so here it is if you need it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>above</code></em> :</span></td>
<td>the key on the "left hand side" of the predicate.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>below</code></em> :</span></td>
<td>the key on the "right hand side."
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
<span class="symbol">TRUE</span> or <span class="symbol">FALSE</span>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602591"></a><h3>
<a name="gconf-concat-dir-and-key"></a>gconf_concat_dir_and_key ()</h3>
<a class="indexterm" name="id2602602"></a><pre class="programlisting">gchar* gconf_concat_dir_and_key (const gchar *dir,
const gchar *key);</pre>
<p>
Concatenates the dir and key passed removing the unnecessary '/' characters
and returns the new string.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
<td>the directory.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>the key.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the newly concatenated string.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602682"></a><h3>
<a name="gconf-unique-key"></a>gconf_unique_key ()</h3>
<a class="indexterm" name="id2602693"></a><pre class="programlisting">gchar* gconf_unique_key (void);</pre>
<p>
Generates a new and unique key using serial number, process id, current time and a
random number generated.
</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>a newly created key, a <span class="type">gchar</span> value.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602739"></a><h3>
<a name="gconf-escape-key"></a>gconf_escape_key ()</h3>
<a class="indexterm" name="id2602749"></a><pre class="programlisting">char* gconf_escape_key (const char *arbitrary_text,
int len);</pre>
<p>
Escape <em class="parameter"><code>arbitrary_text</code></em> such that it's a valid key element (i.e. one
part of the key path). The escaped key won't pass <a href="gconf-gconf.html#gconf-valid-key"><code class="function">gconf_valid_key()</code></a>
because it isn't a whole key (i.e. it doesn't have a preceding
slash), but prepending a slash to the escaped text should always
result in a valid key.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>arbitrary_text</code></em> :</span></td>
<td> some text in any encoding or format
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>len</code></em> :</span></td>
<td> length of <em class="parameter"><code>arbitrary_text</code></em> in bytes, or -1 if <em class="parameter"><code>arbitrary_text</code></em> is nul-terminated
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a nul-terminated valid GConf key
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602864"></a><h3>
<a name="gconf-unescape-key"></a>gconf_unescape_key ()</h3>
<a class="indexterm" name="id2602876"></a><pre class="programlisting">char* gconf_unescape_key (const char *escaped_key,
int len);</pre>
<p>
Converts a string escaped with <a href="gconf-gconf.html#gconf-escape-key"><code class="function">gconf_escape_key()</code></a> back into its original
form.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>escaped_key</code></em> :</span></td>
<td> a key created with <a href="gconf-gconf.html#gconf-escape-key"><code class="function">gconf_escape_key()</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>len</code></em> :</span></td>
<td> length of <em class="parameter"><code>escaped_key</code></em> in bytes, or -1 if <em class="parameter"><code>escaped_key</code></em> is nul-terminated
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the original string that was escaped to create <em class="parameter"><code>escaped_key</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602996"></a><h3>
<a name="gconf-engine-get-float"></a>gconf_engine_get_float ()</h3>
<a class="indexterm" name="id2603008"></a><pre class="programlisting">gdouble gconf_engine_get_float (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);</pre>
<p>
Requests the floating point number (<code class="literal">GCONF_VALUE_FLOAT</code>) stored at
<em class="parameter"><code>key</code></em>. Automatically performs type-checking, so if a non-float is
stored at <em class="parameter"><code>key</code></em>, an error is returned. On error, or if <em class="parameter"><code>key</code></em> is unset,
0.0 is returned.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want the value of.
</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>the value of <em class="parameter"><code>key</code></em>, or 0.0 if no value is obtained.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603159"></a><h3>
<a name="gconf-engine-get-int"></a>gconf_engine_get_int ()</h3>
<a class="indexterm" name="id2603170"></a><pre class="programlisting">gint gconf_engine_get_int (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);</pre>
<p>
Requests the integer (<code class="literal">GCONF_VALUE_INT</code>) stored at
<em class="parameter"><code>key</code></em>. Automatically performs type-checking, so if a non-integer is
stored at <em class="parameter"><code>key</code></em>, an error is returned. On error, or if <em class="parameter"><code>key</code></em> is unset,
0 is returned.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want the value of.
</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>the value of <em class="parameter"><code>key</code></em>, or 0 if no value is obtained.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603321"></a><h3>
<a name="gconf-engine-get-string"></a>gconf_engine_get_string ()</h3>
<a class="indexterm" name="id2603332"></a><pre class="programlisting">gchar* gconf_engine_get_string (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);</pre>
<p>
Requests the string (<code class="literal">GCONF_VALUE_STRING</code>) stored at
<em class="parameter"><code>key</code></em>. Automatically performs type-checking, so if a non-string is
stored at <em class="parameter"><code>key</code></em>, an error is returned. On error, or if <em class="parameter"><code>key</code></em> is unset,
<span class="symbol">NULL</span> is returned.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want the value of.
</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>allocated string (value of <em class="parameter"><code>key</code></em>), or <span class="symbol">NULL</span> if no value is obtained.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603490"></a><h3>
<a name="gconf-engine-get-bool"></a>gconf_engine_get_bool ()</h3>
<a class="indexterm" name="id2603502"></a><pre class="programlisting">gboolean gconf_engine_get_bool (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);</pre>
<p>
Requests the boolean value (<code class="literal">GCONF_VALUE_BOOL</code>) stored at
<em class="parameter"><code>key</code></em>. Automatically performs type-checking, so if a non-bool is
stored at <em class="parameter"><code>key</code></em>, an error is returned. On error, or if <em class="parameter"><code>key</code></em> is unset,
<span class="symbol">FALSE</span> is returned.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want the value of.
</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>the value of <em class="parameter"><code>key</code></em>, or <span class="symbol">FALSE</span> if no value is obtained.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603660"></a><h3>
<a name="gconf-engine-get-schema"></a>gconf_engine_get_schema ()</h3>
<a class="indexterm" name="id2603671"></a><pre class="programlisting"><a href="gconf-gconf-schema.html#GConfSchema">GConfSchema</a>* gconf_engine_get_schema (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
GError **err);</pre>
<p>
Requests the schema (<code class="literal">GCONF_VALUE_SCHEMA</code>) stored at <em class="parameter"><code>key</code></em>.
Automatically performs type-checking, so if a non-schema is stored at
<em class="parameter"><code>key</code></em>, an error is returned. If no value is set or an error occurs,
<span class="symbol">NULL</span> is returned.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want the value of.
</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>the value of <em class="parameter"><code>key</code></em> as an allocated <a href="gconf-gconf-schema.html#GConfSchema"><span class="type">GConfSchema</span></a>, or <span class="symbol">NULL</span> if no value was obtained.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603831"></a><h3>
<a name="gconf-engine-get-list"></a>gconf_engine_get_list ()</h3>
<a class="indexterm" name="id2603842"></a><pre class="programlisting">GSList* gconf_engine_get_list (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> list_type,
GError **err);</pre>
<p>
Requests the list (<code class="literal">GCONF_VALUE_LIST</code>) stored at <em class="parameter"><code>key</code></em>. Automatically
performs type-checking, so if a non-list is stored at <em class="parameter"><code>key</code></em>, or the
list does not contain elements of type <em class="parameter"><code>list_type</code></em>, an error is
returned. If no value is set or an error occurs, <span class="symbol">NULL</span>
is returned. Note that <span class="symbol">NULL</span> is also the empty list,
so if you need to distinguish the empty list from an unset value, you
must use <a href="gconf-gconf.html#gconf-engine-get"><code class="function">gconf_engine_get()</code></a> to obtain a raw <a href="gconf-gconf-value.html#GConfValue"><span class="type">GConfValue</span></a>.
</p>
<p>
<span class="emphasis"><em>Remember that GConf lists can only store primitive types:
<code class="literal">GCONF_VALUE_FLOAT</code>, <code class="literal">GCONF_VALUE_INT</code>, <code class="literal">GCONF_VALUE_BOOL</code>,
<code class="literal">GCONF_VALUE_STRING</code>, <code class="literal">GCONF_VALUE_SCHEMA</code>.</em></span> Also remember
that lists must be uniform, you may not mix types in the same list.
</p>
<p>
The type of the list elements depends on <em class="parameter"><code>list_type</code></em>. A <a href="gconf-gconf-value.html#GConfValue"><span class="type">GConfValue</span></a>
with type <code class="literal">GCONF_VALUE_LIST</code> normally stores a list of more <a href="gconf-gconf-value.html#GConfValue"><span class="type">GConfValue</span></a>
objects. <a href="gconf-gconf.html#gconf-engine-get-list"><code class="function">gconf_engine_get_list()</code></a> automatically converts to primitive C
types. Thus, the list->data fields in the returned list
contain:
</p>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td><code class="literal">GCONF_VALUE_INT</code></td>
<td>The integer itself, converted with <code class="function">GINT_TO_POINTER()</code>
</td>
</tr>
<tr>
<td><code class="literal">GCONF_VALUE_BOOL</code></td>
<td>The bool itself, converted with <code class="function">GINT_TO_POINTER()</code>
</td>
</tr>
<tr>
<td><code class="literal">GCONF_VALUE_FLOAT</code></td>
<td>A pointer to <span class="type">gdouble</span>, which should be freed with <code class="function">g_free()</code>
</td>
</tr>
<tr>
<td><code class="literal">GCONF_VALUE_STRING</code></td>
<td>A pointer to <span class="type">gchar</span>, which should be freed with <code class="function">g_free()</code>
</td>
</tr>
<tr>
<td><code class="literal">GCONF_VALUE_SCHEMA</code></td>
<td>A pointer to <a href="gconf-gconf-schema.html#GConfSchema"><span class="type">GConfSchema</span></a>, which should be freed with <a href="gconf-gconf-schema.html#gconf-schema-free"><code class="function">gconf_schema_free()</code></a>
</td>
</tr>
</tbody>
</table></div>
<p>
In the <code class="literal">GCONF_VALUE_FLOAT</code> and <code class="literal">GCONF_VALUE_STRING</code> cases, you must
<code class="function">g_free()</code> each list element. In the <code class="literal">GCONF_VALUE_SCHEMA</code> case you must
<a href="gconf-gconf-schema.html#gconf-schema-free"><code class="function">gconf_schema_free()</code></a> each element. In all cases you must free the
list itself with <code class="function">g_slist_free()</code>.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want the value of.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>list_type</code></em> :</span></td>
<td>type of each list element.
</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>an allocated list, with elements as described above.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604326"></a><h3>
<a name="gconf-engine-get-pair"></a>gconf_engine_get_pair ()</h3>
<a class="indexterm" name="id2604337"></a><pre class="programlisting">gboolean gconf_engine_get_pair (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> car_type,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> cdr_type,
gpointer car_retloc,
gpointer cdr_retloc,
GError **err);</pre>
<p>
Requests the pair (<code class="literal">GCONF_VALUE_PAIR</code>) stored at <em class="parameter"><code>key</code></em>. Automatically
performs type-checking, so if a non-pair is stored at <em class="parameter"><code>key</code></em>, or the
pair does not have the right <em class="parameter"><code>car_type</code></em> and <em class="parameter"><code>cdr_type</code></em>, an error is
returned. Remember that the <em class="firstterm">car</em> of a pair is
its first value, and the <em class="firstterm">cdr</em> is its second
value, in the Lisp tradition.
</p>
<p>
<span class="emphasis"><em>Remember that GConf pairs can only store primitive types:
<code class="literal">GCONF_VALUE_FLOAT</code>, <code class="literal">GCONF_VALUE_INT</code>, <code class="literal">GCONF_VALUE_BOOL</code>,
<code class="literal">GCONF_VALUE_STRING</code>, <code class="literal">GCONF_VALUE_SCHEMA</code>.</em></span>
</p>
<p>
<a href="gconf-gconf.html#gconf-engine-get-pair"><code class="function">gconf_engine_get_pair()</code></a> stores the two fields of the pair in the locations
pointed to by <em class="parameter"><code>car_retloc</code></em> and <em class="parameter"><code>cdr_retloc</code></em>. The type of these pointers
depends on the corresponding <em class="parameter"><code>car_type</code></em> and <em class="parameter"><code>cdr_type</code></em>:
</p>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td><code class="literal">GCONF_VALUE_INT</code></td>
<td>pointer to <span class="type">gint</span>
</td>
</tr>
<tr>
<td><code class="literal">GCONF_VALUE_BOOL</code></td>
<td>pointer to <span class="type">gboolean</span>
</td>
</tr>
<tr>
<td><code class="literal">GCONF_VALUE_FLOAT</code></td>
<td>pointer to <span class="type">gdouble</span>
</td>
</tr>
<tr>
<td><code class="literal">GCONF_VALUE_STRING</code></td>
<td>pointer to <span class="type">gchar</span>*</td>
</tr>
<tr>
<td><code class="literal">GCONF_VALUE_SCHEMA</code></td>
<td>pointer to <a href="gconf-gconf-schema.html#GConfSchema"><span class="type">GConfSchema</span></a>*</td>
</tr>
</tbody>
</table></div>
<p>
In the <code class="literal">GCONF_VALUE_STRING</code> case, you must <code class="function">g_free()</code> the string(s)
stored in the return location(s). In the <code class="literal">GCONF_VALUE_SCHEMA</code> case you
must <a href="gconf-gconf-schema.html#gconf-schema-free"><code class="function">gconf_schema_free()</code></a> the returned schema. If there's an error
or the value is unset, <em class="parameter"><code>car_retloc</code></em> and <em class="parameter"><code>cdr_retloc</code></em> are left unchanged.
</p>
<p>
<a href="gconf-gconf.html#gconf-engine-get-pair"><code class="function">gconf_engine_get_pair()</code></a> returns <span class="symbol">TRUE</span> on success.
</p>
<p>
An example of <a href="gconf-gconf.html#gconf-engine-get-pair"><code class="function">gconf_engine_get_pair()</code></a> in action:
</p>
<pre class="programlisting">
gdouble car = 10.0;
gchar* cdr = NULL;
GError* error = NULL;
if (!gconf_engine_get_pair(conf, "/foo",
GCONF_VALUE_FLOAT,
GCONF_VALUE_STRING,
&car, &cdr, &error))
{
/* Note: car/cdr should be untouched, because an error occurred */
g_assert(error != NULL);
fprintf(stderr, "Error: <code class="literal">s</code>\n", error->message);
g_error_free(error);
error = NULL;
}
else
{
/* Note: car/cdr may be untouched even though there was no error,
if no value was set for "/foo"
*/
printf("Found pair (<code class="literal">g</code>,<code class="literal">s</code>)\n", car, cdr);
if (cdr != NULL)
g_free(cdr);
}
</pre>
<p>
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want the value of.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>car_type</code></em> :</span></td>
<td>desired type of the pair's first field (car).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>cdr_type</code></em> :</span></td>
<td>desired type of the pair's second field (cdr).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>car_retloc</code></em> :</span></td>
<td>address of a return location for the car.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>cdr_retloc</code></em> :</span></td>
<td>address of a return location for the cdr.
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604906"></a><h3>
<a name="gconf-engine-set-float"></a>gconf_engine_set_float ()</h3>
<a class="indexterm" name="id2604917"></a><pre class="programlisting">gboolean gconf_engine_set_float (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
gdouble val,
GError **err);</pre>
<p>
Change the value of <em class="parameter"><code>key</code></em> to <em class="parameter"><code>val</code></em>. Automatically creates the <em class="parameter"><code>key</code></em> if it didn't exist before (ie it was unset or it only had a default value). If the key already exists but doesn't store a float (GCONF_VALUE_FLOAT), <a href="gconf-gconf.html#gconf-engine-set-float"><code class="function">gconf_engine_set_float()</code></a> will fail.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want to set the value of.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>val</code></em> :</span></td>
<td>new value of <em class="parameter"><code>key</code></em>.
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605100"></a><h3>
<a name="gconf-engine-set-int"></a>gconf_engine_set_int ()</h3>
<a class="indexterm" name="id2605111"></a><pre class="programlisting">gboolean gconf_engine_set_int (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
gint val,
GError **err);</pre>
<p>
Change the value of <em class="parameter"><code>key</code></em> to <em class="parameter"><code>val</code></em>. Automatically creates the <em class="parameter"><code>key</code></em> if it didn't exist before (ie it was unset or it only had a default value). If the key already exists but doesn't store an integer (GCONF_VALUE_INT), <a href="gconf-gconf.html#gconf-engine-set-int"><code class="function">gconf_engine_set_int()</code></a> will fail.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want to set the value of.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>val</code></em> :</span></td>
<td>new value of <em class="parameter"><code>key</code></em>.
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605293"></a><h3>
<a name="gconf-engine-set-string"></a>gconf_engine_set_string ()</h3>
<a class="indexterm" name="id2605304"></a><pre class="programlisting">gboolean gconf_engine_set_string (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const gchar *val,
GError **err);</pre>
<p>
Change the value of <em class="parameter"><code>key</code></em> to <em class="parameter"><code>val</code></em>. Automatically creates the <em class="parameter"><code>key</code></em> if it didn't exist before (ie it was unset or it only had a default value). If the key already exists but doesn't store a string (GCONF_VALUE_STRING), <a href="gconf-gconf.html#gconf-engine-set-string"><code class="function">gconf_engine_set_string()</code></a> will fail.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want to set the value of.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>val</code></em> :</span></td>
<td>new value of <em class="parameter"><code>key</code></em>.
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605487"></a><h3>
<a name="gconf-engine-set-bool"></a>gconf_engine_set_bool ()</h3>
<a class="indexterm" name="id2605498"></a><pre class="programlisting">gboolean gconf_engine_set_bool (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
gboolean val,
GError **err);</pre>
<p>
Change the value of <em class="parameter"><code>key</code></em> to <em class="parameter"><code>val</code></em>. Automatically creates the <em class="parameter"><code>key</code></em> if it didn't exist before (ie it was unset or it only had a default value). If the key already exists but but doesn't store a boolean (GCONF_VALUE_BOOL), <a href="gconf-gconf.html#gconf-engine-set-bool"><code class="function">gconf_engine_set_bool()</code></a> will fail.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want to set the value of.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>val</code></em> :</span></td>
<td>new value of <em class="parameter"><code>key</code></em>.
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605681"></a><h3>
<a name="gconf-engine-set-schema"></a>gconf_engine_set_schema ()</h3>
<a class="indexterm" name="id2605692"></a><pre class="programlisting">gboolean gconf_engine_set_schema (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const <a href="gconf-gconf-schema.html#GConfSchema">GConfSchema</a> *val,
GError **err);</pre>
<p>
Change the value of <em class="parameter"><code>key</code></em> to <em class="parameter"><code>val</code></em>. Automatically creates the <em class="parameter"><code>key</code></em> if it didn't exist before (ie it was unset or it only had a default value). If the key already exists but doesn't store a schema value (GCONF_VALUE_SCHEMA), <a href="gconf-gconf.html#gconf-engine-set-schema"><code class="function">gconf_engine_set_schema()</code></a> will fail.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want to set the value of.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>val</code></em> :</span></td>
<td>new value of <em class="parameter"><code>key</code></em>.
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605874"></a><h3>
<a name="gconf-engine-set-list"></a>gconf_engine_set_list ()</h3>
<a class="indexterm" name="id2605886"></a><pre class="programlisting">gboolean gconf_engine_set_list (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> list_type,
GSList *list,
GError **err);</pre>
<p>
Change the value of <em class="parameter"><code>key</code></em> to <em class="parameter"><code>list</code></em> of type <em class="parameter"><code>list_type</code></em>. Automatically creates the <em class="parameter"><code>key</code></em> if it didn't exist before
(ie it was unset or it only had a default value). If the key already exists but doesn't store a list value
(GCONF_VALUE_LIST), <a href="gconf-gconf.html#gconf-engine-set-list"><code class="function">gconf_engine_set_list()</code></a> will fail.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want to set the value of.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>list_type</code></em> :</span></td>
<td>type of each list element.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>list</code></em> :</span></td>
<td>new value of <em class="parameter"><code>key</code></em>.
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606096"></a><h3>
<a name="gconf-engine-set-pair"></a>gconf_engine_set_pair ()</h3>
<a class="indexterm" name="id2606107"></a><pre class="programlisting">gboolean gconf_engine_set_pair (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> car_type,
<a href="gconf-gconf-value.html#GConfValueType">GConfValueType</a> cdr_type,
gconstpointer address_of_car,
gconstpointer address_of_cdr,
GError **err);</pre>
<p>
Change the value of <em class="parameter"><code>key</code></em> to a pair of first type <em class="parameter"><code>car_type</code></em> and second type <em class="parameter"><code>cdr_type</code></em> . Automatically creates the
<em class="parameter"><code>key</code></em> if it didn't exist before (ie it was unset or it only had a default value). If the key already exists
but doesn't store a schema value (GCONF_VALUE_SCHEMA), <a href="gconf-gconf.html#gconf-engine-set-schema"><code class="function">gconf_engine_set_schema()</code></a> will fail.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>key you want to set the value of.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>car_type</code></em> :</span></td>
<td>type of the pair's first field (car).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>cdr_type</code></em> :</span></td>
<td>type of the pair's second field (cdr).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>address_of_car</code></em> :</span></td>
<td>address of the car.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>address_of_cdr</code></em> :</span></td>
<td>address of the cdr.
</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>
<span class="symbol">TRUE</span> on success, <span class="symbol">FALSE</span> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606356"></a><h3>
<a name="GConfEnumStringPair"></a>GConfEnumStringPair</h3>
<a class="indexterm" name="id2606367"></a><pre class="programlisting">typedef struct {
gint enum_value;
const gchar* str;
} GConfEnumStringPair;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606384"></a><h3>
<a name="gconf-string-to-enum"></a>gconf_string_to_enum ()</h3>
<a class="indexterm" name="id2606396"></a><pre class="programlisting">gboolean gconf_string_to_enum (<a href="gconf-gconf.html#GConfEnumStringPair">GConfEnumStringPair</a> lookup_table[],
const gchar *str,
gint *enum_value_retloc);</pre>
<p>
It's best to store enumeration values as strings rather than integers. This is
robust against changes in the enumeration, and also human-readable.
This function makes it more convenient to store enums as strings.
</p>
<p>
The first argument is a lookup table, typically declared statically as follows:
</p>
<pre class="programlisting">
static GConfEnumStringPair foo_enum_lookup_table[] = {
{ FOO_BLAH, "Blah" },
{ FOO_BAR, "Bar" },
{ 0, NULL }
};
</pre>
<p>
Note that the last element of the table is <code class="literal">{ 0, NULL }</code>.
Typically the strings you use should be semi-human-readable, for GTK+ and GNOME
stripping off the library prefix and converting to StudlyCaps is the recommended
convention.
</p>
<p>
The function returns <span class="symbol">TRUE</span> if a match for the string is found,
and if a match is found the enum value is placed in <em class="parameter"><code>enum_value_retloc</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>lookup_table</code></em> :</span></td>
<td>a lookup table mapping enum values to strings.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>str</code></em> :</span></td>
<td>the string to convert to an enum value.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>enum_value_retloc</code></em> :</span></td>
<td>the address of an enum variable.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
<span class="symbol">TRUE</span> if a match was found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606541"></a><h3>
<a name="gconf-enum-to-string"></a>gconf_enum_to_string ()</h3>
<a class="indexterm" name="id2606552"></a><pre class="programlisting">const gchar* gconf_enum_to_string (<a href="gconf-gconf.html#GConfEnumStringPair">GConfEnumStringPair</a> lookup_table[],
gint enum_value);</pre>
<p>
See <a href="gconf-gconf.html#gconf-string-to-enum"><code class="function">gconf_string_to_enum()</code></a> for background information on this function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>lookup_table</code></em> :</span></td>
<td>a lookup table mapping enum values to strings.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>enum_value</code></em> :</span></td>
<td>the enumeration value to convert to a string.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a pointer to the proper string in the lookup table, or <span class="symbol">NULL</span> if no match was found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606648"></a><h3>
<a name="gconf-clear-cache"></a>gconf_clear_cache ()</h3>
<a class="indexterm" name="id2606660"></a><pre class="programlisting">void gconf_clear_cache (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
GError **err);</pre>
<p>
In case of a local <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>, this function calls <code class="function">gconf_sources_clear_cache()</code> to clear the
cache from the source. Otherwise it obtains the configuration database using <code class="function">gconf_engine_get_database()</code>
and clears the configuration database cache using <code class="function">ConfigDatabase_clear_cache()</code>.
</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>
<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>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606784"></a><h3>
<a name="gconf-synchronous-sync"></a>gconf_synchronous_sync ()</h3>
<a class="indexterm" name="id2606796"></a><pre class="programlisting">void gconf_synchronous_sync (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
GError **err);</pre>
<p>
In case of a local <a href="gconf-gconf-engine.html#GConfEngine"><span class="type">GConfEngine</span></a>, this function syncs up all the gconf sources calling
<a href="gconf-gconf.html#gconf-synchronous-sync"><code class="function">gconf_synchronous_sync()</code></a>. Otherwise it obtains the configuration database using
<code class="function">gconf_engine_get_database()</code> and syncs up the database calling <code class="function">ConfigDatabase_synchronous_sync()</code>.
</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>
<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>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606921"></a><h3>
<a name="gconf-engine-get-full"></a>gconf_engine_get_full ()</h3>
<a class="indexterm" name="id2606932"></a><pre class="programlisting"><a href="gconf-gconf-value.html#GConfValue">GConfValue</a>* gconf_engine_get_full (<a href="gconf-gconf-engine.html#GConfEngine">GConfEngine</a> *conf,
const gchar *key,
const gchar *locale,
gboolean use_schema_default,
gboolean *is_default_p,
gboolean *is_writable_p,
GError **err);</pre>
<p>
Returns the <a href="gconf-gconf-value.html#GConfValue"><span class="type">GConfValue</span></a> of a key and the associated <a href="gconf-gconf-value.html#GConfEntry"><span class="type">GConfEntry</span></a> fields depending on the parameters passed.
</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>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td>the key whose value is to be obtained.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>locale</code></em> :</span></td>
<td>the preferred locale (as in the locale related environment variables) or<span class="symbol">NULL</span> if no locale is to be
passed.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>use_schema_default</code></em> :</span></td>
<td>a <span class="type">gboolean</span> value, indicating whether schema information is to be used as the default
value.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>is_default_p</code></em> :</span></td>
<td>a <span class="type">gpointer</span> if the is_default field of the <a href="gconf-gconf-value.html#GConfEntry"><span class="type">GConfEntry</span></a> is required, <span class="symbol">NULL</span>
otherwise.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>is_writable_p</code></em> :</span></td>
<td>a <span class="type">gpointer</span> if the is_writable field of the <a href="gconf-gconf-value.html#GConfEntry"><span class="type">GConfEntry</span></a> is required, <span class="symbol">NULL</span>
otherwise.
</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>the <a href="gconf-gconf-value.html#GConfValue"><span class="type">GConfValue</span></a>.
</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-value.html"><b><< GConfValue, GConfEntry, GConfMetaInfo</b></a></td>
<td align="right"><a accesskey="n" href="gconf-gconf-locale.html"><b>gconf-locale >></b></a></td>
</tr></table>
</body>
</html>