← Back to branch summary

~ubuntu-branches/ubuntu/trusty/glib2.0/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/glib/xml/keyfile.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-23 19:25:52 UTC
  • mfrom: (3.4.9 experimental)
  • Revision ID: james.westby@ubuntu.com-20100323192552-istna8c33bw6harh
Tags: 2.23.6-1ubuntu1
* Resync on Debian
* debian/patches/01_gettext-desktopfiles.patch:
  - updated to use gettext for X-GNOME-Fullname too
* debian/patches/71_gio_launch_handler.patch:
  - new gio default launch handle feature required for wncksync
* debian/control.in, 
  debian/patches/80-gtester-subunit.patch:
  - gtester-report subunit support
* debian/libglib2.0-0.symbols:
  - updated the symbols list for the gio launcher handler

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/glib/xml/keyfile.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
5
 
<!ENTITY version SYSTEM "version.xml">
6
 
]>
7
 
<refentry id="glib-Key-value-file-parser">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="glib-Key-value-file-parser.top_of_page">Key-value file parser</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>GLIB Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>Key-value file parser</refname>
16
 
<refpurpose>parses <filename>.ini</filename>-like config files</refpurpose>
17
 
</refnamediv>
18
 
 
19
 
<refsynopsisdiv id="glib-Key-value-file-parser.synopsis" role="synopsis">
20
 
<title role="synopsis.title">Synopsis</title>
21
 
 
22
 
<synopsis>
23
 
 
24
 
#include &lt;glib.h&gt;
25
 
 
26
 
                    <link linkend="GKeyFile">GKeyFile</link>;
27
 
#define             <link linkend="G-KEY-FILE-ERROR--CAPS">G_KEY_FILE_ERROR</link>
28
 
enum                <link linkend="GKeyFileError">GKeyFileError</link>;
29
 
enum                <link linkend="GKeyFileFlags">GKeyFileFlags</link>;
30
 
 
31
 
<link linkend="GKeyFile">GKeyFile</link> *          <link linkend="g-key-file-new">g_key_file_new</link>                      (void);
32
 
<link linkend="void">void</link>                <link linkend="g-key-file-free">g_key_file_free</link>                     (<link linkend="GKeyFile">GKeyFile</link> *key_file);
33
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-list-separator">g_key_file_set_list_separator</link>       (<link linkend="GKeyFile">GKeyFile</link> *key_file,
34
 
                                                         <link linkend="gchar">gchar</link> separator);
35
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-key-file-load-from-file">g_key_file_load_from_file</link>           (<link linkend="GKeyFile">GKeyFile</link> *key_file,
36
 
                                                         const <link linkend="gchar">gchar</link> *file,
37
 
                                                         <link linkend="GKeyFileFlags">GKeyFileFlags</link> flags,
38
 
                                                         <link linkend="GError">GError</link> **error);
39
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-key-file-load-from-data">g_key_file_load_from_data</link>           (<link linkend="GKeyFile">GKeyFile</link> *key_file,
40
 
                                                         const <link linkend="gchar">gchar</link> *data,
41
 
                                                         <link linkend="gsize">gsize</link> length,
42
 
                                                         <link linkend="GKeyFileFlags">GKeyFileFlags</link> flags,
43
 
                                                         <link linkend="GError">GError</link> **error);
44
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-key-file-load-from-data-dirs">g_key_file_load_from_data_dirs</link>      (<link linkend="GKeyFile">GKeyFile</link> *key_file,
45
 
                                                         const <link linkend="gchar">gchar</link> *file,
46
 
                                                         <link linkend="gchar">gchar</link> **full_path,
47
 
                                                         <link linkend="GKeyFileFlags">GKeyFileFlags</link> flags,
48
 
                                                         <link linkend="GError">GError</link> **error);
49
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-key-file-load-from-dirs">g_key_file_load_from_dirs</link>           (<link linkend="GKeyFile">GKeyFile</link> *key_file,
50
 
                                                         const <link linkend="gchar">gchar</link> *file,
51
 
                                                         const <link linkend="gchar">gchar</link> **search_dirs,
52
 
                                                         <link linkend="gchar">gchar</link> **full_path,
53
 
                                                         <link linkend="GKeyFileFlags">GKeyFileFlags</link> flags,
54
 
                                                         <link linkend="GError">GError</link> **error);
55
 
<link linkend="gchar">gchar</link> *             <link linkend="g-key-file-to-data">g_key_file_to_data</link>                  (<link linkend="GKeyFile">GKeyFile</link> *key_file,
56
 
                                                         <link linkend="gsize">gsize</link> *length,
57
 
                                                         <link linkend="GError">GError</link> **error);
58
 
<link linkend="gchar">gchar</link> *             <link linkend="g-key-file-get-start-group">g_key_file_get_start_group</link>          (<link linkend="GKeyFile">GKeyFile</link> *key_file);
59
 
<link linkend="gchar">gchar</link> **            <link linkend="g-key-file-get-groups">g_key_file_get_groups</link>               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
60
 
                                                         <link linkend="gsize">gsize</link> *length);
61
 
<link linkend="gchar">gchar</link> **            <link linkend="g-key-file-get-keys">g_key_file_get_keys</link>                 (<link linkend="GKeyFile">GKeyFile</link> *key_file,
62
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
63
 
                                                         <link linkend="gsize">gsize</link> *length,
64
 
                                                         <link linkend="GError">GError</link> **error);
65
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-key-file-has-group">g_key_file_has_group</link>                (<link linkend="GKeyFile">GKeyFile</link> *key_file,
66
 
                                                         const <link linkend="gchar">gchar</link> *group_name);
67
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-key-file-has-key">g_key_file_has_key</link>                  (<link linkend="GKeyFile">GKeyFile</link> *key_file,
68
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
69
 
                                                         const <link linkend="gchar">gchar</link> *key,
70
 
                                                         <link linkend="GError">GError</link> **error);
71
 
 
72
 
<link linkend="gchar">gchar</link> *             <link linkend="g-key-file-get-value">g_key_file_get_value</link>                (<link linkend="GKeyFile">GKeyFile</link> *key_file,
73
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
74
 
                                                         const <link linkend="gchar">gchar</link> *key,
75
 
                                                         <link linkend="GError">GError</link> **error);
76
 
<link linkend="gchar">gchar</link> *             <link linkend="g-key-file-get-string">g_key_file_get_string</link>               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
77
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
78
 
                                                         const <link linkend="gchar">gchar</link> *key,
79
 
                                                         <link linkend="GError">GError</link> **error);
80
 
<link linkend="gchar">gchar</link> *             <link linkend="g-key-file-get-locale-string">g_key_file_get_locale_string</link>        (<link linkend="GKeyFile">GKeyFile</link> *key_file,
81
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
82
 
                                                         const <link linkend="gchar">gchar</link> *key,
83
 
                                                         const <link linkend="gchar">gchar</link> *locale,
84
 
                                                         <link linkend="GError">GError</link> **error);
85
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-key-file-get-boolean">g_key_file_get_boolean</link>              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
86
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
87
 
                                                         const <link linkend="gchar">gchar</link> *key,
88
 
                                                         <link linkend="GError">GError</link> **error);
89
 
<link linkend="gint">gint</link>                <link linkend="g-key-file-get-integer">g_key_file_get_integer</link>              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
90
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
91
 
                                                         const <link linkend="gchar">gchar</link> *key,
92
 
                                                         <link linkend="GError">GError</link> **error);
93
 
<link linkend="gdouble">gdouble</link>             <link linkend="g-key-file-get-double">g_key_file_get_double</link>               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
94
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
95
 
                                                         const <link linkend="gchar">gchar</link> *key,
96
 
                                                         <link linkend="GError">GError</link> **error);
97
 
<link linkend="gchar">gchar</link> **            <link linkend="g-key-file-get-string-list">g_key_file_get_string_list</link>          (<link linkend="GKeyFile">GKeyFile</link> *key_file,
98
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
99
 
                                                         const <link linkend="gchar">gchar</link> *key,
100
 
                                                         <link linkend="gsize">gsize</link> *length,
101
 
                                                         <link linkend="GError">GError</link> **error);
102
 
<link linkend="gchar">gchar</link> **            <link linkend="g-key-file-get-locale-string-list">g_key_file_get_locale_string_list</link>   (<link linkend="GKeyFile">GKeyFile</link> *key_file,
103
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
104
 
                                                         const <link linkend="gchar">gchar</link> *key,
105
 
                                                         const <link linkend="gchar">gchar</link> *locale,
106
 
                                                         <link linkend="gsize">gsize</link> *length,
107
 
                                                         <link linkend="GError">GError</link> **error);
108
 
<link linkend="gboolean">gboolean</link> *          <link linkend="g-key-file-get-boolean-list">g_key_file_get_boolean_list</link>         (<link linkend="GKeyFile">GKeyFile</link> *key_file,
109
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
110
 
                                                         const <link linkend="gchar">gchar</link> *key,
111
 
                                                         <link linkend="gsize">gsize</link> *length,
112
 
                                                         <link linkend="GError">GError</link> **error);
113
 
<link linkend="gint">gint</link> *              <link linkend="g-key-file-get-integer-list">g_key_file_get_integer_list</link>         (<link linkend="GKeyFile">GKeyFile</link> *key_file,
114
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
115
 
                                                         const <link linkend="gchar">gchar</link> *key,
116
 
                                                         <link linkend="gsize">gsize</link> *length,
117
 
                                                         <link linkend="GError">GError</link> **error);
118
 
<link linkend="gdouble">gdouble</link> *           <link linkend="g-key-file-get-double-list">g_key_file_get_double_list</link>          (<link linkend="GKeyFile">GKeyFile</link> *key_file,
119
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
120
 
                                                         const <link linkend="gchar">gchar</link> *key,
121
 
                                                         <link linkend="gsize">gsize</link> *length,
122
 
                                                         <link linkend="GError">GError</link> **error);
123
 
<link linkend="gchar">gchar</link> *             <link linkend="g-key-file-get-comment">g_key_file_get_comment</link>              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
124
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
125
 
                                                         const <link linkend="gchar">gchar</link> *key,
126
 
                                                         <link linkend="GError">GError</link> **error);
127
 
 
128
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-value">g_key_file_set_value</link>                (<link linkend="GKeyFile">GKeyFile</link> *key_file,
129
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
130
 
                                                         const <link linkend="gchar">gchar</link> *key,
131
 
                                                         const <link linkend="gchar">gchar</link> *value);
132
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-string">g_key_file_set_string</link>               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
133
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
134
 
                                                         const <link linkend="gchar">gchar</link> *key,
135
 
                                                         const <link linkend="gchar">gchar</link> *string);
136
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-locale-string">g_key_file_set_locale_string</link>        (<link linkend="GKeyFile">GKeyFile</link> *key_file,
137
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
138
 
                                                         const <link linkend="gchar">gchar</link> *key,
139
 
                                                         const <link linkend="gchar">gchar</link> *locale,
140
 
                                                         const <link linkend="gchar">gchar</link> *string);
141
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-boolean">g_key_file_set_boolean</link>              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
142
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
143
 
                                                         const <link linkend="gchar">gchar</link> *key,
144
 
                                                         <link linkend="gboolean">gboolean</link> value);
145
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-integer">g_key_file_set_integer</link>              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
146
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
147
 
                                                         const <link linkend="gchar">gchar</link> *key,
148
 
                                                         <link linkend="gint">gint</link> value);
149
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-double">g_key_file_set_double</link>               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
150
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
151
 
                                                         const <link linkend="gchar">gchar</link> *key,
152
 
                                                         <link linkend="gdouble">gdouble</link> value);
153
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-string-list">g_key_file_set_string_list</link>          (<link linkend="GKeyFile">GKeyFile</link> *key_file,
154
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
155
 
                                                         const <link linkend="gchar">gchar</link> *key,
156
 
                                                         const <link linkend="gchar">gchar</link> * const list[],
157
 
                                                         <link linkend="gsize">gsize</link> length);
158
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-locale-string-list">g_key_file_set_locale_string_list</link>   (<link linkend="GKeyFile">GKeyFile</link> *key_file,
159
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
160
 
                                                         const <link linkend="gchar">gchar</link> *key,
161
 
                                                         const <link linkend="gchar">gchar</link> *locale,
162
 
                                                         const <link linkend="gchar">gchar</link> * const list[],
163
 
                                                         <link linkend="gsize">gsize</link> length);
164
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-boolean-list">g_key_file_set_boolean_list</link>         (<link linkend="GKeyFile">GKeyFile</link> *key_file,
165
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
166
 
                                                         const <link linkend="gchar">gchar</link> *key,
167
 
                                                         <link linkend="gboolean">gboolean</link> list[],
168
 
                                                         <link linkend="gsize">gsize</link> length);
169
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-integer-list">g_key_file_set_integer_list</link>         (<link linkend="GKeyFile">GKeyFile</link> *key_file,
170
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
171
 
                                                         const <link linkend="gchar">gchar</link> *key,
172
 
                                                         <link linkend="gint">gint</link> list[],
173
 
                                                         <link linkend="gsize">gsize</link> length);
174
 
<link linkend="void">void</link>                <link linkend="g-key-file-set-double-list">g_key_file_set_double_list</link>          (<link linkend="GKeyFile">GKeyFile</link> *key_file,
175
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
176
 
                                                         const <link linkend="gchar">gchar</link> *key,
177
 
                                                         <link linkend="gdouble">gdouble</link> list[],
178
 
                                                         <link linkend="gsize">gsize</link> length);
179
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-key-file-set-comment">g_key_file_set_comment</link>              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
180
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
181
 
                                                         const <link linkend="gchar">gchar</link> *key,
182
 
                                                         const <link linkend="gchar">gchar</link> *comment,
183
 
                                                         <link linkend="GError">GError</link> **error);
184
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-key-file-remove-group">g_key_file_remove_group</link>             (<link linkend="GKeyFile">GKeyFile</link> *key_file,
185
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
186
 
                                                         <link linkend="GError">GError</link> **error);
187
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-key-file-remove-key">g_key_file_remove_key</link>               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
188
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
189
 
                                                         const <link linkend="gchar">gchar</link> *key,
190
 
                                                         <link linkend="GError">GError</link> **error);
191
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-key-file-remove-comment">g_key_file_remove_comment</link>           (<link linkend="GKeyFile">GKeyFile</link> *key_file,
192
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
193
 
                                                         const <link linkend="gchar">gchar</link> *key,
194
 
                                                         <link linkend="GError">GError</link> **error);
195
 
 
196
 
#define             <link linkend="G-KEY-FILE-DESKTOP-GROUP--CAPS">G_KEY_FILE_DESKTOP_GROUP</link>
197
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-TYPE--CAPS">G_KEY_FILE_DESKTOP_KEY_TYPE</link>
198
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-VERSION--CAPS">G_KEY_FILE_DESKTOP_KEY_VERSION</link>
199
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-NAME--CAPS">G_KEY_FILE_DESKTOP_KEY_NAME</link>
200
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-GENERIC-NAME--CAPS">G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME</link>
201
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-NO-DISPLAY--CAPS">G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY</link>
202
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-COMMENT--CAPS">G_KEY_FILE_DESKTOP_KEY_COMMENT</link>
203
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-ICON--CAPS">G_KEY_FILE_DESKTOP_KEY_ICON</link>
204
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-HIDDEN--CAPS">G_KEY_FILE_DESKTOP_KEY_HIDDEN</link>
205
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-ONLY-SHOW-IN--CAPS">G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN</link>
206
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-NOT-SHOW-IN--CAPS">G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN</link>
207
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-TRY-EXEC--CAPS">G_KEY_FILE_DESKTOP_KEY_TRY_EXEC</link>
208
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-EXEC--CAPS">G_KEY_FILE_DESKTOP_KEY_EXEC</link>
209
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-PATH--CAPS">G_KEY_FILE_DESKTOP_KEY_PATH</link>
210
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-TERMINAL--CAPS">G_KEY_FILE_DESKTOP_KEY_TERMINAL</link>
211
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-MIME-TYPE--CAPS">G_KEY_FILE_DESKTOP_KEY_MIME_TYPE</link>
212
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-CATEGORIES--CAPS">G_KEY_FILE_DESKTOP_KEY_CATEGORIES</link>
213
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-STARTUP-NOTIFY--CAPS">G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY</link>
214
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-STARTUP-WM-CLASS--CAPS">G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS</link>
215
 
#define             <link linkend="G-KEY-FILE-DESKTOP-KEY-URL--CAPS">G_KEY_FILE_DESKTOP_KEY_URL</link>
216
 
#define             <link linkend="G-KEY-FILE-DESKTOP-TYPE-APPLICATION--CAPS">G_KEY_FILE_DESKTOP_TYPE_APPLICATION</link>
217
 
#define             <link linkend="G-KEY-FILE-DESKTOP-TYPE-LINK--CAPS">G_KEY_FILE_DESKTOP_TYPE_LINK</link>
218
 
#define             <link linkend="G-KEY-FILE-DESKTOP-TYPE-DIRECTORY--CAPS">G_KEY_FILE_DESKTOP_TYPE_DIRECTORY</link>
219
 
</synopsis>
220
 
</refsynopsisdiv>
221
 
 
222
 
 
223
 
 
224
 
 
225
 
 
226
 
 
227
 
 
228
 
 
229
 
 
230
 
<refsect1 id="glib-Key-value-file-parser.description" role="desc">
231
 
<title role="desc.title">Description</title>
232
 
<para>
233
 
<link linkend="GKeyFile"><type>GKeyFile</type></link> lets you parse, edit or create files containing groups of
234
 
key-value pairs, which we call <firstterm>key files</firstterm> for
235
 
lack of a better name. Several freedesktop.org specifications use
236
 
key files now, e.g the
237
 
<ulink url="http://freedesktop.org/Standards/desktop-entry-spec">Desktop
238
 
Entry Specification</ulink> and the
239
 
<ulink url="http://freedesktop.org/Standards/icon-theme-spec">Icon
240
 
Theme Specification</ulink>.
241
 
</para>
242
 
<para>
243
 
The syntax of key files is described in detail in the
244
 
<ulink url="http://freedesktop.org/Standards/desktop-entry-spec">Desktop
245
 
Entry Specification</ulink>, here is a quick summary: Key files
246
 
consists of groups of key-value pairs, interspersed with comments.
247
 
</para>
248
 
<informalexample><programlisting>
249
 
# this is just an example
250
 
# there can be comments before the first group
251
 
[First Group]
252
 
Name=Key File Example\tthis value shows\nescaping
253
 
# localized strings are stored in multiple key-value pairs
254
 
Welcome=Hello
255
 
Welcome[de]=Hallo
256
 
Welcome[fr_FR]=Bonjour
257
 
Welcome[it]=Ciao
258
 
Welcome[be@latin]=Hello
259
 
[Another Group]
260
 
Numbers=2;20;-200;0
261
 
Booleans=true;false;true;true
262
 
</programlisting></informalexample>
263
 
<para>
264
 
Lines beginning with a '#' and blank lines are considered comments.
265
 
</para>
266
 
<para>
267
 
Groups are started by a header line containing the group name enclosed
268
 
in '[' and ']', and ended implicitly by the start of the next group or
269
 
the end of the file. Each key-value pair must be contained in a group.
270
 
</para>
271
 
<para>
272
 
Key-value pairs generally have the form <literal>key=value</literal>,
273
 
with the exception of localized strings, which have the form
274
 
<literal>key[locale]=value</literal>, with a locale identifier of the form
275
 
<literal>lang_COUNTRY<parameter>MODIFIER</parameter></literal> where <literal>COUNTRY</literal> and
276
 
<literal>MODIFIER</literal> are optional. Space before and after the
277
 
'=' character are ignored. Newline, tab, carriage return and backslash
278
 
characters in value are escaped as \n, \t, \r, and \\, respectively.
279
 
To preserve leading spaces in values, these can also be escaped as \s.
280
 
</para>
281
 
<para>
282
 
Key files can store strings (possibly with localized variants), integers,
283
 
booleans and lists of these. Lists are separated by a separator character,
284
 
typically ';' or ','. To use the list separator character in a value in
285
 
a list, it has to be escaped by prefixing it with a backslash.
286
 
</para>
287
 
<para>
288
 
This syntax is obviously inspired by the <filename>.ini</filename>
289
 
files commonly met on Windows, but there are some important differences:
290
 
<itemizedlist>
291
 
<listitem><para>
292
 
<filename>.ini</filename> files use the ';' character to begin comments,
293
 
 key files use the '#' character.
294
 
</para></listitem>
295
 
<listitem><para>
296
 
Key files do not allow for ungrouped keys meaning only comments can precede the first group.
297
 
</para></listitem>
298
 
<listitem><para>
299
 
Key files are always encoded in UTF-8.
300
 
</para></listitem>
301
 
<listitem><para>
302
 
Key and Group names are case-sensitive, for example a group called
303
 
<literal>[GROUP]</literal> is a different group from <literal>[group]</literal>.
304
 
</para></listitem>
305
 
<listitem><para>
306
 
<filename>.ini</filename> files don't have a strongly typed boolean entry type, they only
307
 
have <literal>GetProfileInt</literal>. In <structname>GKeyFile</structname> only
308
 
<literal>true</literal> and <literal>false</literal> (in lower case) are allowed.
309
 
</para></listitem>
310
 
</itemizedlist>
311
 
</para>
312
 
<para>
313
 
Note that in contrast to the
314
 
<ulink url="http://freedesktop.org/Standards/desktop-entry-spec">Desktop
315
 
Entry Specification</ulink>, groups in key files may contain the same
316
 
key multiple times; the last entry wins. Key files may also contain
317
 
multiple groups with the same name; they are merged together.
318
 
Another difference is that keys and group names in key files are not
319
 
restricted to ASCII characters.
320
 
</para>
321
 
</refsect1>
322
 
 
323
 
<refsect1 id="glib-Key-value-file-parser.details" role="details">
324
 
<title role="details.title">Details</title>
325
 
<refsect2 id="GKeyFile" role="struct">
326
 
<title>GKeyFile</title>
327
 
<indexterm zone="GKeyFile"><primary sortas="KeyFile">GKeyFile</primary></indexterm><programlisting>typedef struct _GKeyFile GKeyFile;</programlisting>
328
 
<para>
329
 
The <structname>GKeyFile</structname> struct contains only private fields
330
 
and should not be used directly.
331
 
</para></refsect2>
332
 
<refsect2 id="G-KEY-FILE-ERROR--CAPS" role="macro">
333
 
<title>G_KEY_FILE_ERROR</title>
334
 
<indexterm zone="G-KEY-FILE-ERROR--CAPS"><primary sortas="KEY_FILE_ERROR">G_KEY_FILE_ERROR</primary></indexterm><programlisting>#define G_KEY_FILE_ERROR g_key_file_error_quark()
335
 
</programlisting>
336
 
<para>
337
 
Error domain for key file parsing. Errors in this domain will
338
 
be from the <link linkend="GKeyFileError"><type>GKeyFileError</type></link> enumeration. See <link linkend="GError"><type>GError</type></link> for information on
339
 
error domains.
340
 
</para></refsect2>
341
 
<refsect2 id="GKeyFileError" role="enum">
342
 
<title>enum GKeyFileError</title>
343
 
<indexterm zone="GKeyFileError"><primary sortas="KeyFileError">GKeyFileError</primary></indexterm><programlisting>typedef enum
344
 
{
345
 
  G_KEY_FILE_ERROR_UNKNOWN_ENCODING,
346
 
  G_KEY_FILE_ERROR_PARSE,
347
 
  G_KEY_FILE_ERROR_NOT_FOUND,
348
 
  G_KEY_FILE_ERROR_KEY_NOT_FOUND,
349
 
  G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
350
 
  G_KEY_FILE_ERROR_INVALID_VALUE
351
 
} GKeyFileError;
352
 
</programlisting>
353
 
<para>
354
 
Error codes returned by key file parsing.
355
 
</para><variablelist role="enum">
356
 
<varlistentry id="G-KEY-FILE-ERROR-UNKNOWN-ENCODING--CAPS" role="constant">
357
 
<term><literal>G_KEY_FILE_ERROR_UNKNOWN_ENCODING</literal></term>
358
 
<listitem><simpara>the text being parsed was in an unknown encoding
359
 
</simpara></listitem>
360
 
</varlistentry>
361
 
<varlistentry id="G-KEY-FILE-ERROR-PARSE--CAPS" role="constant">
362
 
<term><literal>G_KEY_FILE_ERROR_PARSE</literal></term>
363
 
<listitem><simpara>document was ill-formed
364
 
</simpara></listitem>
365
 
</varlistentry>
366
 
<varlistentry id="G-KEY-FILE-ERROR-NOT-FOUND--CAPS" role="constant">
367
 
<term><literal>G_KEY_FILE_ERROR_NOT_FOUND</literal></term>
368
 
<listitem><simpara>the file was not found
369
 
</simpara></listitem>
370
 
</varlistentry>
371
 
<varlistentry id="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS" role="constant">
372
 
<term><literal>G_KEY_FILE_ERROR_KEY_NOT_FOUND</literal></term>
373
 
<listitem><simpara>a requested key was not found
374
 
</simpara></listitem>
375
 
</varlistentry>
376
 
<varlistentry id="G-KEY-FILE-ERROR-GROUP-NOT-FOUND--CAPS" role="constant">
377
 
<term><literal>G_KEY_FILE_ERROR_GROUP_NOT_FOUND</literal></term>
378
 
<listitem><simpara>a requested group was not found
379
 
</simpara></listitem>
380
 
</varlistentry>
381
 
<varlistentry id="G-KEY-FILE-ERROR-INVALID-VALUE--CAPS" role="constant">
382
 
<term><literal>G_KEY_FILE_ERROR_INVALID_VALUE</literal></term>
383
 
<listitem><simpara>a value could not be parsed
384
 
</simpara></listitem>
385
 
</varlistentry>
386
 
</variablelist></refsect2>
387
 
<refsect2 id="GKeyFileFlags" role="enum">
388
 
<title>enum GKeyFileFlags</title>
389
 
<indexterm zone="GKeyFileFlags"><primary sortas="KeyFileFlags">GKeyFileFlags</primary></indexterm><programlisting>typedef enum
390
 
{
391
 
  G_KEY_FILE_NONE              = 0,
392
 
  G_KEY_FILE_KEEP_COMMENTS     = 1 &lt;&lt; 0,
393
 
  G_KEY_FILE_KEEP_TRANSLATIONS = 1 &lt;&lt; 1
394
 
} GKeyFileFlags;
395
 
</programlisting>
396
 
<para>
397
 
Flags which influence the parsing.
398
 
</para><variablelist role="enum">
399
 
<varlistentry id="G-KEY-FILE-NONE--CAPS" role="constant">
400
 
<term><literal>G_KEY_FILE_NONE</literal></term>
401
 
<listitem><simpara>No flags, default behaviour
402
 
</simpara></listitem>
403
 
</varlistentry>
404
 
<varlistentry id="G-KEY-FILE-KEEP-COMMENTS--CAPS" role="constant">
405
 
<term><literal>G_KEY_FILE_KEEP_COMMENTS</literal></term>
406
 
<listitem><simpara>Use this flag if you plan to write the (possibly modified)
407
 
  contents of the key file back to a file; otherwise all comments will be lost when
408
 
  the key file is written back.
409
 
</simpara></listitem>
410
 
</varlistentry>
411
 
<varlistentry id="G-KEY-FILE-KEEP-TRANSLATIONS--CAPS" role="constant">
412
 
<term><literal>G_KEY_FILE_KEEP_TRANSLATIONS</literal></term>
413
 
<listitem><simpara>Use this flag if you plan to write the (possibly modified)
414
 
  contents of the key file back to a file; otherwise only the translations for the current
415
 
  language will be written back.
416
 
</simpara></listitem>
417
 
</varlistentry>
418
 
</variablelist></refsect2>
419
 
<refsect2 id="g-key-file-new" role="function" condition="since:2.6">
420
 
<title>g_key_file_new ()</title>
421
 
<indexterm zone="g-key-file-new" role="2.6"><primary sortas="key_file_new">g_key_file_new</primary></indexterm><programlisting><link linkend="GKeyFile">GKeyFile</link> *          g_key_file_new                      (void);</programlisting>
422
 
<para>
423
 
Creates a new empty <link linkend="GKeyFile"><type>GKeyFile</type></link> object. Use
424
 
<link linkend="g-key-file-load-from-file"><function>g_key_file_load_from_file()</function></link>, <link linkend="g-key-file-load-from-data"><function>g_key_file_load_from_data()</function></link>,
425
 
<link linkend="g-key-file-load-from-dirs"><function>g_key_file_load_from_dirs()</function></link> or <link linkend="g-key-file-load-from-data-dirs"><function>g_key_file_load_from_data_dirs()</function></link> to
426
 
read an existing key file.</para>
427
 
<para>
428
 
</para><variablelist role="params">
429
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an empty <link linkend="GKeyFile"><type>GKeyFile</type></link>.
430
 
 
431
 
</simpara></listitem></varlistentry>
432
 
</variablelist><para role="since">Since 2.6</para></refsect2>
433
 
<refsect2 id="g-key-file-free" role="function" condition="since:2.6">
434
 
<title>g_key_file_free ()</title>
435
 
<indexterm zone="g-key-file-free" role="2.6"><primary sortas="key_file_free">g_key_file_free</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_free                     (<link linkend="GKeyFile">GKeyFile</link> *key_file);</programlisting>
436
 
<para>
437
 
Frees a <link linkend="GKeyFile"><type>GKeyFile</type></link>.</para>
438
 
<para>
439
 
</para><variablelist role="params">
440
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
441
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
442
 
</simpara></listitem></varlistentry>
443
 
</variablelist><para role="since">Since 2.6</para></refsect2>
444
 
<refsect2 id="g-key-file-set-list-separator" role="function" condition="since:2.6">
445
 
<title>g_key_file_set_list_separator ()</title>
446
 
<indexterm zone="g-key-file-set-list-separator" role="2.6"><primary sortas="key_file_set_list_separator">g_key_file_set_list_separator</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_list_separator       (<link linkend="GKeyFile">GKeyFile</link> *key_file,
447
 
                                                         <link linkend="gchar">gchar</link> separator);</programlisting>
448
 
<para>
449
 
Sets the character which is used to separate
450
 
values in lists. Typically ';' or ',' are used
451
 
as separators. The default list separator is ';'.</para>
452
 
<para>
453
 
</para><variablelist role="params">
454
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
455
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link> 
456
 
</simpara></listitem></varlistentry>
457
 
<varlistentry><term><parameter>separator</parameter>&#160;:</term>
458
 
<listitem><simpara> the separator
459
 
</simpara></listitem></varlistentry>
460
 
</variablelist><para role="since">Since 2.6</para></refsect2>
461
 
<refsect2 id="g-key-file-load-from-file" role="function" condition="since:2.6">
462
 
<title>g_key_file_load_from_file ()</title>
463
 
<indexterm zone="g-key-file-load-from-file" role="2.6"><primary sortas="key_file_load_from_file">g_key_file_load_from_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_key_file_load_from_file           (<link linkend="GKeyFile">GKeyFile</link> *key_file,
464
 
                                                         const <link linkend="gchar">gchar</link> *file,
465
 
                                                         <link linkend="GKeyFileFlags">GKeyFileFlags</link> flags,
466
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
467
 
<para>
468
 
Loads a key file into an empty <link linkend="GKeyFile"><type>GKeyFile</type></link> structure.
469
 
If the file could not be loaded then <link linkend="error"><literal>error</literal></link> is set to 
470
 
either a <link linkend="GFileError"><type>GFileError</type></link> or <link linkend="GKeyFileError"><type>GKeyFileError</type></link>.</para>
471
 
<para>
472
 
</para><variablelist role="params">
473
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
474
 
<listitem><simpara> an empty <link linkend="GKeyFile"><type>GKeyFile</type></link> struct
475
 
</simpara></listitem></varlistentry>
476
 
<varlistentry><term><parameter>file</parameter>&#160;:</term>
477
 
<listitem><simpara> the path of a filename to load, in the GLib filename encoding
478
 
</simpara></listitem></varlistentry>
479
 
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
480
 
<listitem><simpara> flags from <link linkend="GKeyFileFlags"><type>GKeyFileFlags</type></link>
481
 
</simpara></listitem></varlistentry>
482
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
483
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
484
 
</simpara></listitem></varlistentry>
485
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if a key file could be loaded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
486
 
 
487
 
</simpara></listitem></varlistentry>
488
 
</variablelist><para role="since">Since 2.6</para></refsect2>
489
 
<refsect2 id="g-key-file-load-from-data" role="function" condition="since:2.6">
490
 
<title>g_key_file_load_from_data ()</title>
491
 
<indexterm zone="g-key-file-load-from-data" role="2.6"><primary sortas="key_file_load_from_data">g_key_file_load_from_data</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_key_file_load_from_data           (<link linkend="GKeyFile">GKeyFile</link> *key_file,
492
 
                                                         const <link linkend="gchar">gchar</link> *data,
493
 
                                                         <link linkend="gsize">gsize</link> length,
494
 
                                                         <link linkend="GKeyFileFlags">GKeyFileFlags</link> flags,
495
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
496
 
<para>
497
 
Loads a key file from memory into an empty <link linkend="GKeyFile"><type>GKeyFile</type></link> structure.  
498
 
If the object cannot be created then <link linkend="error"><literal>error</literal></link> is set to a <link linkend="GKeyFileError"><type>GKeyFileError</type></link>.</para>
499
 
<para>
500
 
</para><variablelist role="params">
501
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
502
 
<listitem><simpara> an empty <link linkend="GKeyFile"><type>GKeyFile</type></link> struct
503
 
</simpara></listitem></varlistentry>
504
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
505
 
<listitem><simpara> key file loaded in memory
506
 
</simpara></listitem></varlistentry>
507
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
508
 
<listitem><simpara> the length of <parameter>data</parameter> in bytes
509
 
</simpara></listitem></varlistentry>
510
 
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
511
 
<listitem><simpara> flags from <link linkend="GKeyFileFlags"><type>GKeyFileFlags</type></link>
512
 
</simpara></listitem></varlistentry>
513
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
514
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
515
 
</simpara></listitem></varlistentry>
516
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if a key file could be loaded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
517
 
 
518
 
</simpara></listitem></varlistentry>
519
 
</variablelist><para role="since">Since 2.6</para></refsect2>
520
 
<refsect2 id="g-key-file-load-from-data-dirs" role="function" condition="since:2.6">
521
 
<title>g_key_file_load_from_data_dirs ()</title>
522
 
<indexterm zone="g-key-file-load-from-data-dirs" role="2.6"><primary sortas="key_file_load_from_data_dirs">g_key_file_load_from_data_dirs</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_key_file_load_from_data_dirs      (<link linkend="GKeyFile">GKeyFile</link> *key_file,
523
 
                                                         const <link linkend="gchar">gchar</link> *file,
524
 
                                                         <link linkend="gchar">gchar</link> **full_path,
525
 
                                                         <link linkend="GKeyFileFlags">GKeyFileFlags</link> flags,
526
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
527
 
<para>
528
 
This function looks for a key file named <parameter>file</parameter> in the paths 
529
 
returned from <link linkend="g-get-user-data-dir"><function>g_get_user_data_dir()</function></link> and <link linkend="g-get-system-data-dirs"><function>g_get_system_data_dirs()</function></link>, 
530
 
loads the file into <parameter>key_file</parameter> and returns the file's full path in 
531
 
<parameter>full_path</parameter>.  If the file could not be loaded then an <link linkend="error"><literal>error</literal></link> is
532
 
set to either a <link linkend="GFileError"><type>GFileError</type></link> or <link linkend="GKeyFileError"><type>GKeyFileError</type></link>.</para>
533
 
<para>
534
 
</para><variablelist role="params">
535
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
536
 
<listitem><simpara> an empty <link linkend="GKeyFile"><type>GKeyFile</type></link> struct
537
 
</simpara></listitem></varlistentry>
538
 
<varlistentry><term><parameter>file</parameter>&#160;:</term>
539
 
<listitem><simpara> a relative path to a filename to open and parse
540
 
</simpara></listitem></varlistentry>
541
 
<varlistentry><term><parameter>full_path</parameter>&#160;:</term>
542
 
<listitem><simpara> return location for a string containing the full path
543
 
  of the file, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
544
 
</simpara></listitem></varlistentry>
545
 
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
546
 
<listitem><simpara> flags from <link linkend="GKeyFileFlags"><type>GKeyFileFlags</type></link> 
547
 
</simpara></listitem></varlistentry>
548
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
549
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
550
 
</simpara></listitem></varlistentry>
551
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if a key file could be loaded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> othewise
552
 
</simpara></listitem></varlistentry>
553
 
</variablelist><para role="since">Since 2.6</para></refsect2>
554
 
<refsect2 id="g-key-file-load-from-dirs" role="function" condition="since:2.14">
555
 
<title>g_key_file_load_from_dirs ()</title>
556
 
<indexterm zone="g-key-file-load-from-dirs" role="2.14"><primary sortas="key_file_load_from_dirs">g_key_file_load_from_dirs</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_key_file_load_from_dirs           (<link linkend="GKeyFile">GKeyFile</link> *key_file,
557
 
                                                         const <link linkend="gchar">gchar</link> *file,
558
 
                                                         const <link linkend="gchar">gchar</link> **search_dirs,
559
 
                                                         <link linkend="gchar">gchar</link> **full_path,
560
 
                                                         <link linkend="GKeyFileFlags">GKeyFileFlags</link> flags,
561
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
562
 
<para>
563
 
This function looks for a key file named <parameter>file</parameter> in the paths
564
 
specified in <parameter>search_dirs</parameter>, loads the file into <parameter>key_file</parameter> and
565
 
returns the file's full path in <parameter>full_path</parameter>.  If the file could not
566
 
be loaded then an <link linkend="error"><literal>error</literal></link> is set to either a <link linkend="GFileError"><type>GFileError</type></link> or
567
 
<link linkend="GKeyFileError"><type>GKeyFileError</type></link>.</para>
568
 
<para>
569
 
</para><variablelist role="params">
570
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
571
 
<listitem><simpara> an empty <link linkend="GKeyFile"><type>GKeyFile</type></link> struct
572
 
</simpara></listitem></varlistentry>
573
 
<varlistentry><term><parameter>file</parameter>&#160;:</term>
574
 
<listitem><simpara> a relative path to a filename to open and parse
575
 
</simpara></listitem></varlistentry>
576
 
<varlistentry><term><parameter>search_dirs</parameter>&#160;:</term>
577
 
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated array of directories to search
578
 
</simpara></listitem></varlistentry>
579
 
<varlistentry><term><parameter>full_path</parameter>&#160;:</term>
580
 
<listitem><simpara> return location for a string containing the full path
581
 
  of the file, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
582
 
</simpara></listitem></varlistentry>
583
 
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
584
 
<listitem><simpara> flags from <link linkend="GKeyFileFlags"><type>GKeyFileFlags</type></link>
585
 
</simpara></listitem></varlistentry>
586
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
587
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
588
 
</simpara></listitem></varlistentry>
589
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if a key file could be loaded, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
590
 
 
591
 
</simpara></listitem></varlistentry>
592
 
</variablelist><para role="since">Since 2.14</para></refsect2>
593
 
<refsect2 id="g-key-file-to-data" role="function" condition="since:2.6">
594
 
<title>g_key_file_to_data ()</title>
595
 
<indexterm zone="g-key-file-to-data" role="2.6"><primary sortas="key_file_to_data">g_key_file_to_data</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             g_key_file_to_data                  (<link linkend="GKeyFile">GKeyFile</link> *key_file,
596
 
                                                         <link linkend="gsize">gsize</link> *length,
597
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
598
 
<para>
599
 
This function outputs <parameter>key_file</parameter> as a string.  
600
 
</para>
601
 
<para>
602
 
Note that this function never reports an error,
603
 
so it is safe to pass <link linkend="NULL--CAPS"><literal>NULL</literal></link> as <parameter>error</parameter>.</para>
604
 
<para>
605
 
</para><variablelist role="params">
606
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
607
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
608
 
</simpara></listitem></varlistentry>
609
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
610
 
<listitem><simpara> return location for the length of the 
611
 
  returned string, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
612
 
</simpara></listitem></varlistentry>
613
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
614
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
615
 
</simpara></listitem></varlistentry>
616
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated string holding
617
 
  the contents of the <link linkend="GKeyFile"><type>GKeyFile</type></link> 
618
 
 
619
 
</simpara></listitem></varlistentry>
620
 
</variablelist><para role="since">Since 2.6</para></refsect2>
621
 
<refsect2 id="g-key-file-get-start-group" role="function" condition="since:2.6">
622
 
<title>g_key_file_get_start_group ()</title>
623
 
<indexterm zone="g-key-file-get-start-group" role="2.6"><primary sortas="key_file_get_start_group">g_key_file_get_start_group</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             g_key_file_get_start_group          (<link linkend="GKeyFile">GKeyFile</link> *key_file);</programlisting>
624
 
<para>
625
 
Returns the name of the start group of the file.</para>
626
 
<para>
627
 
</para><variablelist role="params">
628
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
629
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
630
 
</simpara></listitem></varlistentry>
631
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The start group of the key file.
632
 
 
633
 
</simpara></listitem></varlistentry>
634
 
</variablelist><para role="since">Since 2.6</para></refsect2>
635
 
<refsect2 id="g-key-file-get-groups" role="function" condition="since:2.6">
636
 
<title>g_key_file_get_groups ()</title>
637
 
<indexterm zone="g-key-file-get-groups" role="2.6"><primary sortas="key_file_get_groups">g_key_file_get_groups</primary></indexterm><programlisting><link linkend="gchar">gchar</link> **            g_key_file_get_groups               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
638
 
                                                         <link linkend="gsize">gsize</link> *length);</programlisting>
639
 
<para>
640
 
Returns all groups in the key file loaded with <parameter>key_file</parameter>.  
641
 
The array of returned groups will be <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated, so 
642
 
<parameter>length</parameter> may optionally be <link linkend="NULL--CAPS"><literal>NULL</literal></link>.</para>
643
 
<para>
644
 
</para><variablelist role="params">
645
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
646
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
647
 
</simpara></listitem></varlistentry>
648
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
649
 
<listitem><simpara> return location for the number of returned groups, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
650
 
</simpara></listitem></varlistentry>
651
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly-allocated <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated array of strings. 
652
 
  Use <link linkend="g-strfreev"><function>g_strfreev()</function></link> to free it.
653
 
</simpara></listitem></varlistentry>
654
 
</variablelist><para role="since">Since 2.6</para></refsect2>
655
 
<refsect2 id="g-key-file-get-keys" role="function" condition="since:2.6">
656
 
<title>g_key_file_get_keys ()</title>
657
 
<indexterm zone="g-key-file-get-keys" role="2.6"><primary sortas="key_file_get_keys">g_key_file_get_keys</primary></indexterm><programlisting><link linkend="gchar">gchar</link> **            g_key_file_get_keys                 (<link linkend="GKeyFile">GKeyFile</link> *key_file,
658
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
659
 
                                                         <link linkend="gsize">gsize</link> *length,
660
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
661
 
<para>
662
 
Returns all keys for the group name <parameter>group_name</parameter>.  The array of
663
 
returned keys will be <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated, so <parameter>length</parameter> may
664
 
optionally be <link linkend="NULL--CAPS"><literal>NULL</literal></link>. In the event that the <parameter>group_name</parameter> cannot
665
 
be found, <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned and <parameter>error</parameter> is set to
666
 
<link linkend="G-KEY-FILE-ERROR-GROUP-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_GROUP_NOT_FOUND</type></link>.</para>
667
 
<para>
668
 
</para><variablelist role="params">
669
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
670
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
671
 
</simpara></listitem></varlistentry>
672
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
673
 
<listitem><simpara> a group name
674
 
</simpara></listitem></varlistentry>
675
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
676
 
<listitem><simpara> return location for the number of keys returned, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
677
 
</simpara></listitem></varlistentry>
678
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
679
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
680
 
</simpara></listitem></varlistentry>
681
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly-allocated <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated array of strings. 
682
 
    Use <link linkend="g-strfreev"><function>g_strfreev()</function></link> to free it.
683
 
 
684
 
</simpara></listitem></varlistentry>
685
 
</variablelist><para role="since">Since 2.6</para></refsect2>
686
 
<refsect2 id="g-key-file-has-group" role="function" condition="since:2.6">
687
 
<title>g_key_file_has_group ()</title>
688
 
<indexterm zone="g-key-file-has-group" role="2.6"><primary sortas="key_file_has_group">g_key_file_has_group</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_key_file_has_group                (<link linkend="GKeyFile">GKeyFile</link> *key_file,
689
 
                                                         const <link linkend="gchar">gchar</link> *group_name);</programlisting>
690
 
<para>
691
 
Looks whether the key file has the group <parameter>group_name</parameter>.</para>
692
 
<para>
693
 
</para><variablelist role="params">
694
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
695
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
696
 
</simpara></listitem></varlistentry>
697
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
698
 
<listitem><simpara> a group name
699
 
</simpara></listitem></varlistentry>
700
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>group_name</parameter> is a part of <parameter>key_file</parameter>, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>
701
 
otherwise.
702
 
</simpara></listitem></varlistentry>
703
 
</variablelist><para role="since">Since 2.6</para></refsect2>
704
 
<refsect2 id="g-key-file-has-key" role="function" condition="since:2.6">
705
 
<title>g_key_file_has_key ()</title>
706
 
<indexterm zone="g-key-file-has-key" role="2.6"><primary sortas="key_file_has_key">g_key_file_has_key</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_key_file_has_key                  (<link linkend="GKeyFile">GKeyFile</link> *key_file,
707
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
708
 
                                                         const <link linkend="gchar">gchar</link> *key,
709
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
710
 
<para>
711
 
Looks whether the key file has the key <parameter>key</parameter> in the group
712
 
<parameter>group_name</parameter>.</para>
713
 
<para>
714
 
</para><variablelist role="params">
715
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
716
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
717
 
</simpara></listitem></varlistentry>
718
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
719
 
<listitem><simpara> a group name
720
 
</simpara></listitem></varlistentry>
721
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
722
 
<listitem><simpara> a key name
723
 
</simpara></listitem></varlistentry>
724
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
725
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>
726
 
</simpara></listitem></varlistentry>
727
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>key</parameter> is a part of <parameter>group_name</parameter>, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>
728
 
otherwise.
729
 
 
730
 
</simpara></listitem></varlistentry>
731
 
</variablelist><para role="since">Since 2.6</para></refsect2>
732
 
<refsect2 id="g-key-file-get-value" role="function" condition="since:2.6">
733
 
<title>g_key_file_get_value ()</title>
734
 
<indexterm zone="g-key-file-get-value" role="2.6"><primary sortas="key_file_get_value">g_key_file_get_value</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             g_key_file_get_value                (<link linkend="GKeyFile">GKeyFile</link> *key_file,
735
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
736
 
                                                         const <link linkend="gchar">gchar</link> *key,
737
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
738
 
<para>
739
 
Returns the raw value associated with <parameter>key</parameter> under <parameter>group_name</parameter>. 
740
 
Use <link linkend="g-key-file-get-string"><function>g_key_file_get_string()</function></link> to retrieve an unescaped UTF-8 string. 
741
 
</para>
742
 
<para>
743
 
In the event the key cannot be found, <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned and 
744
 
<parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_KEY_NOT_FOUND</type></link>.  In the 
745
 
event that the <parameter>group_name</parameter> cannot be found, <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned 
746
 
and <parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-GROUP-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_GROUP_NOT_FOUND</type></link>.</para>
747
 
<para>
748
 
</para><variablelist role="params">
749
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
750
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
751
 
</simpara></listitem></varlistentry>
752
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
753
 
<listitem><simpara> a group name
754
 
</simpara></listitem></varlistentry>
755
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
756
 
<listitem><simpara> a key
757
 
</simpara></listitem></varlistentry>
758
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
759
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
760
 
</simpara></listitem></varlistentry>
761
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated string or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the specified 
762
 
 key cannot be found.
763
 
 
764
 
</simpara></listitem></varlistentry>
765
 
</variablelist><para role="since">Since 2.6</para></refsect2>
766
 
<refsect2 id="g-key-file-get-string" role="function" condition="since:2.6">
767
 
<title>g_key_file_get_string ()</title>
768
 
<indexterm zone="g-key-file-get-string" role="2.6"><primary sortas="key_file_get_string">g_key_file_get_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             g_key_file_get_string               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
769
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
770
 
                                                         const <link linkend="gchar">gchar</link> *key,
771
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
772
 
<para>
773
 
Returns the string value associated with <parameter>key</parameter> under <parameter>group_name</parameter>.
774
 
Unlike <link linkend="g-key-file-get-value"><function>g_key_file_get_value()</function></link>, this function handles escape sequences
775
 
like \s.
776
 
</para>
777
 
<para>
778
 
In the event the key cannot be found, <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned and 
779
 
<parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_KEY_NOT_FOUND</type></link>.  In the 
780
 
event that the <parameter>group_name</parameter> cannot be found, <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned 
781
 
and <parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-GROUP-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_GROUP_NOT_FOUND</type></link>.</para>
782
 
<para>
783
 
</para><variablelist role="params">
784
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
785
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
786
 
</simpara></listitem></varlistentry>
787
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
788
 
<listitem><simpara> a group name
789
 
</simpara></listitem></varlistentry>
790
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
791
 
<listitem><simpara> a key
792
 
</simpara></listitem></varlistentry>
793
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
794
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
795
 
</simpara></listitem></varlistentry>
796
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated string or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the specified 
797
 
  key cannot be found.
798
 
 
799
 
</simpara></listitem></varlistentry>
800
 
</variablelist><para role="since">Since 2.6</para></refsect2>
801
 
<refsect2 id="g-key-file-get-locale-string" role="function" condition="since:2.6">
802
 
<title>g_key_file_get_locale_string ()</title>
803
 
<indexterm zone="g-key-file-get-locale-string" role="2.6"><primary sortas="key_file_get_locale_string">g_key_file_get_locale_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             g_key_file_get_locale_string        (<link linkend="GKeyFile">GKeyFile</link> *key_file,
804
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
805
 
                                                         const <link linkend="gchar">gchar</link> *key,
806
 
                                                         const <link linkend="gchar">gchar</link> *locale,
807
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
808
 
<para>
809
 
Returns the value associated with <parameter>key</parameter> under <parameter>group_name</parameter>
810
 
translated in the given <parameter>locale</parameter> if available.  If <parameter>locale</parameter> is
811
 
<link linkend="NULL--CAPS"><literal>NULL</literal></link> then the current locale is assumed. 
812
 
</para>
813
 
<para>
814
 
If <parameter>key</parameter> cannot be found then <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned and <parameter>error</parameter> is set 
815
 
to <link linkend="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_KEY_NOT_FOUND</type></link>. If the value associated
816
 
with <parameter>key</parameter> cannot be interpreted or no suitable translation can
817
 
be found then the untranslated value is returned.</para>
818
 
<para>
819
 
</para><variablelist role="params">
820
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
821
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
822
 
</simpara></listitem></varlistentry>
823
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
824
 
<listitem><simpara> a group name
825
 
</simpara></listitem></varlistentry>
826
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
827
 
<listitem><simpara> a key
828
 
</simpara></listitem></varlistentry>
829
 
<varlistentry><term><parameter>locale</parameter>&#160;:</term>
830
 
<listitem><simpara> a locale identifier or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
831
 
</simpara></listitem></varlistentry>
832
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
833
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
834
 
</simpara></listitem></varlistentry>
835
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated string or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the specified 
836
 
  key cannot be found.
837
 
 
838
 
</simpara></listitem></varlistentry>
839
 
</variablelist><para role="since">Since 2.6</para></refsect2>
840
 
<refsect2 id="g-key-file-get-boolean" role="function" condition="since:2.6">
841
 
<title>g_key_file_get_boolean ()</title>
842
 
<indexterm zone="g-key-file-get-boolean" role="2.6"><primary sortas="key_file_get_boolean">g_key_file_get_boolean</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_key_file_get_boolean              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
843
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
844
 
                                                         const <link linkend="gchar">gchar</link> *key,
845
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
846
 
<para>
847
 
Returns the value associated with <parameter>key</parameter> under <parameter>group_name</parameter> as a
848
 
boolean. 
849
 
</para>
850
 
<para>
851
 
If <parameter>key</parameter> cannot be found then <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> is returned and <parameter>error</parameter> is set
852
 
to <link linkend="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_KEY_NOT_FOUND</type></link>. Likewise, if the value
853
 
associated with <parameter>key</parameter> cannot be interpreted as a boolean then <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>
854
 
is returned and <parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-INVALID-VALUE--CAPS"><type>G_KEY_FILE_ERROR_INVALID_VALUE</type></link>.</para>
855
 
<para>
856
 
</para><variablelist role="params">
857
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
858
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
859
 
</simpara></listitem></varlistentry>
860
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
861
 
<listitem><simpara> a group name
862
 
</simpara></listitem></varlistentry>
863
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
864
 
<listitem><simpara> a key
865
 
</simpara></listitem></varlistentry>
866
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
867
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>
868
 
</simpara></listitem></varlistentry>
869
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the value associated with the key as a boolean, 
870
 
   or <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if the key was not found or could not be parsed.
871
 
 
872
 
</simpara></listitem></varlistentry>
873
 
</variablelist><para role="since">Since 2.6</para></refsect2>
874
 
<refsect2 id="g-key-file-get-integer" role="function" condition="since:2.6">
875
 
<title>g_key_file_get_integer ()</title>
876
 
<indexterm zone="g-key-file-get-integer" role="2.6"><primary sortas="key_file_get_integer">g_key_file_get_integer</primary></indexterm><programlisting><link linkend="gint">gint</link>                g_key_file_get_integer              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
877
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
878
 
                                                         const <link linkend="gchar">gchar</link> *key,
879
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
880
 
<para>
881
 
Returns the value associated with <parameter>key</parameter> under <parameter>group_name</parameter> as an
882
 
integer. 
883
 
</para>
884
 
<para>
885
 
If <parameter>key</parameter> cannot be found then 0 is returned and <parameter>error</parameter> is set to
886
 
<link linkend="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_KEY_NOT_FOUND</type></link>. Likewise, if the value associated
887
 
with <parameter>key</parameter> cannot be interpreted as an integer then 0 is returned
888
 
and <parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-INVALID-VALUE--CAPS"><type>G_KEY_FILE_ERROR_INVALID_VALUE</type></link>.</para>
889
 
<para>
890
 
</para><variablelist role="params">
891
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
892
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
893
 
</simpara></listitem></varlistentry>
894
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
895
 
<listitem><simpara> a group name
896
 
</simpara></listitem></varlistentry>
897
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
898
 
<listitem><simpara> a key
899
 
</simpara></listitem></varlistentry>
900
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
901
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>
902
 
</simpara></listitem></varlistentry>
903
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the value associated with the key as an integer, or
904
 
    0 if the key was not found or could not be parsed.
905
 
 
906
 
</simpara></listitem></varlistentry>
907
 
</variablelist><para role="since">Since 2.6</para></refsect2>
908
 
<refsect2 id="g-key-file-get-double" role="function" condition="since:2.12">
909
 
<title>g_key_file_get_double ()</title>
910
 
<indexterm zone="g-key-file-get-double" role="2.12"><primary sortas="key_file_get_double">g_key_file_get_double</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             g_key_file_get_double               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
911
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
912
 
                                                         const <link linkend="gchar">gchar</link> *key,
913
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
914
 
<para>
915
 
Returns the value associated with <parameter>key</parameter> under <parameter>group_name</parameter> as a
916
 
double. If <parameter>group_name</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, the start_group is used.
917
 
</para>
918
 
<para>
919
 
If <parameter>key</parameter> cannot be found then 0.0 is returned and <parameter>error</parameter> is set to
920
 
<link linkend="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_KEY_NOT_FOUND</type></link>. Likewise, if the value associated
921
 
with <parameter>key</parameter> cannot be interpreted as a double then 0.0 is returned
922
 
and <parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-INVALID-VALUE--CAPS"><type>G_KEY_FILE_ERROR_INVALID_VALUE</type></link>.</para>
923
 
<para>
924
 
</para><variablelist role="params">
925
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
926
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
927
 
</simpara></listitem></varlistentry>
928
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
929
 
<listitem><simpara> a group name
930
 
</simpara></listitem></varlistentry>
931
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
932
 
<listitem><simpara> a key
933
 
</simpara></listitem></varlistentry>
934
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
935
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>
936
 
</simpara></listitem></varlistentry>
937
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the value associated with the key as a double, or
938
 
    0.0 if the key was not found or could not be parsed.
939
 
 
940
 
</simpara></listitem></varlistentry>
941
 
</variablelist><para role="since">Since 2.12</para></refsect2>
942
 
<refsect2 id="g-key-file-get-string-list" role="function" condition="since:2.6">
943
 
<title>g_key_file_get_string_list ()</title>
944
 
<indexterm zone="g-key-file-get-string-list" role="2.6"><primary sortas="key_file_get_string_list">g_key_file_get_string_list</primary></indexterm><programlisting><link linkend="gchar">gchar</link> **            g_key_file_get_string_list          (<link linkend="GKeyFile">GKeyFile</link> *key_file,
945
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
946
 
                                                         const <link linkend="gchar">gchar</link> *key,
947
 
                                                         <link linkend="gsize">gsize</link> *length,
948
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
949
 
<para>
950
 
Returns the values associated with <parameter>key</parameter> under <parameter>group_name</parameter>.
951
 
</para>
952
 
<para>
953
 
In the event the key cannot be found, <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned and
954
 
<parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_KEY_NOT_FOUND</type></link>.  In the
955
 
event that the <parameter>group_name</parameter> cannot be found, <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned
956
 
and <parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-GROUP-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_GROUP_NOT_FOUND</type></link>.</para>
957
 
<para>
958
 
</para><variablelist role="params">
959
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
960
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
961
 
</simpara></listitem></varlistentry>
962
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
963
 
<listitem><simpara> a group name
964
 
</simpara></listitem></varlistentry>
965
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
966
 
<listitem><simpara> a key
967
 
</simpara></listitem></varlistentry>
968
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
969
 
<listitem><simpara> return location for the number of returned strings, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
970
 
</simpara></listitem></varlistentry>
971
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
972
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
973
 
</simpara></listitem></varlistentry>
974
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated string array or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the specified 
975
 
  key cannot be found. The array should be freed with <link linkend="g-strfreev"><function>g_strfreev()</function></link>.
976
 
 
977
 
</simpara></listitem></varlistentry>
978
 
</variablelist><para role="since">Since 2.6</para></refsect2>
979
 
<refsect2 id="g-key-file-get-locale-string-list" role="function" condition="since:2.6">
980
 
<title>g_key_file_get_locale_string_list ()</title>
981
 
<indexterm zone="g-key-file-get-locale-string-list" role="2.6"><primary sortas="key_file_get_locale_string_list">g_key_file_get_locale_string_list</primary></indexterm><programlisting><link linkend="gchar">gchar</link> **            g_key_file_get_locale_string_list   (<link linkend="GKeyFile">GKeyFile</link> *key_file,
982
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
983
 
                                                         const <link linkend="gchar">gchar</link> *key,
984
 
                                                         const <link linkend="gchar">gchar</link> *locale,
985
 
                                                         <link linkend="gsize">gsize</link> *length,
986
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
987
 
<para>
988
 
Returns the values associated with <parameter>key</parameter> under <parameter>group_name</parameter>
989
 
translated in the given <parameter>locale</parameter> if available.  If <parameter>locale</parameter> is
990
 
<link linkend="NULL--CAPS"><literal>NULL</literal></link> then the current locale is assumed.
991
 
</para>
992
 
<para>
993
 
If <parameter>key</parameter> cannot be found then <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned and <parameter>error</parameter> is set 
994
 
to <link linkend="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_KEY_NOT_FOUND</type></link>. If the values associated
995
 
with <parameter>key</parameter> cannot be interpreted or no suitable translations
996
 
can be found then the untranslated values are returned. The 
997
 
returned array is <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated, so <parameter>length</parameter> may optionally 
998
 
be <link linkend="NULL--CAPS"><literal>NULL</literal></link>.</para>
999
 
<para>
1000
 
</para><variablelist role="params">
1001
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1002
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1003
 
</simpara></listitem></varlistentry>
1004
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1005
 
<listitem><simpara> a group name
1006
 
</simpara></listitem></varlistentry>
1007
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1008
 
<listitem><simpara> a key
1009
 
</simpara></listitem></varlistentry>
1010
 
<varlistentry><term><parameter>locale</parameter>&#160;:</term>
1011
 
<listitem><simpara> a locale identifier or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1012
 
</simpara></listitem></varlistentry>
1013
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
1014
 
<listitem><simpara> return location for the number of returned strings or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1015
 
</simpara></listitem></varlistentry>
1016
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1017
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1018
 
</simpara></listitem></varlistentry>
1019
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated string array
1020
 
  or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the key isn't found. The string array should be freed
1021
 
  with <link linkend="g-strfreev"><function>g_strfreev()</function></link>.
1022
 
 
1023
 
</simpara></listitem></varlistentry>
1024
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1025
 
<refsect2 id="g-key-file-get-boolean-list" role="function" condition="since:2.6">
1026
 
<title>g_key_file_get_boolean_list ()</title>
1027
 
<indexterm zone="g-key-file-get-boolean-list" role="2.6"><primary sortas="key_file_get_boolean_list">g_key_file_get_boolean_list</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> *          g_key_file_get_boolean_list         (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1028
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1029
 
                                                         const <link linkend="gchar">gchar</link> *key,
1030
 
                                                         <link linkend="gsize">gsize</link> *length,
1031
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
1032
 
<para>
1033
 
Returns the values associated with <parameter>key</parameter> under <parameter>group_name</parameter> as
1034
 
booleans. 
1035
 
</para>
1036
 
<para>
1037
 
If <parameter>key</parameter> cannot be found then <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned and <parameter>error</parameter> is set to
1038
 
<link linkend="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_KEY_NOT_FOUND</type></link>. Likewise, if the values associated
1039
 
with <parameter>key</parameter> cannot be interpreted as booleans then <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned
1040
 
and <parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-INVALID-VALUE--CAPS"><type>G_KEY_FILE_ERROR_INVALID_VALUE</type></link>.</para>
1041
 
<para>
1042
 
</para><variablelist role="params">
1043
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1044
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1045
 
</simpara></listitem></varlistentry>
1046
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1047
 
<listitem><simpara> a group name
1048
 
</simpara></listitem></varlistentry>
1049
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1050
 
<listitem><simpara> a key
1051
 
</simpara></listitem></varlistentry>
1052
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
1053
 
<listitem><simpara> the number of booleans returned
1054
 
</simpara></listitem></varlistentry>
1055
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1056
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>
1057
 
</simpara></listitem></varlistentry>
1058
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the values associated with the key as a list of
1059
 
   booleans, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the key was not found or could not be parsed.
1060
 
 
1061
 
</simpara></listitem></varlistentry>
1062
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1063
 
<refsect2 id="g-key-file-get-integer-list" role="function" condition="since:2.6">
1064
 
<title>g_key_file_get_integer_list ()</title>
1065
 
<indexterm zone="g-key-file-get-integer-list" role="2.6"><primary sortas="key_file_get_integer_list">g_key_file_get_integer_list</primary></indexterm><programlisting><link linkend="gint">gint</link> *              g_key_file_get_integer_list         (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1066
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1067
 
                                                         const <link linkend="gchar">gchar</link> *key,
1068
 
                                                         <link linkend="gsize">gsize</link> *length,
1069
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
1070
 
<para>
1071
 
Returns the values associated with <parameter>key</parameter> under <parameter>group_name</parameter> as
1072
 
integers. 
1073
 
</para>
1074
 
<para>
1075
 
If <parameter>key</parameter> cannot be found then <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned and <parameter>error</parameter> is set to
1076
 
<link linkend="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_KEY_NOT_FOUND</type></link>. Likewise, if the values associated
1077
 
with <parameter>key</parameter> cannot be interpreted as integers then <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned
1078
 
and <parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-INVALID-VALUE--CAPS"><type>G_KEY_FILE_ERROR_INVALID_VALUE</type></link>.</para>
1079
 
<para>
1080
 
</para><variablelist role="params">
1081
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1082
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1083
 
</simpara></listitem></varlistentry>
1084
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1085
 
<listitem><simpara> a group name
1086
 
</simpara></listitem></varlistentry>
1087
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1088
 
<listitem><simpara> a key
1089
 
</simpara></listitem></varlistentry>
1090
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
1091
 
<listitem><simpara> the number of integers returned
1092
 
</simpara></listitem></varlistentry>
1093
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1094
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>
1095
 
</simpara></listitem></varlistentry>
1096
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the values associated with the key as a list of
1097
 
    integers, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the key was not found or could not be parsed.
1098
 
 
1099
 
</simpara></listitem></varlistentry>
1100
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1101
 
<refsect2 id="g-key-file-get-double-list" role="function" condition="since:2.12">
1102
 
<title>g_key_file_get_double_list ()</title>
1103
 
<indexterm zone="g-key-file-get-double-list" role="2.12"><primary sortas="key_file_get_double_list">g_key_file_get_double_list</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> *           g_key_file_get_double_list          (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1104
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1105
 
                                                         const <link linkend="gchar">gchar</link> *key,
1106
 
                                                         <link linkend="gsize">gsize</link> *length,
1107
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
1108
 
<para>
1109
 
Returns the values associated with <parameter>key</parameter> under <parameter>group_name</parameter> as
1110
 
doubles. 
1111
 
</para>
1112
 
<para>
1113
 
If <parameter>key</parameter> cannot be found then <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned and <parameter>error</parameter> is set to
1114
 
<link linkend="G-KEY-FILE-ERROR-KEY-NOT-FOUND--CAPS"><type>G_KEY_FILE_ERROR_KEY_NOT_FOUND</type></link>. Likewise, if the values associated
1115
 
with <parameter>key</parameter> cannot be interpreted as doubles then <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned
1116
 
and <parameter>error</parameter> is set to <link linkend="G-KEY-FILE-ERROR-INVALID-VALUE--CAPS"><type>G_KEY_FILE_ERROR_INVALID_VALUE</type></link>.</para>
1117
 
<para>
1118
 
</para><variablelist role="params">
1119
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1120
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1121
 
</simpara></listitem></varlistentry>
1122
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1123
 
<listitem><simpara> a group name
1124
 
</simpara></listitem></varlistentry>
1125
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1126
 
<listitem><simpara> a key
1127
 
</simpara></listitem></varlistentry>
1128
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
1129
 
<listitem><simpara> the number of doubles returned
1130
 
</simpara></listitem></varlistentry>
1131
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1132
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>
1133
 
</simpara></listitem></varlistentry>
1134
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the values associated with the key as a list of
1135
 
    doubles, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the key was not found or could not be parsed.
1136
 
 
1137
 
</simpara></listitem></varlistentry>
1138
 
</variablelist><para role="since">Since 2.12</para></refsect2>
1139
 
<refsect2 id="g-key-file-get-comment" role="function" condition="since:2.6">
1140
 
<title>g_key_file_get_comment ()</title>
1141
 
<indexterm zone="g-key-file-get-comment" role="2.6"><primary sortas="key_file_get_comment">g_key_file_get_comment</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             g_key_file_get_comment              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1142
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1143
 
                                                         const <link linkend="gchar">gchar</link> *key,
1144
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
1145
 
<para>
1146
 
Retrieves a comment above <parameter>key</parameter> from <parameter>group_name</parameter>.
1147
 
If <parameter>key</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link> then <parameter>comment</parameter> will be read from above 
1148
 
<parameter>group_name</parameter>. If both <parameter>key</parameter> and <parameter>group_name</parameter> are <link linkend="NULL--CAPS"><literal>NULL</literal></link>, then 
1149
 
<parameter>comment</parameter> will be read from above the first group in the file.</para>
1150
 
<para>
1151
 
</para><variablelist role="params">
1152
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1153
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1154
 
</simpara></listitem></varlistentry>
1155
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1156
 
<listitem><simpara> a group name, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1157
 
</simpara></listitem></varlistentry>
1158
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1159
 
<listitem><simpara> a key
1160
 
</simpara></listitem></varlistentry>
1161
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1162
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>
1163
 
</simpara></listitem></varlistentry>
1164
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a comment that should be freed with <link linkend="g-free"><function>g_free()</function></link>
1165
 
 
1166
 
</simpara></listitem></varlistentry>
1167
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1168
 
<refsect2 id="g-key-file-set-value" role="function" condition="since:2.6">
1169
 
<title>g_key_file_set_value ()</title>
1170
 
<indexterm zone="g-key-file-set-value" role="2.6"><primary sortas="key_file_set_value">g_key_file_set_value</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_value                (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1171
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1172
 
                                                         const <link linkend="gchar">gchar</link> *key,
1173
 
                                                         const <link linkend="gchar">gchar</link> *value);</programlisting>
1174
 
<para>
1175
 
Associates a new value with <parameter>key</parameter> under <parameter>group_name</parameter>.  
1176
 
</para>
1177
 
<para>
1178
 
If <parameter>key</parameter> cannot be found then it is created. If <parameter>group_name</parameter> cannot 
1179
 
be found then it is created. To set an UTF-8 string which may contain 
1180
 
characters that need escaping (such as newlines or spaces), use 
1181
 
<link linkend="g-key-file-set-string"><function>g_key_file_set_string()</function></link>.</para>
1182
 
<para>
1183
 
</para><variablelist role="params">
1184
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1185
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1186
 
</simpara></listitem></varlistentry>
1187
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1188
 
<listitem><simpara> a group name
1189
 
</simpara></listitem></varlistentry>
1190
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1191
 
<listitem><simpara> a key
1192
 
</simpara></listitem></varlistentry>
1193
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
1194
 
<listitem><simpara> a string
1195
 
</simpara></listitem></varlistentry>
1196
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1197
 
<refsect2 id="g-key-file-set-string" role="function" condition="since:2.6">
1198
 
<title>g_key_file_set_string ()</title>
1199
 
<indexterm zone="g-key-file-set-string" role="2.6"><primary sortas="key_file_set_string">g_key_file_set_string</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_string               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1200
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1201
 
                                                         const <link linkend="gchar">gchar</link> *key,
1202
 
                                                         const <link linkend="gchar">gchar</link> *string);</programlisting>
1203
 
<para>
1204
 
Associates a new string value with <parameter>key</parameter> under <parameter>group_name</parameter>.  
1205
 
If <parameter>key</parameter> cannot be found then it is created.  
1206
 
If <parameter>group_name</parameter> cannot be found then it is created.
1207
 
Unlike <link linkend="g-key-file-set-value"><function>g_key_file_set_value()</function></link>, this function handles characters
1208
 
that need escaping, such as newlines.</para>
1209
 
<para>
1210
 
</para><variablelist role="params">
1211
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1212
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1213
 
</simpara></listitem></varlistentry>
1214
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1215
 
<listitem><simpara> a group name
1216
 
</simpara></listitem></varlistentry>
1217
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1218
 
<listitem><simpara> a key
1219
 
</simpara></listitem></varlistentry>
1220
 
<varlistentry><term><parameter>string</parameter>&#160;:</term>
1221
 
<listitem><simpara> a string
1222
 
</simpara></listitem></varlistentry>
1223
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1224
 
<refsect2 id="g-key-file-set-locale-string" role="function" condition="since:2.6">
1225
 
<title>g_key_file_set_locale_string ()</title>
1226
 
<indexterm zone="g-key-file-set-locale-string" role="2.6"><primary sortas="key_file_set_locale_string">g_key_file_set_locale_string</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_locale_string        (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1227
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1228
 
                                                         const <link linkend="gchar">gchar</link> *key,
1229
 
                                                         const <link linkend="gchar">gchar</link> *locale,
1230
 
                                                         const <link linkend="gchar">gchar</link> *string);</programlisting>
1231
 
<para>
1232
 
Associates a string value for <parameter>key</parameter> and <parameter>locale</parameter> under <parameter>group_name</parameter>.
1233
 
If the translation for <parameter>key</parameter> cannot be found then it is created.</para>
1234
 
<para>
1235
 
</para><variablelist role="params">
1236
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1237
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1238
 
</simpara></listitem></varlistentry>
1239
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1240
 
<listitem><simpara> a group name
1241
 
</simpara></listitem></varlistentry>
1242
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1243
 
<listitem><simpara> a key
1244
 
</simpara></listitem></varlistentry>
1245
 
<varlistentry><term><parameter>locale</parameter>&#160;:</term>
1246
 
<listitem><simpara> a locale identifier
1247
 
</simpara></listitem></varlistentry>
1248
 
<varlistentry><term><parameter>string</parameter>&#160;:</term>
1249
 
<listitem><simpara> a string
1250
 
</simpara></listitem></varlistentry>
1251
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1252
 
<refsect2 id="g-key-file-set-boolean" role="function" condition="since:2.6">
1253
 
<title>g_key_file_set_boolean ()</title>
1254
 
<indexterm zone="g-key-file-set-boolean" role="2.6"><primary sortas="key_file_set_boolean">g_key_file_set_boolean</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_boolean              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1255
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1256
 
                                                         const <link linkend="gchar">gchar</link> *key,
1257
 
                                                         <link linkend="gboolean">gboolean</link> value);</programlisting>
1258
 
<para>
1259
 
Associates a new boolean value with <parameter>key</parameter> under <parameter>group_name</parameter>.
1260
 
If <parameter>key</parameter> cannot be found then it is created.</para>
1261
 
<para>
1262
 
</para><variablelist role="params">
1263
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1264
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1265
 
</simpara></listitem></varlistentry>
1266
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1267
 
<listitem><simpara> a group name
1268
 
</simpara></listitem></varlistentry>
1269
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1270
 
<listitem><simpara> a key
1271
 
</simpara></listitem></varlistentry>
1272
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
1273
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>
1274
 
</simpara></listitem></varlistentry>
1275
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1276
 
<refsect2 id="g-key-file-set-integer" role="function" condition="since:2.6">
1277
 
<title>g_key_file_set_integer ()</title>
1278
 
<indexterm zone="g-key-file-set-integer" role="2.6"><primary sortas="key_file_set_integer">g_key_file_set_integer</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_integer              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1279
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1280
 
                                                         const <link linkend="gchar">gchar</link> *key,
1281
 
                                                         <link linkend="gint">gint</link> value);</programlisting>
1282
 
<para>
1283
 
Associates a new integer value with <parameter>key</parameter> under <parameter>group_name</parameter>.
1284
 
If <parameter>key</parameter> cannot be found then it is created.</para>
1285
 
<para>
1286
 
</para><variablelist role="params">
1287
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1288
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1289
 
</simpara></listitem></varlistentry>
1290
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1291
 
<listitem><simpara> a group name
1292
 
</simpara></listitem></varlistentry>
1293
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1294
 
<listitem><simpara> a key
1295
 
</simpara></listitem></varlistentry>
1296
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
1297
 
<listitem><simpara> an integer value
1298
 
</simpara></listitem></varlistentry>
1299
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1300
 
<refsect2 id="g-key-file-set-double" role="function" condition="since:2.12">
1301
 
<title>g_key_file_set_double ()</title>
1302
 
<indexterm zone="g-key-file-set-double" role="2.12"><primary sortas="key_file_set_double">g_key_file_set_double</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_double               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1303
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1304
 
                                                         const <link linkend="gchar">gchar</link> *key,
1305
 
                                                         <link linkend="gdouble">gdouble</link> value);</programlisting>
1306
 
<para>
1307
 
Associates a new double value with <parameter>key</parameter> under <parameter>group_name</parameter>.
1308
 
If <parameter>key</parameter> cannot be found then it is created.</para>
1309
 
<para>
1310
 
</para><variablelist role="params">
1311
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1312
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1313
 
</simpara></listitem></varlistentry>
1314
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1315
 
<listitem><simpara> a group name
1316
 
</simpara></listitem></varlistentry>
1317
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1318
 
<listitem><simpara> a key
1319
 
</simpara></listitem></varlistentry>
1320
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
1321
 
<listitem><simpara> an double value
1322
 
</simpara></listitem></varlistentry>
1323
 
</variablelist><para role="since">Since 2.12</para></refsect2>
1324
 
<refsect2 id="g-key-file-set-string-list" role="function" condition="since:2.6">
1325
 
<title>g_key_file_set_string_list ()</title>
1326
 
<indexterm zone="g-key-file-set-string-list" role="2.6"><primary sortas="key_file_set_string_list">g_key_file_set_string_list</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_string_list          (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1327
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1328
 
                                                         const <link linkend="gchar">gchar</link> *key,
1329
 
                                                         const <link linkend="gchar">gchar</link> * const list[],
1330
 
                                                         <link linkend="gsize">gsize</link> length);</programlisting>
1331
 
<para>
1332
 
Associates a list of string values for <parameter>key</parameter> under <parameter>group_name</parameter>.
1333
 
If <parameter>key</parameter> cannot be found then it is created.
1334
 
If <parameter>group_name</parameter> cannot be found then it is created.</para>
1335
 
<para>
1336
 
</para><variablelist role="params">
1337
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1338
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1339
 
</simpara></listitem></varlistentry>
1340
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1341
 
<listitem><simpara> a group name
1342
 
</simpara></listitem></varlistentry>
1343
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1344
 
<listitem><simpara> a key
1345
 
</simpara></listitem></varlistentry>
1346
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
1347
 
<listitem><simpara> an array of string values
1348
 
</simpara></listitem></varlistentry>
1349
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
1350
 
<listitem><simpara> number of string values in <parameter>list</parameter>
1351
 
</simpara></listitem></varlistentry>
1352
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1353
 
<refsect2 id="g-key-file-set-locale-string-list" role="function" condition="since:2.6">
1354
 
<title>g_key_file_set_locale_string_list ()</title>
1355
 
<indexterm zone="g-key-file-set-locale-string-list" role="2.6"><primary sortas="key_file_set_locale_string_list">g_key_file_set_locale_string_list</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_locale_string_list   (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1356
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1357
 
                                                         const <link linkend="gchar">gchar</link> *key,
1358
 
                                                         const <link linkend="gchar">gchar</link> *locale,
1359
 
                                                         const <link linkend="gchar">gchar</link> * const list[],
1360
 
                                                         <link linkend="gsize">gsize</link> length);</programlisting>
1361
 
<para>
1362
 
Associates a list of string values for <parameter>key</parameter> and <parameter>locale</parameter> under
1363
 
<parameter>group_name</parameter>.  If the translation for <parameter>key</parameter> cannot be found then
1364
 
it is created.</para>
1365
 
<para>
1366
 
</para><variablelist role="params">
1367
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1368
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1369
 
</simpara></listitem></varlistentry>
1370
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1371
 
<listitem><simpara> a group name
1372
 
</simpara></listitem></varlistentry>
1373
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1374
 
<listitem><simpara> a key
1375
 
</simpara></listitem></varlistentry>
1376
 
<varlistentry><term><parameter>locale</parameter>&#160;:</term>
1377
 
<listitem><simpara> a locale identifier
1378
 
</simpara></listitem></varlistentry>
1379
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
1380
 
<listitem><simpara> a <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated array of locale string values
1381
 
</simpara></listitem></varlistentry>
1382
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
1383
 
<listitem><simpara> the length of <parameter>list</parameter>
1384
 
</simpara></listitem></varlistentry>
1385
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1386
 
<refsect2 id="g-key-file-set-boolean-list" role="function" condition="since:2.6">
1387
 
<title>g_key_file_set_boolean_list ()</title>
1388
 
<indexterm zone="g-key-file-set-boolean-list" role="2.6"><primary sortas="key_file_set_boolean_list">g_key_file_set_boolean_list</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_boolean_list         (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1389
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1390
 
                                                         const <link linkend="gchar">gchar</link> *key,
1391
 
                                                         <link linkend="gboolean">gboolean</link> list[],
1392
 
                                                         <link linkend="gsize">gsize</link> length);</programlisting>
1393
 
<para>
1394
 
Associates a list of boolean values with <parameter>key</parameter> under <parameter>group_name</parameter>.  
1395
 
If <parameter>key</parameter> cannot be found then it is created.
1396
 
If <parameter>group_name</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, the start_group is used.</para>
1397
 
<para>
1398
 
</para><variablelist role="params">
1399
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1400
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1401
 
</simpara></listitem></varlistentry>
1402
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1403
 
<listitem><simpara> a group name
1404
 
</simpara></listitem></varlistentry>
1405
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1406
 
<listitem><simpara> a key
1407
 
</simpara></listitem></varlistentry>
1408
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
1409
 
<listitem><simpara> an array of boolean values
1410
 
</simpara></listitem></varlistentry>
1411
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
1412
 
<listitem><simpara> length of <parameter>list</parameter>
1413
 
</simpara></listitem></varlistentry>
1414
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1415
 
<refsect2 id="g-key-file-set-integer-list" role="function" condition="since:2.6">
1416
 
<title>g_key_file_set_integer_list ()</title>
1417
 
<indexterm zone="g-key-file-set-integer-list" role="2.6"><primary sortas="key_file_set_integer_list">g_key_file_set_integer_list</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_integer_list         (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1418
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1419
 
                                                         const <link linkend="gchar">gchar</link> *key,
1420
 
                                                         <link linkend="gint">gint</link> list[],
1421
 
                                                         <link linkend="gsize">gsize</link> length);</programlisting>
1422
 
<para>
1423
 
Associates a list of integer values with <parameter>key</parameter> under <parameter>group_name</parameter>.  
1424
 
If <parameter>key</parameter> cannot be found then it is created.</para>
1425
 
<para>
1426
 
</para><variablelist role="params">
1427
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1428
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1429
 
</simpara></listitem></varlistentry>
1430
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1431
 
<listitem><simpara> a group name
1432
 
</simpara></listitem></varlistentry>
1433
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1434
 
<listitem><simpara> a key
1435
 
</simpara></listitem></varlistentry>
1436
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
1437
 
<listitem><simpara> an array of integer values
1438
 
</simpara></listitem></varlistentry>
1439
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
1440
 
<listitem><simpara> number of integer values in <parameter>list</parameter>
1441
 
</simpara></listitem></varlistentry>
1442
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1443
 
<refsect2 id="g-key-file-set-double-list" role="function" condition="since:2.12">
1444
 
<title>g_key_file_set_double_list ()</title>
1445
 
<indexterm zone="g-key-file-set-double-list" role="2.12"><primary sortas="key_file_set_double_list">g_key_file_set_double_list</primary></indexterm><programlisting><link linkend="void">void</link>                g_key_file_set_double_list          (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1446
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1447
 
                                                         const <link linkend="gchar">gchar</link> *key,
1448
 
                                                         <link linkend="gdouble">gdouble</link> list[],
1449
 
                                                         <link linkend="gsize">gsize</link> length);</programlisting>
1450
 
<para>
1451
 
Associates a list of double values with <parameter>key</parameter> under
1452
 
<parameter>group_name</parameter>.  If <parameter>key</parameter> cannot be found then it is created.</para>
1453
 
<para>
1454
 
</para><variablelist role="params">
1455
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1456
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1457
 
</simpara></listitem></varlistentry>
1458
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1459
 
<listitem><simpara> a group name
1460
 
</simpara></listitem></varlistentry>
1461
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1462
 
<listitem><simpara> a key
1463
 
</simpara></listitem></varlistentry>
1464
 
<varlistentry><term><parameter>list</parameter>&#160;:</term>
1465
 
<listitem><simpara> an array of double values
1466
 
</simpara></listitem></varlistentry>
1467
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
1468
 
<listitem><simpara> number of double values in <parameter>list</parameter>
1469
 
</simpara></listitem></varlistentry>
1470
 
</variablelist><para role="since">Since 2.12</para></refsect2>
1471
 
<refsect2 id="g-key-file-set-comment" role="function" condition="since:2.6">
1472
 
<title>g_key_file_set_comment ()</title>
1473
 
<indexterm zone="g-key-file-set-comment" role="2.6"><primary sortas="key_file_set_comment">g_key_file_set_comment</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_key_file_set_comment              (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1474
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1475
 
                                                         const <link linkend="gchar">gchar</link> *key,
1476
 
                                                         const <link linkend="gchar">gchar</link> *comment,
1477
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
1478
 
<para>
1479
 
Places a comment above <parameter>key</parameter> from <parameter>group_name</parameter>.
1480
 
If <parameter>key</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link> then <parameter>comment</parameter> will be written above <parameter>group_name</parameter>.  
1481
 
If both <parameter>key</parameter> and <parameter>group_name</parameter>  are <link linkend="NULL--CAPS"><literal>NULL</literal></link>, then <parameter>comment</parameter> will be 
1482
 
written above the first group in the file.</para>
1483
 
<para>
1484
 
</para><variablelist role="params">
1485
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1486
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1487
 
</simpara></listitem></varlistentry>
1488
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1489
 
<listitem><simpara> a group name, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1490
 
</simpara></listitem></varlistentry>
1491
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1492
 
<listitem><simpara> a key
1493
 
</simpara></listitem></varlistentry>
1494
 
<varlistentry><term><parameter>comment</parameter>&#160;:</term>
1495
 
<listitem><simpara> a comment
1496
 
</simpara></listitem></varlistentry>
1497
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1498
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>
1499
 
</simpara></listitem></varlistentry>
1500
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the comment was written, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1501
 
 
1502
 
</simpara></listitem></varlistentry>
1503
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1504
 
<refsect2 id="g-key-file-remove-group" role="function" condition="since:2.6">
1505
 
<title>g_key_file_remove_group ()</title>
1506
 
<indexterm zone="g-key-file-remove-group" role="2.6"><primary sortas="key_file_remove_group">g_key_file_remove_group</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_key_file_remove_group             (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1507
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1508
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
1509
 
<para>
1510
 
Removes the specified group, <parameter>group_name</parameter>, 
1511
 
from the key file.</para>
1512
 
<para>
1513
 
</para><variablelist role="params">
1514
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1515
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1516
 
</simpara></listitem></varlistentry>
1517
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1518
 
<listitem><simpara> a group name
1519
 
</simpara></listitem></varlistentry>
1520
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1521
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1522
 
</simpara></listitem></varlistentry>
1523
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the group was removed, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1524
 
 
1525
 
</simpara></listitem></varlistentry>
1526
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1527
 
<refsect2 id="g-key-file-remove-key" role="function" condition="since:2.6">
1528
 
<title>g_key_file_remove_key ()</title>
1529
 
<indexterm zone="g-key-file-remove-key" role="2.6"><primary sortas="key_file_remove_key">g_key_file_remove_key</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_key_file_remove_key               (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1530
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1531
 
                                                         const <link linkend="gchar">gchar</link> *key,
1532
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
1533
 
<para>
1534
 
Removes <parameter>key</parameter> in <parameter>group_name</parameter> from the key file.</para>
1535
 
<para>
1536
 
</para><variablelist role="params">
1537
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1538
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1539
 
</simpara></listitem></varlistentry>
1540
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1541
 
<listitem><simpara> a group name
1542
 
</simpara></listitem></varlistentry>
1543
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1544
 
<listitem><simpara> a key name to remove
1545
 
</simpara></listitem></varlistentry>
1546
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1547
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1548
 
</simpara></listitem></varlistentry>
1549
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the key was removed, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1550
 
 
1551
 
</simpara></listitem></varlistentry>
1552
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1553
 
<refsect2 id="g-key-file-remove-comment" role="function" condition="since:2.6">
1554
 
<title>g_key_file_remove_comment ()</title>
1555
 
<indexterm zone="g-key-file-remove-comment" role="2.6"><primary sortas="key_file_remove_comment">g_key_file_remove_comment</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_key_file_remove_comment           (<link linkend="GKeyFile">GKeyFile</link> *key_file,
1556
 
                                                         const <link linkend="gchar">gchar</link> *group_name,
1557
 
                                                         const <link linkend="gchar">gchar</link> *key,
1558
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
1559
 
<para>
1560
 
Removes a comment above <parameter>key</parameter> from <parameter>group_name</parameter>.
1561
 
If <parameter>key</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link> then <parameter>comment</parameter> will be removed above <parameter>group_name</parameter>. 
1562
 
If both <parameter>key</parameter> and <parameter>group_name</parameter> are <link linkend="NULL--CAPS"><literal>NULL</literal></link>, then <parameter>comment</parameter> will
1563
 
be removed above the first group in the file.</para>
1564
 
<para>
1565
 
</para><variablelist role="params">
1566
 
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
1567
 
<listitem><simpara> a <link linkend="GKeyFile"><type>GKeyFile</type></link>
1568
 
</simpara></listitem></varlistentry>
1569
 
<varlistentry><term><parameter>group_name</parameter>&#160;:</term>
1570
 
<listitem><simpara> a group name, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1571
 
</simpara></listitem></varlistentry>
1572
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1573
 
<listitem><simpara> a key
1574
 
</simpara></listitem></varlistentry>
1575
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
1576
 
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>
1577
 
</simpara></listitem></varlistentry>
1578
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the comment was removed, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
1579
 
 
1580
 
</simpara></listitem></varlistentry>
1581
 
</variablelist><para role="since">Since 2.6</para></refsect2>
1582
 
<refsect2 id="G-KEY-FILE-DESKTOP-GROUP--CAPS" role="macro" condition="since:2.14">
1583
 
<title>G_KEY_FILE_DESKTOP_GROUP</title>
1584
 
<indexterm zone="G-KEY-FILE-DESKTOP-GROUP--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_GROUP">G_KEY_FILE_DESKTOP_GROUP</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_GROUP                "Desktop Entry"
1585
 
</programlisting>
1586
 
<para>
1587
 
The name of the main group of a desktop entry file, as defined in the
1588
 
<ulink url="http://freedesktop.org/Standards/desktop-entry-spec">Desktop
1589
 
Entry Specification</ulink>. Consult the specification for more
1590
 
details about the meanings of the keys below.
1591
 
</para><para role="since">Since 2.14</para></refsect2>
1592
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-TYPE--CAPS" role="macro" condition="since:2.14">
1593
 
<title>G_KEY_FILE_DESKTOP_KEY_TYPE</title>
1594
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-TYPE--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_TYPE">G_KEY_FILE_DESKTOP_KEY_TYPE</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_TYPE             "Type"
1595
 
</programlisting>
1596
 
<para>
1597
 
A key under <link
1598
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1599
 
whose value is a string giving the type of the desktop entry. Usually
1600
 
<link linkend="G-KEY-FILE-DESKTOP-TYPE-APPLICATION:CAPS"><literal>G_KEY_FILE_DESKTOP_TYPE_APPLICATION</literal></link>,
1601
 
<link linkend="G-KEY-FILE-DESKTOP-TYPE-LINK:CAPS"><literal>G_KEY_FILE_DESKTOP_TYPE_LINK</literal></link>, or
1602
 
<link linkend="G-KEY-FILE-DESKTOP-TYPE-DIRECTORY:CAPS"><literal>G_KEY_FILE_DESKTOP_TYPE_DIRECTORY</literal></link>.
1603
 
</para><para role="since">Since 2.14</para></refsect2>
1604
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-VERSION--CAPS" role="macro" condition="since:2.14">
1605
 
<title>G_KEY_FILE_DESKTOP_KEY_VERSION</title>
1606
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-VERSION--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_VERSION">G_KEY_FILE_DESKTOP_KEY_VERSION</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_VERSION          "Version"
1607
 
</programlisting>
1608
 
<para>
1609
 
A key under <link
1610
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1611
 
whose value is a string giving the version of the Desktop
1612
 
Entry Specification used for the desktop entry file.
1613
 
</para><para role="since">Since 2.14</para></refsect2>
1614
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-NAME--CAPS" role="macro" condition="since:2.14">
1615
 
<title>G_KEY_FILE_DESKTOP_KEY_NAME</title>
1616
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-NAME--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_NAME">G_KEY_FILE_DESKTOP_KEY_NAME</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_NAME             "Name"
1617
 
</programlisting>
1618
 
<para>
1619
 
A key under <link
1620
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1621
 
whose value is a localized string giving the specific name of the
1622
 
desktop entry.
1623
 
</para><para role="since">Since 2.14</para></refsect2>
1624
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-GENERIC-NAME--CAPS" role="macro" condition="since:2.14">
1625
 
<title>G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME</title>
1626
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-GENERIC-NAME--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_GENERIC_NAME">G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME     "GenericName"
1627
 
</programlisting>
1628
 
<para>
1629
 
A key under <link
1630
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1631
 
whose value is a localized string giving the generic name of the
1632
 
desktop entry.
1633
 
</para><para role="since">Since 2.14</para></refsect2>
1634
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-NO-DISPLAY--CAPS" role="macro" condition="since:2.14">
1635
 
<title>G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY</title>
1636
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-NO-DISPLAY--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_NO_DISPLAY">G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY       "NoDisplay"
1637
 
</programlisting>
1638
 
<para>
1639
 
A key under <link
1640
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1641
 
whose value is a boolean stating whether the desktop entry should be
1642
 
shown in menus.
1643
 
</para><para role="since">Since 2.14</para></refsect2>
1644
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-COMMENT--CAPS" role="macro" condition="since:2.14">
1645
 
<title>G_KEY_FILE_DESKTOP_KEY_COMMENT</title>
1646
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-COMMENT--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_COMMENT">G_KEY_FILE_DESKTOP_KEY_COMMENT</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_COMMENT          "Comment"
1647
 
</programlisting>
1648
 
<para>
1649
 
A key under <link
1650
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1651
 
whose value is a localized string giving the tooltip for the desktop
1652
 
entry.
1653
 
</para><para role="since">Since 2.14</para></refsect2>
1654
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-ICON--CAPS" role="macro" condition="since:2.14">
1655
 
<title>G_KEY_FILE_DESKTOP_KEY_ICON</title>
1656
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-ICON--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_ICON">G_KEY_FILE_DESKTOP_KEY_ICON</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_ICON             "Icon"
1657
 
</programlisting>
1658
 
<para>
1659
 
A key under <link
1660
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1661
 
whose value is a localized string giving the name of the icon to be
1662
 
displayed for the desktop entry.
1663
 
</para><para role="since">Since 2.14</para></refsect2>
1664
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-HIDDEN--CAPS" role="macro" condition="since:2.14">
1665
 
<title>G_KEY_FILE_DESKTOP_KEY_HIDDEN</title>
1666
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-HIDDEN--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_HIDDEN">G_KEY_FILE_DESKTOP_KEY_HIDDEN</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_HIDDEN           "Hidden"
1667
 
</programlisting>
1668
 
<para>
1669
 
A key under <link
1670
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1671
 
whose value is a boolean stating whether the desktop entry has been
1672
 
deleted by the user.
1673
 
</para><para role="since">Since 2.14</para></refsect2>
1674
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-ONLY-SHOW-IN--CAPS" role="macro" condition="since:2.14">
1675
 
<title>G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN</title>
1676
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-ONLY-SHOW-IN--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN">G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN     "OnlyShowIn"
1677
 
</programlisting>
1678
 
<para>
1679
 
A key under <link
1680
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1681
 
whose value is a list of strings identifying the environments that
1682
 
should display the desktop entry.
1683
 
</para><para role="since">Since 2.14</para></refsect2>
1684
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-NOT-SHOW-IN--CAPS" role="macro" condition="since:2.14">
1685
 
<title>G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN</title>
1686
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-NOT-SHOW-IN--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN">G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN      "NotShowIn"
1687
 
</programlisting>
1688
 
<para>
1689
 
A key under <link
1690
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1691
 
whose value is a list of strings identifying the environments that
1692
 
should not display the desktop entry.
1693
 
</para><para role="since">Since 2.14</para></refsect2>
1694
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-TRY-EXEC--CAPS" role="macro" condition="since:2.14">
1695
 
<title>G_KEY_FILE_DESKTOP_KEY_TRY_EXEC</title>
1696
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-TRY-EXEC--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_TRY_EXEC">G_KEY_FILE_DESKTOP_KEY_TRY_EXEC</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_TRY_EXEC         "TryExec"
1697
 
</programlisting>
1698
 
<para>
1699
 
A key under <link
1700
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1701
 
whose value is a string giving the file name of a binary on disk
1702
 
used to determine if the program is actually installed. It is only
1703
 
valid for desktop entries with the <literal>Application</literal>
1704
 
type.
1705
 
</para><para role="since">Since 2.14</para></refsect2>
1706
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-EXEC--CAPS" role="macro" condition="since:2.14">
1707
 
<title>G_KEY_FILE_DESKTOP_KEY_EXEC</title>
1708
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-EXEC--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_EXEC">G_KEY_FILE_DESKTOP_KEY_EXEC</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_EXEC             "Exec"
1709
 
</programlisting>
1710
 
<para>
1711
 
A key under <link
1712
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1713
 
whose value is a string giving the command line to execute. It is only
1714
 
valid for desktop entries with the <literal>Application</literal>
1715
 
type.
1716
 
</para><para role="since">Since 2.14</para></refsect2>
1717
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-PATH--CAPS" role="macro" condition="since:2.14">
1718
 
<title>G_KEY_FILE_DESKTOP_KEY_PATH</title>
1719
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-PATH--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_PATH">G_KEY_FILE_DESKTOP_KEY_PATH</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_PATH             "Path"
1720
 
</programlisting>
1721
 
<para>
1722
 
A key under <link
1723
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1724
 
whose value is a string containing the working directory to run the
1725
 
program in. It is only valid for desktop entries with the
1726
 
<literal>Application</literal> type.
1727
 
</para><para role="since">Since 2.14</para></refsect2>
1728
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-TERMINAL--CAPS" role="macro" condition="since:2.14">
1729
 
<title>G_KEY_FILE_DESKTOP_KEY_TERMINAL</title>
1730
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-TERMINAL--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_TERMINAL">G_KEY_FILE_DESKTOP_KEY_TERMINAL</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_TERMINAL         "Terminal"
1731
 
</programlisting>
1732
 
<para>
1733
 
A key under <link
1734
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1735
 
whose value is a boolean stating whether the program should be
1736
 
run in a terminal window. It is only valid for desktop entries with
1737
 
the <literal>Application</literal> type.
1738
 
</para><para role="since">Since 2.14</para></refsect2>
1739
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-MIME-TYPE--CAPS" role="macro" condition="since:2.14">
1740
 
<title>G_KEY_FILE_DESKTOP_KEY_MIME_TYPE</title>
1741
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-MIME-TYPE--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_MIME_TYPE">G_KEY_FILE_DESKTOP_KEY_MIME_TYPE</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_MIME_TYPE        "MimeType"
1742
 
</programlisting>
1743
 
<para>
1744
 
A key under <link
1745
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1746
 
whose value is a list of strings giving the MIME types supported
1747
 
by this desktop entry.
1748
 
</para><para role="since">Since 2.14</para></refsect2>
1749
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-CATEGORIES--CAPS" role="macro" condition="since:2.14">
1750
 
<title>G_KEY_FILE_DESKTOP_KEY_CATEGORIES</title>
1751
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-CATEGORIES--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_CATEGORIES">G_KEY_FILE_DESKTOP_KEY_CATEGORIES</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_CATEGORIES       "Categories"
1752
 
</programlisting>
1753
 
<para>
1754
 
A key under <link
1755
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1756
 
whose value is a list of strings giving the categories in which the
1757
 
desktop entry should be shown in a menu.
1758
 
</para><para role="since">Since 2.14</para></refsect2>
1759
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-STARTUP-NOTIFY--CAPS" role="macro" condition="since:2.14">
1760
 
<title>G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY</title>
1761
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-STARTUP-NOTIFY--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY">G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY   "StartupNotify"
1762
 
</programlisting>
1763
 
<para>
1764
 
A key under <link
1765
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1766
 
whose value is a boolean stating whether the application supports
1767
 
the <ulink
1768
 
url="http://www.freedesktop.org/Standards/startup-notification-spec">Startup
1769
 
Notification Protocol Specification</ulink>.
1770
 
</para><para role="since">Since 2.14</para></refsect2>
1771
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-STARTUP-WM-CLASS--CAPS" role="macro" condition="since:2.14">
1772
 
<title>G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS</title>
1773
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-STARTUP-WM-CLASS--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS">G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS "StartupWMClass"
1774
 
</programlisting>
1775
 
<para>
1776
 
A key under <link
1777
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1778
 
whose value is string identifying the WM class or name hint of a
1779
 
window that the application will create, which can be used to emulate
1780
 
Startup Notification with older applications.
1781
 
</para><para role="since">Since 2.14</para></refsect2>
1782
 
<refsect2 id="G-KEY-FILE-DESKTOP-KEY-URL--CAPS" role="macro" condition="since:2.14">
1783
 
<title>G_KEY_FILE_DESKTOP_KEY_URL</title>
1784
 
<indexterm zone="G-KEY-FILE-DESKTOP-KEY-URL--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_KEY_URL">G_KEY_FILE_DESKTOP_KEY_URL</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_KEY_URL              "URL"
1785
 
</programlisting>
1786
 
<para>
1787
 
A key under <link
1788
 
linkend="G-KEY-FILE-DESKTOP-GROUP:CAPS"><literal>G_KEY_FILE_DESKTOP_GROUP</literal></link>
1789
 
whose value is a string giving the URL to access. It is only valid
1790
 
for desktop entries with the <literal>Link</literal> type.
1791
 
</para><para role="since">Since 2.14</para></refsect2>
1792
 
<refsect2 id="G-KEY-FILE-DESKTOP-TYPE-APPLICATION--CAPS" role="macro" condition="since:2.14">
1793
 
<title>G_KEY_FILE_DESKTOP_TYPE_APPLICATION</title>
1794
 
<indexterm zone="G-KEY-FILE-DESKTOP-TYPE-APPLICATION--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_TYPE_APPLICATION">G_KEY_FILE_DESKTOP_TYPE_APPLICATION</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_TYPE_APPLICATION     "Application"
1795
 
</programlisting>
1796
 
<para>
1797
 
The value of the <link
1798
 
linkend="G-KEY-FILE-DESKTOP-KEY-TYPE:CAPS"><literal>G_KEY_FILE_DESKTOP_KEY_TYPE</literal></link>
1799
 
key for desktop entries representing applications.
1800
 
</para><para role="since">Since 2.14</para></refsect2>
1801
 
<refsect2 id="G-KEY-FILE-DESKTOP-TYPE-LINK--CAPS" role="macro" condition="since:2.14">
1802
 
<title>G_KEY_FILE_DESKTOP_TYPE_LINK</title>
1803
 
<indexterm zone="G-KEY-FILE-DESKTOP-TYPE-LINK--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_TYPE_LINK">G_KEY_FILE_DESKTOP_TYPE_LINK</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_TYPE_LINK            "Link"
1804
 
</programlisting>
1805
 
<para>
1806
 
The value of the <link
1807
 
linkend="G-KEY-FILE-DESKTOP-KEY-TYPE:CAPS"><literal>G_KEY_FILE_DESKTOP_KEY_TYPE</literal></link>
1808
 
key for desktop entries representing links to documents.
1809
 
</para><para role="since">Since 2.14</para></refsect2>
1810
 
<refsect2 id="G-KEY-FILE-DESKTOP-TYPE-DIRECTORY--CAPS" role="macro" condition="since:2.14">
1811
 
<title>G_KEY_FILE_DESKTOP_TYPE_DIRECTORY</title>
1812
 
<indexterm zone="G-KEY-FILE-DESKTOP-TYPE-DIRECTORY--CAPS" role="2.14"><primary sortas="KEY_FILE_DESKTOP_TYPE_DIRECTORY">G_KEY_FILE_DESKTOP_TYPE_DIRECTORY</primary></indexterm><programlisting>#define G_KEY_FILE_DESKTOP_TYPE_DIRECTORY       "Directory"
1813
 
</programlisting>
1814
 
<para>
1815
 
The value of the <link
1816
 
linkend="G-KEY-FILE-DESKTOP-KEY-TYPE:CAPS"><literal>G_KEY_FILE_DESKTOP_KEY_TYPE</literal></link>
1817
 
key for desktop entries representing directories.
1818
 
</para><para role="since">Since 2.14</para></refsect2>
1819
 
 
1820
 
</refsect1>
1821
 
 
1822
 
 
1823
 
 
1824
 
 
1825
 
</refentry>