1
<!-- ##### SECTION Title ##### -->
4
<!-- ##### SECTION Short_Description ##### -->
8
<!-- ##### SECTION Long_Description ##### -->
10
A #GConfEngine represents a connection to the GConf database. The
11
default #GConfEngine, returned from gconf_engine_get_default(), represents the
12
user's normal configuration source search path. Configuration-related
13
utilities, such as a configuration editor tool, might wish to access a
14
particular configuration source directly; they can obtain a
15
non-default #GConfEngine with gconf_engine_get_for_address().
19
Once you have a #GConfEngine, you can query and manipulate
23
<!-- ##### SECTION See_Also ##### -->
28
<!-- ##### STRUCT GConfEngine ##### -->
30
An opaque data type representing one or more configuration sources.
34
<!-- ##### FUNCTION gconf_engine_get_default ##### -->
36
Returns the default #GConfEngine. All clients should use this, unless
37
they are special configuration-related tools. The caller of this
38
function assumes one reference count, and must call
39
gconf_engine_unref() at some point. It's fairly important to unref the
40
#GConfEngine, to cleanly close the connection to
41
<application>gconfd</application>. So if possible close the connection
42
before exiting your application.
45
@Returns: the default #GConfEngine.
48
<!-- ##### FUNCTION gconf_engine_get_for_address ##### -->
50
Obtains a special #GConfEngine; mostly useful for specialized
51
GConf-related tools. Normal clients shouldn't need to use it.
52
As with gconf_engine_get_default(), the returned #GConfEngine should be
53
unreferenced by the caller of this function.
56
@address: a configuration source address.
57
@err: the return location for an allocated #GError, or <symbol>NULL</symbol> to ignore errors.
58
@Returns: a #GConfEngine.
61
<!-- ##### FUNCTION gconf_engine_get_local ##### -->
63
Obtain a local (non-process-transparent) #GConfEngine. Local engines
64
do not support notification, and can only access config databases
65
directly (they do not use the multiple sources in a path system
66
supported by nonlocal engines).
69
@address: address of local database
70
@err: return location of an allocated #GError
71
@Returns: a #GConfEngine
74
<!-- ##### FUNCTION gconf_engine_unref ##### -->
76
Decreases the reference count of a #GConfEngine by one; if the
77
reference count reaches 0, destroys the #GConfEngine.
80
@conf: a #GConfEngine.
83
<!-- ##### FUNCTION gconf_engine_ref ##### -->
85
Increases the reference count of a #GConfEngine by one.
88
@conf: a #GConfEngine.
added
removed
doc/gconf/tmpl/gconf-engine.sgml
