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
<!-- ##### SECTION Stability_Level ##### -->
31
<!-- ##### SECTION Image ##### -->
34
<!-- ##### STRUCT GConfEngine ##### -->
40
<!-- ##### FUNCTION gconf_engine_get_default ##### -->
49
<!-- ##### FUNCTION gconf_engine_get_for_address ##### -->
51
Obtains a special #GConfEngine; mostly useful for specialized
52
GConf-related tools. Normal clients shouldn't need to use it.
53
As with gconf_engine_get_default(), the returned #GConfEngine should be
54
unreferenced by the caller of this function.
57
@address: a configuration source address.
58
@err: the return location for an allocated #GError, or <symbol>NULL</symbol> to ignore errors.
59
@Returns: a #GConfEngine.
62
<!-- ##### FUNCTION gconf_engine_get_for_addresses ##### -->
64
Similar to gconf_engine_get_for_address() , but takes a list of addresses
65
instead of a single address.
68
@addresses: a list of configuration addresses.
69
@err: the return location for an allocated #GError, or <symbol>NULL</symbol> to ignore errors.
70
@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.
91
<!-- ##### FUNCTION gconf_engine_get_local ##### -->
93
Obtain a local (non-process-transparent) #GConfEngine. Local engines
94
do not support notification, and can only access config databases
95
directly (they do not use the multiple sources in a path system
96
supported by nonlocal engines).
99
@address: address of local database.
100
@err: return location of an allocated #GError.
101
@Returns: a #GConfEngine.
104
<!-- ##### FUNCTION gconf_engine_get_local_for_addresses ##### -->
106
Obtains a local #GConfEngine similar to gconf_engine_get_local ().
107
Instead of taking the address of the local database, this function takes
108
the addresses of the sources and gets the #GConfSources using gconf_sources_new_from_addresses ().
111
@addresses: a list of addresses of #GConfSources.
112
@err: the return location for an allocated #GError, or <symbol>NULL</symbol> to ignore errors.
113
@Returns: a #GConfEngine.
117
<!-- ##### FUNCTION gconf_engine_set_user_data ##### -->
119
Sets the user_data and the destroy notification function fields of a #GConfEngine.
122
@engine: a #GConfEngine.
124
@dnotify: a pointer to the function to be called during destroy.
127
<!-- ##### FUNCTION gconf_engine_get_user_data ##### -->
129
Returns the user_data field of a #GConfEngine.
132
@engine: a #GConfEngine.
133
@Returns: a pointer to the user_data.
added
removed
doc/gconf/tmpl/gconf-engine.sgml
