1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Key-value file parser</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="GLib Reference Manual">
8 <link rel="up" href="glib-utilities.html" title="GLib Utilities">
9 <link rel="prev" href="glib-Simple-XML-Subset-Parser.html" title="Simple XML Subset Parser">
10 <link rel="next" href="glib-Bookmark-file-parser.html" title="Bookmark file parser">
11 <meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 <link rel="chapter" href="glib.html" title="GLib Overview">
14 <link rel="chapter" href="glib-fundamentals.html" title="GLib Fundamentals">
15 <link rel="chapter" href="glib-core.html" title="GLib Core Application Support">
16 <link rel="chapter" href="glib-utilities.html" title="GLib Utilities">
17 <link rel="chapter" href="glib-data-types.html" title="GLib Data Types">
18 <link rel="chapter" href="tools.html" title="GLib Tools">
19 <link rel="index" href="api-index-full.html" title="Index">
20 <link rel="index" href="api-index-deprecated.html" title="Index of deprecated symbols">
21 <link rel="index" href="api-index-2-2.html" title="Index of new symbols in 2.2">
22 <link rel="index" href="api-index-2-4.html" title="Index of new symbols in 2.4">
23 <link rel="index" href="api-index-2-6.html" title="Index of new symbols in 2.6">
24 <link rel="index" href="api-index-2-8.html" title="Index of new symbols in 2.8">
25 <link rel="index" href="api-index-2-10.html" title="Index of new symbols in 2.10">
26 <link rel="index" href="api-index-2-12.html" title="Index of new symbols in 2.12">
27 <link rel="index" href="api-index-2-14.html" title="Index of new symbols in 2.14">
28 <link rel="index" href="api-index-2-16.html" title="Index of new symbols in 2.16">
29 <link rel="index" href="api-index-2-18.html" title="Index of new symbols in 2.18">
30 <link rel="index" href="api-index-2-20.html" title="Index of new symbols in 2.20">
31 <link rel="index" href="api-index-2-22.html" title="Index of new symbols in 2.22">
32 <link rel="index" href="api-index-2-24.html" title="Index of new symbols in 2.24">
34 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
35 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
37 <td><a accesskey="p" href="glib-Simple-XML-Subset-Parser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
38 <td><a accesskey="u" href="glib-utilities.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
39 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
40 <th width="100%" align="center">GLib Reference Manual</th>
41 <td><a accesskey="n" href="glib-Bookmark-file-parser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
43 <tr><td colspan="5" class="shortcuts">
44 <a href="#glib-Key-value-file-parser.synopsis" class="shortcut">Top</a>
46 <a href="#glib-Key-value-file-parser.description" class="shortcut">Description</a>
49 <div class="refentry" title="Key-value file parser">
50 <a name="glib-Key-value-file-parser"></a><div class="titlepage"></div>
51 <div class="refnamediv"><table width="100%"><tr>
53 <h2><span class="refentrytitle"><a name="glib-Key-value-file-parser.top_of_page"></a>Key-value file parser</span></h2>
54 <p>Key-value file parser — parses <code class="filename">.ini</code>-like config files</p>
56 <td valign="top" align="right"></td>
58 <div class="refsynopsisdiv" title="Synopsis">
59 <a name="glib-Key-value-file-parser.synopsis"></a><h2>Synopsis</h2>
60 <pre class="synopsis">
61 #include <glib.h>
63 <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile">GKeyFile</a>;
64 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR:CAPS" title="G_KEY_FILE_ERROR">G_KEY_FILE_ERROR</a>
65 enum <a class="link" href="glib-Key-value-file-parser.html#GKeyFileError" title="enum GKeyFileError">GKeyFileError</a>;
66 enum <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags">GKeyFileFlags</a>;
68 <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> * <a class="link" href="glib-Key-value-file-parser.html#g-key-file-new" title="g_key_file_new ()">g_key_file_new</a> (void);
69 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-free" title="g_key_file_free ()">g_key_file_free</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file);
70 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-list-separator" title="g_key_file_set_list_separator ()">g_key_file_set_list_separator</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
71 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> separator);
72 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-load-from-file" title="g_key_file_load_from_file ()">g_key_file_load_from_file</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
73 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *file,
74 <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="returnvalue">GKeyFileFlags</span></a> flags,
75 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
76 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-load-from-data" title="g_key_file_load_from_data ()">g_key_file_load_from_data</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
77 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *data,
78 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length,
79 <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="returnvalue">GKeyFileFlags</span></a> flags,
80 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
81 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-load-from-data-dirs" title="g_key_file_load_from_data_dirs ()">g_key_file_load_from_data_dirs</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
82 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *file,
83 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> **full_path,
84 <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="returnvalue">GKeyFileFlags</span></a> flags,
85 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
86 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-load-from-dirs" title="g_key_file_load_from_dirs ()">g_key_file_load_from_dirs</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
87 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *file,
88 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> **search_dirs,
89 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> **full_path,
90 <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="returnvalue">GKeyFileFlags</span></a> flags,
91 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
92 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="glib-Key-value-file-parser.html#g-key-file-to-data" title="g_key_file_to_data ()">g_key_file_to_data</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
93 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
94 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
95 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-start-group" title="g_key_file_get_start_group ()">g_key_file_get_start_group</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file);
96 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> ** <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-groups" title="g_key_file_get_groups ()">g_key_file_get_groups</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
97 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length);
98 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> ** <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-keys" title="g_key_file_get_keys ()">g_key_file_get_keys</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
99 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
100 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
101 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
102 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-has-group" title="g_key_file_has_group ()">g_key_file_has_group</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
103 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name);
104 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-has-key" title="g_key_file_has_key ()">g_key_file_has_key</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
105 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
106 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
107 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
109 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-value" title="g_key_file_get_value ()">g_key_file_get_value</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
110 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
111 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
112 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
113 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-string" title="g_key_file_get_string ()">g_key_file_get_string</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
114 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
115 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
116 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
117 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-locale-string" title="g_key_file_get_locale_string ()">g_key_file_get_locale_string</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
118 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
119 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
120 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *locale,
121 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
122 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-boolean" title="g_key_file_get_boolean ()">g_key_file_get_boolean</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
123 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
124 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
125 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
126 <a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-integer" title="g_key_file_get_integer ()">g_key_file_get_integer</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
127 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
128 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
129 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
130 <a class="link" href="glib-Basic-Types.html#gdouble" title="gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-double" title="g_key_file_get_double ()">g_key_file_get_double</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
131 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
132 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
133 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
134 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> ** <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-string-list" title="g_key_file_get_string_list ()">g_key_file_get_string_list</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
135 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
136 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
137 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
138 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
139 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> ** <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-locale-string-list" title="g_key_file_get_locale_string_list ()">g_key_file_get_locale_string_list</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
140 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
141 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
142 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *locale,
143 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
144 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
145 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> * <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-boolean-list" title="g_key_file_get_boolean_list ()">g_key_file_get_boolean_list</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
146 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
147 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
148 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
149 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
150 <a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a> * <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-integer-list" title="g_key_file_get_integer_list ()">g_key_file_get_integer_list</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
151 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
152 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
153 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
154 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
155 <a class="link" href="glib-Basic-Types.html#gdouble" title="gdouble"><span class="returnvalue">gdouble</span></a> * <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-double-list" title="g_key_file_get_double_list ()">g_key_file_get_double_list</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
156 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
157 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
158 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
159 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
160 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-comment" title="g_key_file_get_comment ()">g_key_file_get_comment</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
161 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
162 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
163 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
165 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-value" title="g_key_file_set_value ()">g_key_file_set_value</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
166 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
167 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
168 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *value);
169 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-string" title="g_key_file_set_string ()">g_key_file_set_string</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
170 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
171 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
172 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *string);
173 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-locale-string" title="g_key_file_set_locale_string ()">g_key_file_set_locale_string</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
174 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
175 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
176 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *locale,
177 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *string);
178 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-boolean" title="g_key_file_set_boolean ()">g_key_file_set_boolean</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
179 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
180 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
181 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> value);
182 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-integer" title="g_key_file_set_integer ()">g_key_file_set_integer</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
183 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
184 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
185 <a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a> value);
186 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-double" title="g_key_file_set_double ()">g_key_file_set_double</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
187 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
188 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
189 <a class="link" href="glib-Basic-Types.html#gdouble" title="gdouble"><span class="returnvalue">gdouble</span></a> value);
190 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-string-list" title="g_key_file_set_string_list ()">g_key_file_set_string_list</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
191 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
192 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
193 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * const list[],
194 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length);
195 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-locale-string-list" title="g_key_file_set_locale_string_list ()">g_key_file_set_locale_string_list</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
196 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
197 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
198 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *locale,
199 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * const list[],
200 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length);
201 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-boolean-list" title="g_key_file_set_boolean_list ()">g_key_file_set_boolean_list</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
202 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
203 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
204 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> list[],
205 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length);
206 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-integer-list" title="g_key_file_set_integer_list ()">g_key_file_set_integer_list</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
207 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
208 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
209 <a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a> list[],
210 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length);
211 <span class="returnvalue">void</span> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-double-list" title="g_key_file_set_double_list ()">g_key_file_set_double_list</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
212 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
213 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
214 <a class="link" href="glib-Basic-Types.html#gdouble" title="gdouble"><span class="returnvalue">gdouble</span></a> list[],
215 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length);
216 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-comment" title="g_key_file_set_comment ()">g_key_file_set_comment</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
217 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
218 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
219 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *comment,
220 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
221 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-remove-group" title="g_key_file_remove_group ()">g_key_file_remove_group</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
222 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
223 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
224 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-remove-key" title="g_key_file_remove_key ()">g_key_file_remove_key</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
225 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
226 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
227 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
228 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="glib-Key-value-file-parser.html#g-key-file-remove-comment" title="g_key_file_remove_comment ()">g_key_file_remove_comment</a> (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
229 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
230 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
231 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);
233 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP">G_KEY_FILE_DESKTOP_GROUP</a>
234 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-TYPE:CAPS" title="G_KEY_FILE_DESKTOP_KEY_TYPE">G_KEY_FILE_DESKTOP_KEY_TYPE</a>
235 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-VERSION:CAPS" title="G_KEY_FILE_DESKTOP_KEY_VERSION">G_KEY_FILE_DESKTOP_KEY_VERSION</a>
236 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-NAME:CAPS" title="G_KEY_FILE_DESKTOP_KEY_NAME">G_KEY_FILE_DESKTOP_KEY_NAME</a>
237 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-GENERIC-NAME:CAPS" title="G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME">G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME</a>
238 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-NO-DISPLAY:CAPS" title="G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY">G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY</a>
239 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-COMMENT:CAPS" title="G_KEY_FILE_DESKTOP_KEY_COMMENT">G_KEY_FILE_DESKTOP_KEY_COMMENT</a>
240 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-ICON:CAPS" title="G_KEY_FILE_DESKTOP_KEY_ICON">G_KEY_FILE_DESKTOP_KEY_ICON</a>
241 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-HIDDEN:CAPS" title="G_KEY_FILE_DESKTOP_KEY_HIDDEN">G_KEY_FILE_DESKTOP_KEY_HIDDEN</a>
242 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-ONLY-SHOW-IN:CAPS" title="G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN">G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN</a>
243 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-NOT-SHOW-IN:CAPS" title="G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN">G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN</a>
244 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-TRY-EXEC:CAPS" title="G_KEY_FILE_DESKTOP_KEY_TRY_EXEC">G_KEY_FILE_DESKTOP_KEY_TRY_EXEC</a>
245 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-EXEC:CAPS" title="G_KEY_FILE_DESKTOP_KEY_EXEC">G_KEY_FILE_DESKTOP_KEY_EXEC</a>
246 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-PATH:CAPS" title="G_KEY_FILE_DESKTOP_KEY_PATH">G_KEY_FILE_DESKTOP_KEY_PATH</a>
247 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-TERMINAL:CAPS" title="G_KEY_FILE_DESKTOP_KEY_TERMINAL">G_KEY_FILE_DESKTOP_KEY_TERMINAL</a>
248 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-MIME-TYPE:CAPS" title="G_KEY_FILE_DESKTOP_KEY_MIME_TYPE">G_KEY_FILE_DESKTOP_KEY_MIME_TYPE</a>
249 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-CATEGORIES:CAPS" title="G_KEY_FILE_DESKTOP_KEY_CATEGORIES">G_KEY_FILE_DESKTOP_KEY_CATEGORIES</a>
250 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-STARTUP-NOTIFY:CAPS" title="G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY">G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY</a>
251 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-STARTUP-WM-CLASS:CAPS" title="G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS">G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS</a>
252 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-URL:CAPS" title="G_KEY_FILE_DESKTOP_KEY_URL">G_KEY_FILE_DESKTOP_KEY_URL</a>
253 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-TYPE-APPLICATION:CAPS" title="G_KEY_FILE_DESKTOP_TYPE_APPLICATION">G_KEY_FILE_DESKTOP_TYPE_APPLICATION</a>
254 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-TYPE-LINK:CAPS" title="G_KEY_FILE_DESKTOP_TYPE_LINK">G_KEY_FILE_DESKTOP_TYPE_LINK</a>
255 #define <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-TYPE-DIRECTORY:CAPS" title="G_KEY_FILE_DESKTOP_TYPE_DIRECTORY">G_KEY_FILE_DESKTOP_TYPE_DIRECTORY</a>
258 <div class="refsect1" title="Description">
259 <a name="glib-Key-value-file-parser.description"></a><h2>Description</h2>
261 <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a> lets you parse, edit or create files containing groups of
262 key-value pairs, which we call <em class="firstterm">key files</em> for
263 lack of a better name. Several freedesktop.org specifications use
264 key files now, e.g the
265 <a class="ulink" href="http://freedesktop.org/Standards/desktop-entry-spec" target="_top">Desktop
266 Entry Specification</a> and the
267 <a class="ulink" href="http://freedesktop.org/Standards/icon-theme-spec" target="_top">Icon
268 Theme Specification</a>.
271 The syntax of key files is described in detail in the
272 <a class="ulink" href="http://freedesktop.org/Standards/desktop-entry-spec" target="_top">Desktop
273 Entry Specification</a>, here is a quick summary: Key files
274 consists of groups of key-value pairs, interspersed with comments.
276 <div class="informalexample"><pre class="programlisting">
277 # this is just an example
278 # there can be comments before the first group
280 Name=Key File Example\tthis value shows\nescaping
281 # localized strings are stored in multiple key-value pairs
284 Welcome[fr_FR]=Bonjour
286 Welcome[be@latin]=Hello
289 Booleans=true;false;true;true
292 Lines beginning with a '#' and blank lines are considered comments.
295 Groups are started by a header line containing the group name enclosed
296 in '[' and ']', and ended implicitly by the start of the next group or
297 the end of the file. Each key-value pair must be contained in a group.
300 Key-value pairs generally have the form <code class="literal">key=value</code>,
301 with the exception of localized strings, which have the form
302 <code class="literal">key[locale]=value</code>, with a locale identifier of the form
303 <code class="literal">lang_COUNTRY<em class="parameter"><code>MODIFIER</code></em></code> where <code class="literal">COUNTRY</code> and
304 <code class="literal">MODIFIER</code> are optional. Space before and after the
305 '=' character are ignored. Newline, tab, carriage return and backslash
306 characters in value are escaped as \n, \t, \r, and \\, respectively.
307 To preserve leading spaces in values, these can also be escaped as \s.
310 Key files can store strings (possibly with localized variants), integers,
311 booleans and lists of these. Lists are separated by a separator character,
312 typically ';' or ','. To use the list separator character in a value in
313 a list, it has to be escaped by prefixing it with a backslash.
316 This syntax is obviously inspired by the <code class="filename">.ini</code>
317 files commonly met on Windows, but there are some important differences:
319 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
320 <li class="listitem"><p>
321 <code class="filename">.ini</code> files use the ';' character to begin comments,
322 key files use the '#' character.
324 <li class="listitem"><p>
325 Key files do not allow for ungrouped keys meaning only comments can precede the first group.
327 <li class="listitem"><p>
328 Key files are always encoded in UTF-8.
330 <li class="listitem"><p>
331 Key and Group names are case-sensitive, for example a group called
332 <code class="literal">[GROUP]</code> is a different group from <code class="literal">[group]</code>.
334 <li class="listitem"><p>
335 <code class="filename">.ini</code> files don't have a strongly typed boolean entry type, they only
336 have <code class="literal">GetProfileInt</code>. In <span class="structname">GKeyFile</span> only
337 <code class="literal">true</code> and <code class="literal">false</code> (in lower case) are allowed.
343 Note that in contrast to the
344 <a class="ulink" href="http://freedesktop.org/Standards/desktop-entry-spec" target="_top">Desktop
345 Entry Specification</a>, groups in key files may contain the same
346 key multiple times; the last entry wins. Key files may also contain
347 multiple groups with the same name; they are merged together.
348 Another difference is that keys and group names in key files are not
349 restricted to ASCII characters.
352 <div class="refsect1" title="Details">
353 <a name="glib-Key-value-file-parser.details"></a><h2>Details</h2>
354 <div class="refsect2" title="GKeyFile">
355 <a name="GKeyFile"></a><h3>GKeyFile</h3>
356 <pre class="programlisting">typedef struct _GKeyFile GKeyFile;</pre>
358 The <span class="structname">GKeyFile</span> struct contains only private fields
359 and should not be used directly.
363 <div class="refsect2" title="G_KEY_FILE_ERROR">
364 <a name="G-KEY-FILE-ERROR:CAPS"></a><h3>G_KEY_FILE_ERROR</h3>
365 <pre class="programlisting">#define G_KEY_FILE_ERROR g_key_file_error_quark()
368 Error domain for key file parsing. Errors in this domain will
369 be from the <a class="link" href="glib-Key-value-file-parser.html#GKeyFileError" title="enum GKeyFileError"><span class="type">GKeyFileError</span></a> enumeration. See <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a> for information on
374 <div class="refsect2" title="enum GKeyFileError">
375 <a name="GKeyFileError"></a><h3>enum GKeyFileError</h3>
376 <pre class="programlisting">typedef enum
378 G_KEY_FILE_ERROR_UNKNOWN_ENCODING,
379 G_KEY_FILE_ERROR_PARSE,
380 G_KEY_FILE_ERROR_NOT_FOUND,
381 G_KEY_FILE_ERROR_KEY_NOT_FOUND,
382 G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
383 G_KEY_FILE_ERROR_INVALID_VALUE
387 Error codes returned by key file parsing.
389 <div class="variablelist"><table border="0">
390 <col align="left" valign="top">
393 <td><p><a name="G-KEY-FILE-ERROR-UNKNOWN-ENCODING:CAPS"></a><span class="term"><code class="literal">G_KEY_FILE_ERROR_UNKNOWN_ENCODING</code></span></p></td>
394 <td>the text being parsed was in an unknown encoding
398 <td><p><a name="G-KEY-FILE-ERROR-PARSE:CAPS"></a><span class="term"><code class="literal">G_KEY_FILE_ERROR_PARSE</code></span></p></td>
399 <td>document was ill-formed
403 <td><p><a name="G-KEY-FILE-ERROR-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">G_KEY_FILE_ERROR_NOT_FOUND</code></span></p></td>
404 <td>the file was not found
408 <td><p><a name="G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">G_KEY_FILE_ERROR_KEY_NOT_FOUND</code></span></p></td>
409 <td>a requested key was not found
413 <td><p><a name="G-KEY-FILE-ERROR-GROUP-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">G_KEY_FILE_ERROR_GROUP_NOT_FOUND</code></span></p></td>
414 <td>a requested group was not found
418 <td><p><a name="G-KEY-FILE-ERROR-INVALID-VALUE:CAPS"></a><span class="term"><code class="literal">G_KEY_FILE_ERROR_INVALID_VALUE</code></span></p></td>
419 <td>a value could not be parsed
426 <div class="refsect2" title="enum GKeyFileFlags">
427 <a name="GKeyFileFlags"></a><h3>enum GKeyFileFlags</h3>
428 <pre class="programlisting">typedef enum
431 G_KEY_FILE_KEEP_COMMENTS = 1 << 0,
432 G_KEY_FILE_KEEP_TRANSLATIONS = 1 << 1
436 Flags which influence the parsing.
438 <div class="variablelist"><table border="0">
439 <col align="left" valign="top">
442 <td><p><a name="G-KEY-FILE-NONE:CAPS"></a><span class="term"><code class="literal">G_KEY_FILE_NONE</code></span></p></td>
443 <td>No flags, default behaviour
447 <td><p><a name="G-KEY-FILE-KEEP-COMMENTS:CAPS"></a><span class="term"><code class="literal">G_KEY_FILE_KEEP_COMMENTS</code></span></p></td>
448 <td>Use this flag if you plan to write the (possibly modified)
449 contents of the key file back to a file; otherwise all comments will be lost when
450 the key file is written back.
454 <td><p><a name="G-KEY-FILE-KEEP-TRANSLATIONS:CAPS"></a><span class="term"><code class="literal">G_KEY_FILE_KEEP_TRANSLATIONS</code></span></p></td>
455 <td>Use this flag if you plan to write the (possibly modified)
456 contents of the key file back to a file; otherwise only the translations for the current
457 language will be written back.
464 <div class="refsect2" title="g_key_file_new ()">
465 <a name="g-key-file-new"></a><h3>g_key_file_new ()</h3>
466 <pre class="programlisting"><a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> * g_key_file_new (void);</pre>
468 Creates a new empty <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a> object. Use
469 <a class="link" href="glib-Key-value-file-parser.html#g-key-file-load-from-file" title="g_key_file_load_from_file ()"><code class="function">g_key_file_load_from_file()</code></a>, <a class="link" href="glib-Key-value-file-parser.html#g-key-file-load-from-data" title="g_key_file_load_from_data ()"><code class="function">g_key_file_load_from_data()</code></a>,
470 <a class="link" href="glib-Key-value-file-parser.html#g-key-file-load-from-dirs" title="g_key_file_load_from_dirs ()"><code class="function">g_key_file_load_from_dirs()</code></a> or <a class="link" href="glib-Key-value-file-parser.html#g-key-file-load-from-data-dirs" title="g_key_file_load_from_data_dirs ()"><code class="function">g_key_file_load_from_data_dirs()</code></a> to
471 read an existing key file.</p>
472 <div class="variablelist"><table border="0">
473 <col align="left" valign="top">
475 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
476 <td> an empty <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>.
481 <p class="since">Since 2.6</p>
484 <div class="refsect2" title="g_key_file_free ()">
485 <a name="g-key-file-free"></a><h3>g_key_file_free ()</h3>
486 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_free (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file);</pre>
488 Frees a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>.</p>
489 <div class="variablelist"><table border="0">
490 <col align="left" valign="top">
492 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
493 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
497 <p class="since">Since 2.6</p>
500 <div class="refsect2" title="g_key_file_set_list_separator ()">
501 <a name="g-key-file-set-list-separator"></a><h3>g_key_file_set_list_separator ()</h3>
502 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_list_separator (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
503 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> separator);</pre>
505 Sets the character which is used to separate
506 values in lists. Typically ';' or ',' are used
507 as separators. The default list separator is ';'.</p>
508 <div class="variablelist"><table border="0">
509 <col align="left" valign="top">
512 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
513 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
517 <td><p><span class="term"><em class="parameter"><code>separator</code></em> :</span></p></td>
523 <p class="since">Since 2.6</p>
526 <div class="refsect2" title="g_key_file_load_from_file ()">
527 <a name="g-key-file-load-from-file"></a><h3>g_key_file_load_from_file ()</h3>
528 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> g_key_file_load_from_file (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
529 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *file,
530 <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="returnvalue">GKeyFileFlags</span></a> flags,
531 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
533 Loads a key file into an empty <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a> structure.
534 If the file could not be loaded then <code class="literal">error</code> is set to
535 either a <a class="link" href="glib-File-Utilities.html#GFileError" title="enum GFileError"><span class="type">GFileError</span></a> or <a class="link" href="glib-Key-value-file-parser.html#GKeyFileError" title="enum GKeyFileError"><span class="type">GKeyFileError</span></a>.</p>
536 <div class="variablelist"><table border="0">
537 <col align="left" valign="top">
540 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
541 <td> an empty <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a> struct
545 <td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
546 <td> the path of a filename to load, in the GLib filename encoding
550 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
551 <td> flags from <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="type">GKeyFileFlags</span></a>
555 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
556 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
560 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
561 <td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if a key file could be loaded, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a> otherwise
567 <p class="since">Since 2.6</p>
570 <div class="refsect2" title="g_key_file_load_from_data ()">
571 <a name="g-key-file-load-from-data"></a><h3>g_key_file_load_from_data ()</h3>
572 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> g_key_file_load_from_data (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
573 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *data,
574 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length,
575 <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="returnvalue">GKeyFileFlags</span></a> flags,
576 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
578 Loads a key file from memory into an empty <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a> structure.
579 If the object cannot be created then <code class="literal">error</code> is set to a <a class="link" href="glib-Key-value-file-parser.html#GKeyFileError" title="enum GKeyFileError"><span class="type">GKeyFileError</span></a>.</p>
580 <div class="variablelist"><table border="0">
581 <col align="left" valign="top">
584 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
585 <td> an empty <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a> struct
589 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
590 <td> key file loaded in memory
594 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
595 <td> the length of <em class="parameter"><code>data</code></em> in bytes
599 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
600 <td> flags from <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="type">GKeyFileFlags</span></a>
604 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
605 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
609 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
610 <td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if a key file could be loaded, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a> otherwise
616 <p class="since">Since 2.6</p>
619 <div class="refsect2" title="g_key_file_load_from_data_dirs ()">
620 <a name="g-key-file-load-from-data-dirs"></a><h3>g_key_file_load_from_data_dirs ()</h3>
621 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> g_key_file_load_from_data_dirs (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
622 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *file,
623 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> **full_path,
624 <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="returnvalue">GKeyFileFlags</span></a> flags,
625 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
627 This function looks for a key file named <em class="parameter"><code>file</code></em> in the paths
628 returned from <a class="link" href="glib-Miscellaneous-Utility-Functions.html#g-get-user-data-dir" title="g_get_user_data_dir ()"><code class="function">g_get_user_data_dir()</code></a> and <a class="link" href="glib-Miscellaneous-Utility-Functions.html#g-get-system-data-dirs" title="g_get_system_data_dirs ()"><code class="function">g_get_system_data_dirs()</code></a>,
629 loads the file into <em class="parameter"><code>key_file</code></em> and returns the file's full path in
630 <em class="parameter"><code>full_path</code></em>. If the file could not be loaded then an <code class="literal">error</code> is
631 set to either a <a class="link" href="glib-File-Utilities.html#GFileError" title="enum GFileError"><span class="type">GFileError</span></a> or <a class="link" href="glib-Key-value-file-parser.html#GKeyFileError" title="enum GKeyFileError"><span class="type">GKeyFileError</span></a>.</p>
632 <div class="variablelist"><table border="0">
633 <col align="left" valign="top">
636 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
637 <td> an empty <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a> struct
641 <td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
642 <td> a relative path to a filename to open and parse
646 <td><p><span class="term"><em class="parameter"><code>full_path</code></em> :</span></p></td>
647 <td> return location for a string containing the full path
648 of the file, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
652 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
653 <td> flags from <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="type">GKeyFileFlags</span></a>
657 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
658 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
662 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
663 <td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if a key file could be loaded, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a> othewise
668 <p class="since">Since 2.6</p>
671 <div class="refsect2" title="g_key_file_load_from_dirs ()">
672 <a name="g-key-file-load-from-dirs"></a><h3>g_key_file_load_from_dirs ()</h3>
673 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> g_key_file_load_from_dirs (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
674 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *file,
675 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> **search_dirs,
676 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> **full_path,
677 <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="returnvalue">GKeyFileFlags</span></a> flags,
678 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
680 This function looks for a key file named <em class="parameter"><code>file</code></em> in the paths
681 specified in <em class="parameter"><code>search_dirs</code></em>, loads the file into <em class="parameter"><code>key_file</code></em> and
682 returns the file's full path in <em class="parameter"><code>full_path</code></em>. If the file could not
683 be loaded then an <code class="literal">error</code> is set to either a <a class="link" href="glib-File-Utilities.html#GFileError" title="enum GFileError"><span class="type">GFileError</span></a> or
684 <a class="link" href="glib-Key-value-file-parser.html#GKeyFileError" title="enum GKeyFileError"><span class="type">GKeyFileError</span></a>.</p>
685 <div class="variablelist"><table border="0">
686 <col align="left" valign="top">
689 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
690 <td> an empty <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a> struct
694 <td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
695 <td> a relative path to a filename to open and parse
699 <td><p><span class="term"><em class="parameter"><code>search_dirs</code></em> :</span></p></td>
700 <td> <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>-terminated array of directories to search
704 <td><p><span class="term"><em class="parameter"><code>full_path</code></em> :</span></p></td>
705 <td> return location for a string containing the full path
706 of the file, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
710 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
711 <td> flags from <a class="link" href="glib-Key-value-file-parser.html#GKeyFileFlags" title="enum GKeyFileFlags"><span class="type">GKeyFileFlags</span></a>
715 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
716 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
720 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
721 <td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if a key file could be loaded, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a> otherwise
727 <p class="since">Since 2.14</p>
730 <div class="refsect2" title="g_key_file_to_data ()">
731 <a name="g-key-file-to-data"></a><h3>g_key_file_to_data ()</h3>
732 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * g_key_file_to_data (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
733 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
734 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
736 This function outputs <em class="parameter"><code>key_file</code></em> as a string.
739 Note that this function never reports an error,
740 so it is safe to pass <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> as <em class="parameter"><code>error</code></em>.</p>
741 <div class="variablelist"><table border="0">
742 <col align="left" valign="top">
745 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
746 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
750 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
751 <td> return location for the length of the
752 returned string, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
756 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
757 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
761 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
762 <td> a newly allocated string holding
763 the contents of the <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
769 <p class="since">Since 2.6</p>
772 <div class="refsect2" title="g_key_file_get_start_group ()">
773 <a name="g-key-file-get-start-group"></a><h3>g_key_file_get_start_group ()</h3>
774 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * g_key_file_get_start_group (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file);</pre>
776 Returns the name of the start group of the file.</p>
777 <div class="variablelist"><table border="0">
778 <col align="left" valign="top">
781 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
782 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
786 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
787 <td> The start group of the key file.
793 <p class="since">Since 2.6</p>
796 <div class="refsect2" title="g_key_file_get_groups ()">
797 <a name="g-key-file-get-groups"></a><h3>g_key_file_get_groups ()</h3>
798 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> ** g_key_file_get_groups (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
799 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length);</pre>
801 Returns all groups in the key file loaded with <em class="parameter"><code>key_file</code></em>.
802 The array of returned groups will be <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>-terminated, so
803 <em class="parameter"><code>length</code></em> may optionally be <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>.</p>
804 <div class="variablelist"><table border="0">
805 <col align="left" valign="top">
808 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
809 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
813 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
814 <td> return location for the number of returned groups, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
818 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
819 <td> a newly-allocated <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>-terminated array of strings.
820 Use <a class="link" href="glib-String-Utility-Functions.html#g-strfreev" title="g_strfreev ()"><code class="function">g_strfreev()</code></a> to free it.
825 <p class="since">Since 2.6</p>
828 <div class="refsect2" title="g_key_file_get_keys ()">
829 <a name="g-key-file-get-keys"></a><h3>g_key_file_get_keys ()</h3>
830 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> ** g_key_file_get_keys (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
831 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
832 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
833 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
835 Returns all keys for the group name <em class="parameter"><code>group_name</code></em>. The array of
836 returned keys will be <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>-terminated, so <em class="parameter"><code>length</code></em> may
837 optionally be <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>. In the event that the <em class="parameter"><code>group_name</code></em> cannot
838 be found, <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned and <em class="parameter"><code>error</code></em> is set to
839 <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-GROUP-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_GROUP_NOT_FOUND</span></a>.</p>
840 <div class="variablelist"><table border="0">
841 <col align="left" valign="top">
844 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
845 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
849 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
854 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
855 <td> return location for the number of keys returned, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
859 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
860 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
864 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
865 <td> a newly-allocated <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>-terminated array of strings.
866 Use <a class="link" href="glib-String-Utility-Functions.html#g-strfreev" title="g_strfreev ()"><code class="function">g_strfreev()</code></a> to free it.
872 <p class="since">Since 2.6</p>
875 <div class="refsect2" title="g_key_file_has_group ()">
876 <a name="g-key-file-has-group"></a><h3>g_key_file_has_group ()</h3>
877 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> g_key_file_has_group (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
878 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name);</pre>
880 Looks whether the key file has the group <em class="parameter"><code>group_name</code></em>.</p>
881 <div class="variablelist"><table border="0">
882 <col align="left" valign="top">
885 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
886 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
890 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
895 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
896 <td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if <em class="parameter"><code>group_name</code></em> is a part of <em class="parameter"><code>key_file</code></em>, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a>
902 <p class="since">Since 2.6</p>
905 <div class="refsect2" title="g_key_file_has_key ()">
906 <a name="g-key-file-has-key"></a><h3>g_key_file_has_key ()</h3>
907 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> g_key_file_has_key (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
908 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
909 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
910 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
912 Looks whether the key file has the key <em class="parameter"><code>key</code></em> in the group
913 <em class="parameter"><code>group_name</code></em>.</p>
914 <div class="variablelist"><table border="0">
915 <col align="left" valign="top">
918 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
919 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
923 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
928 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
933 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
934 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>
938 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
939 <td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if <em class="parameter"><code>key</code></em> is a part of <em class="parameter"><code>group_name</code></em>, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a>
946 <p class="since">Since 2.6</p>
949 <div class="refsect2" title="g_key_file_get_value ()">
950 <a name="g-key-file-get-value"></a><h3>g_key_file_get_value ()</h3>
951 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * g_key_file_get_value (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
952 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
953 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
954 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
956 Returns the raw value associated with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>.
957 Use <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-string" title="g_key_file_get_string ()"><code class="function">g_key_file_get_string()</code></a> to retrieve an unescaped UTF-8 string.
960 In the event the key cannot be found, <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned and
961 <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_KEY_NOT_FOUND</span></a>. In the
962 event that the <em class="parameter"><code>group_name</code></em> cannot be found, <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned
963 and <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-GROUP-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_GROUP_NOT_FOUND</span></a>.</p>
964 <div class="variablelist"><table border="0">
965 <col align="left" valign="top">
968 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
969 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
973 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
978 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
983 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
984 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
988 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
989 <td> a newly allocated string or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the specified
996 <p class="since">Since 2.6</p>
999 <div class="refsect2" title="g_key_file_get_string ()">
1000 <a name="g-key-file-get-string"></a><h3>g_key_file_get_string ()</h3>
1001 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * g_key_file_get_string (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1002 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1003 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1004 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
1006 Returns the string value associated with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>.
1007 Unlike <a class="link" href="glib-Key-value-file-parser.html#g-key-file-get-value" title="g_key_file_get_value ()"><code class="function">g_key_file_get_value()</code></a>, this function handles escape sequences
1011 In the event the key cannot be found, <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned and
1012 <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_KEY_NOT_FOUND</span></a>. In the
1013 event that the <em class="parameter"><code>group_name</code></em> cannot be found, <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned
1014 and <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-GROUP-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_GROUP_NOT_FOUND</span></a>.</p>
1015 <div class="variablelist"><table border="0">
1016 <col align="left" valign="top">
1019 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1020 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1024 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1029 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1034 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1035 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
1039 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1040 <td> a newly allocated string or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the specified
1041 key cannot be found.
1047 <p class="since">Since 2.6</p>
1050 <div class="refsect2" title="g_key_file_get_locale_string ()">
1051 <a name="g-key-file-get-locale-string"></a><h3>g_key_file_get_locale_string ()</h3>
1052 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * g_key_file_get_locale_string (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1053 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1054 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1055 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *locale,
1056 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
1058 Returns the value associated with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>
1059 translated in the given <em class="parameter"><code>locale</code></em> if available. If <em class="parameter"><code>locale</code></em> is
1060 <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> then the current locale is assumed.
1063 If <em class="parameter"><code>key</code></em> cannot be found then <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned and <em class="parameter"><code>error</code></em> is set
1064 to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_KEY_NOT_FOUND</span></a>. If the value associated
1065 with <em class="parameter"><code>key</code></em> cannot be interpreted or no suitable translation can
1066 be found then the untranslated value is returned.</p>
1067 <div class="variablelist"><table border="0">
1068 <col align="left" valign="top">
1071 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1072 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1076 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1081 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1086 <td><p><span class="term"><em class="parameter"><code>locale</code></em> :</span></p></td>
1087 <td> a locale identifier or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
1091 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1092 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
1096 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1097 <td> a newly allocated string or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the specified
1098 key cannot be found.
1104 <p class="since">Since 2.6</p>
1107 <div class="refsect2" title="g_key_file_get_boolean ()">
1108 <a name="g-key-file-get-boolean"></a><h3>g_key_file_get_boolean ()</h3>
1109 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> g_key_file_get_boolean (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1110 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1111 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1112 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
1114 Returns the value associated with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em> as a
1118 If <em class="parameter"><code>key</code></em> cannot be found then <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em> is set
1119 to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_KEY_NOT_FOUND</span></a>. Likewise, if the value
1120 associated with <em class="parameter"><code>key</code></em> cannot be interpreted as a boolean then <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a>
1121 is returned and <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-INVALID-VALUE:CAPS"><span class="type">G_KEY_FILE_ERROR_INVALID_VALUE</span></a>.</p>
1122 <div class="variablelist"><table border="0">
1123 <col align="left" valign="top">
1126 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1127 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1131 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1136 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1141 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1142 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>
1146 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1147 <td> the value associated with the key as a boolean,
1148 or <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a> if the key was not found or could not be parsed.
1154 <p class="since">Since 2.6</p>
1157 <div class="refsect2" title="g_key_file_get_integer ()">
1158 <a name="g-key-file-get-integer"></a><h3>g_key_file_get_integer ()</h3>
1159 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a> g_key_file_get_integer (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1160 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1161 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1162 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
1164 Returns the value associated with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em> as an
1168 If <em class="parameter"><code>key</code></em> cannot be found then 0 is returned and <em class="parameter"><code>error</code></em> is set to
1169 <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_KEY_NOT_FOUND</span></a>. Likewise, if the value associated
1170 with <em class="parameter"><code>key</code></em> cannot be interpreted as an integer then 0 is returned
1171 and <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-INVALID-VALUE:CAPS"><span class="type">G_KEY_FILE_ERROR_INVALID_VALUE</span></a>.</p>
1172 <div class="variablelist"><table border="0">
1173 <col align="left" valign="top">
1176 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1177 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1181 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1186 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1191 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1192 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>
1196 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1197 <td> the value associated with the key as an integer, or
1198 0 if the key was not found or could not be parsed.
1204 <p class="since">Since 2.6</p>
1207 <div class="refsect2" title="g_key_file_get_double ()">
1208 <a name="g-key-file-get-double"></a><h3>g_key_file_get_double ()</h3>
1209 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gdouble" title="gdouble"><span class="returnvalue">gdouble</span></a> g_key_file_get_double (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1210 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1211 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1212 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
1214 Returns the value associated with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em> as a
1215 double. If <em class="parameter"><code>group_name</code></em> is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, the start_group is used.
1218 If <em class="parameter"><code>key</code></em> cannot be found then 0.0 is returned and <em class="parameter"><code>error</code></em> is set to
1219 <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_KEY_NOT_FOUND</span></a>. Likewise, if the value associated
1220 with <em class="parameter"><code>key</code></em> cannot be interpreted as a double then 0.0 is returned
1221 and <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-INVALID-VALUE:CAPS"><span class="type">G_KEY_FILE_ERROR_INVALID_VALUE</span></a>.</p>
1222 <div class="variablelist"><table border="0">
1223 <col align="left" valign="top">
1226 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1227 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1231 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1236 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1241 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1242 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>
1246 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1247 <td> the value associated with the key as a double, or
1248 0.0 if the key was not found or could not be parsed.
1254 <p class="since">Since 2.12</p>
1257 <div class="refsect2" title="g_key_file_get_string_list ()">
1258 <a name="g-key-file-get-string-list"></a><h3>g_key_file_get_string_list ()</h3>
1259 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> ** g_key_file_get_string_list (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1260 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1261 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1262 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
1263 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
1265 Returns the values associated with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>.
1268 In the event the key cannot be found, <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned and
1269 <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_KEY_NOT_FOUND</span></a>. In the
1270 event that the <em class="parameter"><code>group_name</code></em> cannot be found, <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned
1271 and <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-GROUP-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_GROUP_NOT_FOUND</span></a>.</p>
1272 <div class="variablelist"><table border="0">
1273 <col align="left" valign="top">
1276 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1277 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1281 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1286 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1291 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
1292 <td> return location for the number of returned strings, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
1296 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1297 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
1301 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1302 <td> a <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>-terminated string array or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the specified
1303 key cannot be found. The array should be freed with <a class="link" href="glib-String-Utility-Functions.html#g-strfreev" title="g_strfreev ()"><code class="function">g_strfreev()</code></a>.
1309 <p class="since">Since 2.6</p>
1312 <div class="refsect2" title="g_key_file_get_locale_string_list ()">
1313 <a name="g-key-file-get-locale-string-list"></a><h3>g_key_file_get_locale_string_list ()</h3>
1314 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> ** g_key_file_get_locale_string_list (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1315 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1316 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1317 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *locale,
1318 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
1319 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
1321 Returns the values associated with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>
1322 translated in the given <em class="parameter"><code>locale</code></em> if available. If <em class="parameter"><code>locale</code></em> is
1323 <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> then the current locale is assumed.
1326 If <em class="parameter"><code>key</code></em> cannot be found then <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned and <em class="parameter"><code>error</code></em> is set
1327 to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_KEY_NOT_FOUND</span></a>. If the values associated
1328 with <em class="parameter"><code>key</code></em> cannot be interpreted or no suitable translations
1329 can be found then the untranslated values are returned. The
1330 returned array is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>-terminated, so <em class="parameter"><code>length</code></em> may optionally
1331 be <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>.</p>
1332 <div class="variablelist"><table border="0">
1333 <col align="left" valign="top">
1336 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1337 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1341 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1346 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1351 <td><p><span class="term"><em class="parameter"><code>locale</code></em> :</span></p></td>
1352 <td> a locale identifier or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
1356 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
1357 <td> return location for the number of returned strings or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
1361 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1362 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a> or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
1366 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1367 <td> a newly allocated <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>-terminated string array
1368 or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the key isn't found. The string array should be freed
1369 with <a class="link" href="glib-String-Utility-Functions.html#g-strfreev" title="g_strfreev ()"><code class="function">g_strfreev()</code></a>.
1375 <p class="since">Since 2.6</p>
1378 <div class="refsect2" title="g_key_file_get_boolean_list ()">
1379 <a name="g-key-file-get-boolean-list"></a><h3>g_key_file_get_boolean_list ()</h3>
1380 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> * g_key_file_get_boolean_list (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1381 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1382 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1383 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
1384 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
1386 Returns the values associated with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em> as
1390 If <em class="parameter"><code>key</code></em> cannot be found then <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned and <em class="parameter"><code>error</code></em> is set to
1391 <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_KEY_NOT_FOUND</span></a>. Likewise, if the values associated
1392 with <em class="parameter"><code>key</code></em> cannot be interpreted as booleans then <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned
1393 and <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-INVALID-VALUE:CAPS"><span class="type">G_KEY_FILE_ERROR_INVALID_VALUE</span></a>.</p>
1394 <div class="variablelist"><table border="0">
1395 <col align="left" valign="top">
1398 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1399 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1403 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1408 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1413 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
1414 <td> the number of booleans returned
1418 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1419 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>
1423 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1424 <td> the values associated with the key as a list of
1425 booleans, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the key was not found or could not be parsed.
1431 <p class="since">Since 2.6</p>
1434 <div class="refsect2" title="g_key_file_get_integer_list ()">
1435 <a name="g-key-file-get-integer-list"></a><h3>g_key_file_get_integer_list ()</h3>
1436 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a> * g_key_file_get_integer_list (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1437 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1438 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1439 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
1440 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
1442 Returns the values associated with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em> as
1446 If <em class="parameter"><code>key</code></em> cannot be found then <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned and <em class="parameter"><code>error</code></em> is set to
1447 <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_KEY_NOT_FOUND</span></a>. Likewise, if the values associated
1448 with <em class="parameter"><code>key</code></em> cannot be interpreted as integers then <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned
1449 and <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-INVALID-VALUE:CAPS"><span class="type">G_KEY_FILE_ERROR_INVALID_VALUE</span></a>.</p>
1450 <div class="variablelist"><table border="0">
1451 <col align="left" valign="top">
1454 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1455 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1459 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1464 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1469 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
1470 <td> the number of integers returned
1474 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1475 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>
1479 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1480 <td> the values associated with the key as a list of
1481 integers, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the key was not found or could not be parsed.
1487 <p class="since">Since 2.6</p>
1490 <div class="refsect2" title="g_key_file_get_double_list ()">
1491 <a name="g-key-file-get-double-list"></a><h3>g_key_file_get_double_list ()</h3>
1492 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gdouble" title="gdouble"><span class="returnvalue">gdouble</span></a> * g_key_file_get_double_list (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1493 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1494 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1495 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> *length,
1496 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
1498 Returns the values associated with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em> as
1502 If <em class="parameter"><code>key</code></em> cannot be found then <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned and <em class="parameter"><code>error</code></em> is set to
1503 <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-KEY-NOT-FOUND:CAPS"><span class="type">G_KEY_FILE_ERROR_KEY_NOT_FOUND</span></a>. Likewise, if the values associated
1504 with <em class="parameter"><code>key</code></em> cannot be interpreted as doubles then <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is returned
1505 and <em class="parameter"><code>error</code></em> is set to <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-ERROR-INVALID-VALUE:CAPS"><span class="type">G_KEY_FILE_ERROR_INVALID_VALUE</span></a>.</p>
1506 <div class="variablelist"><table border="0">
1507 <col align="left" valign="top">
1510 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1511 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1515 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1520 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1525 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
1526 <td> the number of doubles returned
1530 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1531 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>
1535 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1536 <td> the values associated with the key as a list of
1537 doubles, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the key was not found or could not be parsed.
1543 <p class="since">Since 2.12</p>
1546 <div class="refsect2" title="g_key_file_get_comment ()">
1547 <a name="g-key-file-get-comment"></a><h3>g_key_file_get_comment ()</h3>
1548 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * g_key_file_get_comment (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1549 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1550 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1551 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
1553 Retrieves a comment above <em class="parameter"><code>key</code></em> from <em class="parameter"><code>group_name</code></em>.
1554 If <em class="parameter"><code>key</code></em> is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> then <em class="parameter"><code>comment</code></em> will be read from above
1555 <em class="parameter"><code>group_name</code></em>. If both <em class="parameter"><code>key</code></em> and <em class="parameter"><code>group_name</code></em> are <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, then
1556 <em class="parameter"><code>comment</code></em> will be read from above the first group in the file.</p>
1557 <div class="variablelist"><table border="0">
1558 <col align="left" valign="top">
1561 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1562 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1566 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1567 <td> a group name, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
1571 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1576 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1577 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>
1581 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1582 <td> a comment that should be freed with <a class="link" href="glib-Memory-Allocation.html#g-free" title="g_free ()"><code class="function">g_free()</code></a>
1588 <p class="since">Since 2.6</p>
1591 <div class="refsect2" title="g_key_file_set_value ()">
1592 <a name="g-key-file-set-value"></a><h3>g_key_file_set_value ()</h3>
1593 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_value (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1594 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1595 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1596 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *value);</pre>
1598 Associates a new value with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>.
1601 If <em class="parameter"><code>key</code></em> cannot be found then it is created. If <em class="parameter"><code>group_name</code></em> cannot
1602 be found then it is created. To set an UTF-8 string which may contain
1603 characters that need escaping (such as newlines or spaces), use
1604 <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-string" title="g_key_file_set_string ()"><code class="function">g_key_file_set_string()</code></a>.</p>
1605 <div class="variablelist"><table border="0">
1606 <col align="left" valign="top">
1609 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1610 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1614 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1619 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1624 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
1630 <p class="since">Since 2.6</p>
1633 <div class="refsect2" title="g_key_file_set_string ()">
1634 <a name="g-key-file-set-string"></a><h3>g_key_file_set_string ()</h3>
1635 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_string (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1636 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1637 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1638 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *string);</pre>
1640 Associates a new string value with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>.
1641 If <em class="parameter"><code>key</code></em> cannot be found then it is created.
1642 If <em class="parameter"><code>group_name</code></em> cannot be found then it is created.
1643 Unlike <a class="link" href="glib-Key-value-file-parser.html#g-key-file-set-value" title="g_key_file_set_value ()"><code class="function">g_key_file_set_value()</code></a>, this function handles characters
1644 that need escaping, such as newlines.</p>
1645 <div class="variablelist"><table border="0">
1646 <col align="left" valign="top">
1649 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1650 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1654 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1659 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1664 <td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
1670 <p class="since">Since 2.6</p>
1673 <div class="refsect2" title="g_key_file_set_locale_string ()">
1674 <a name="g-key-file-set-locale-string"></a><h3>g_key_file_set_locale_string ()</h3>
1675 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_locale_string (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1676 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1677 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1678 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *locale,
1679 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *string);</pre>
1681 Associates a string value for <em class="parameter"><code>key</code></em> and <em class="parameter"><code>locale</code></em> under <em class="parameter"><code>group_name</code></em>.
1682 If the translation for <em class="parameter"><code>key</code></em> cannot be found then it is created.</p>
1683 <div class="variablelist"><table border="0">
1684 <col align="left" valign="top">
1687 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1688 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1692 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1697 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1702 <td><p><span class="term"><em class="parameter"><code>locale</code></em> :</span></p></td>
1703 <td> a locale identifier
1707 <td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
1713 <p class="since">Since 2.6</p>
1716 <div class="refsect2" title="g_key_file_set_boolean ()">
1717 <a name="g-key-file-set-boolean"></a><h3>g_key_file_set_boolean ()</h3>
1718 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_boolean (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1719 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1720 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1721 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> value);</pre>
1723 Associates a new boolean value with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>.
1724 If <em class="parameter"><code>key</code></em> cannot be found then it is created.</p>
1725 <div class="variablelist"><table border="0">
1726 <col align="left" valign="top">
1729 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1730 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1734 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1739 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1744 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
1745 <td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> or <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a>
1750 <p class="since">Since 2.6</p>
1753 <div class="refsect2" title="g_key_file_set_integer ()">
1754 <a name="g-key-file-set-integer"></a><h3>g_key_file_set_integer ()</h3>
1755 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_integer (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1756 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1757 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1758 <a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a> value);</pre>
1760 Associates a new integer value with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>.
1761 If <em class="parameter"><code>key</code></em> cannot be found then it is created.</p>
1762 <div class="variablelist"><table border="0">
1763 <col align="left" valign="top">
1766 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1767 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1771 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1776 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1781 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
1782 <td> an integer value
1787 <p class="since">Since 2.6</p>
1790 <div class="refsect2" title="g_key_file_set_double ()">
1791 <a name="g-key-file-set-double"></a><h3>g_key_file_set_double ()</h3>
1792 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_double (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1793 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1794 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1795 <a class="link" href="glib-Basic-Types.html#gdouble" title="gdouble"><span class="returnvalue">gdouble</span></a> value);</pre>
1797 Associates a new double value with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>.
1798 If <em class="parameter"><code>key</code></em> cannot be found then it is created.</p>
1799 <div class="variablelist"><table border="0">
1800 <col align="left" valign="top">
1803 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1804 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1808 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1813 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1818 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
1819 <td> an double value
1824 <p class="since">Since 2.12</p>
1827 <div class="refsect2" title="g_key_file_set_string_list ()">
1828 <a name="g-key-file-set-string-list"></a><h3>g_key_file_set_string_list ()</h3>
1829 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_string_list (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1830 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1831 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1832 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * const list[],
1833 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length);</pre>
1835 Associates a list of string values for <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>.
1836 If <em class="parameter"><code>key</code></em> cannot be found then it is created.
1837 If <em class="parameter"><code>group_name</code></em> cannot be found then it is created.</p>
1838 <div class="variablelist"><table border="0">
1839 <col align="left" valign="top">
1842 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1843 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1847 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1852 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1857 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1858 <td> an array of string values
1862 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
1863 <td> number of string values in <em class="parameter"><code>list</code></em>
1868 <p class="since">Since 2.6</p>
1871 <div class="refsect2" title="g_key_file_set_locale_string_list ()">
1872 <a name="g-key-file-set-locale-string-list"></a><h3>g_key_file_set_locale_string_list ()</h3>
1873 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_locale_string_list (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1874 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1875 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1876 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *locale,
1877 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> * const list[],
1878 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length);</pre>
1880 Associates a list of string values for <em class="parameter"><code>key</code></em> and <em class="parameter"><code>locale</code></em> under
1881 <em class="parameter"><code>group_name</code></em>. If the translation for <em class="parameter"><code>key</code></em> cannot be found then
1883 <div class="variablelist"><table border="0">
1884 <col align="left" valign="top">
1887 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1888 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1892 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1897 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1902 <td><p><span class="term"><em class="parameter"><code>locale</code></em> :</span></p></td>
1903 <td> a locale identifier
1907 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1908 <td> a <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>-terminated array of locale string values
1912 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
1913 <td> the length of <em class="parameter"><code>list</code></em>
1918 <p class="since">Since 2.6</p>
1921 <div class="refsect2" title="g_key_file_set_boolean_list ()">
1922 <a name="g-key-file-set-boolean-list"></a><h3>g_key_file_set_boolean_list ()</h3>
1923 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_boolean_list (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1924 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1925 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1926 <a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> list[],
1927 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length);</pre>
1929 Associates a list of boolean values with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>.
1930 If <em class="parameter"><code>key</code></em> cannot be found then it is created.
1931 If <em class="parameter"><code>group_name</code></em> is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, the start_group is used.</p>
1932 <div class="variablelist"><table border="0">
1933 <col align="left" valign="top">
1936 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1937 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1941 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1946 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1951 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1952 <td> an array of boolean values
1956 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
1957 <td> length of <em class="parameter"><code>list</code></em>
1962 <p class="since">Since 2.6</p>
1965 <div class="refsect2" title="g_key_file_set_integer_list ()">
1966 <a name="g-key-file-set-integer-list"></a><h3>g_key_file_set_integer_list ()</h3>
1967 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_integer_list (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
1968 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
1969 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
1970 <a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a> list[],
1971 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length);</pre>
1973 Associates a list of integer values with <em class="parameter"><code>key</code></em> under <em class="parameter"><code>group_name</code></em>.
1974 If <em class="parameter"><code>key</code></em> cannot be found then it is created.</p>
1975 <div class="variablelist"><table border="0">
1976 <col align="left" valign="top">
1979 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
1980 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
1984 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
1989 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1994 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1995 <td> an array of integer values
1999 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
2000 <td> number of integer values in <em class="parameter"><code>list</code></em>
2005 <p class="since">Since 2.6</p>
2008 <div class="refsect2" title="g_key_file_set_double_list ()">
2009 <a name="g-key-file-set-double-list"></a><h3>g_key_file_set_double_list ()</h3>
2010 <pre class="programlisting"><span class="returnvalue">void</span> g_key_file_set_double_list (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
2011 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
2012 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
2013 <a class="link" href="glib-Basic-Types.html#gdouble" title="gdouble"><span class="returnvalue">gdouble</span></a> list[],
2014 <a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="returnvalue">gsize</span></a> length);</pre>
2016 Associates a list of double values with <em class="parameter"><code>key</code></em> under
2017 <em class="parameter"><code>group_name</code></em>. If <em class="parameter"><code>key</code></em> cannot be found then it is created.</p>
2018 <div class="variablelist"><table border="0">
2019 <col align="left" valign="top">
2022 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
2023 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
2027 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
2032 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
2037 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
2038 <td> an array of double values
2042 <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
2043 <td> number of double values in <em class="parameter"><code>list</code></em>
2048 <p class="since">Since 2.12</p>
2051 <div class="refsect2" title="g_key_file_set_comment ()">
2052 <a name="g-key-file-set-comment"></a><h3>g_key_file_set_comment ()</h3>
2053 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> g_key_file_set_comment (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
2054 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
2055 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
2056 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *comment,
2057 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
2059 Places a comment above <em class="parameter"><code>key</code></em> from <em class="parameter"><code>group_name</code></em>.
2060 If <em class="parameter"><code>key</code></em> is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> then <em class="parameter"><code>comment</code></em> will be written above <em class="parameter"><code>group_name</code></em>.
2061 If both <em class="parameter"><code>key</code></em> and <em class="parameter"><code>group_name</code></em> are <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, then <em class="parameter"><code>comment</code></em> will be
2062 written above the first group in the file.</p>
2063 <div class="variablelist"><table border="0">
2064 <col align="left" valign="top">
2067 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
2068 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
2072 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
2073 <td> a group name, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
2077 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
2082 <td><p><span class="term"><em class="parameter"><code>comment</code></em> :</span></p></td>
2087 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
2088 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>
2092 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2093 <td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if the comment was written, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a> otherwise
2099 <p class="since">Since 2.6</p>
2102 <div class="refsect2" title="g_key_file_remove_group ()">
2103 <a name="g-key-file-remove-group"></a><h3>g_key_file_remove_group ()</h3>
2104 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> g_key_file_remove_group (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
2105 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
2106 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
2108 Removes the specified group, <em class="parameter"><code>group_name</code></em>,
2109 from the key file.</p>
2110 <div class="variablelist"><table border="0">
2111 <col align="left" valign="top">
2114 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
2115 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
2119 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
2124 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
2125 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a> or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
2129 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2130 <td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if the group was removed, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a> otherwise
2136 <p class="since">Since 2.6</p>
2139 <div class="refsect2" title="g_key_file_remove_key ()">
2140 <a name="g-key-file-remove-key"></a><h3>g_key_file_remove_key ()</h3>
2141 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> g_key_file_remove_key (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
2142 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
2143 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
2144 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
2146 Removes <em class="parameter"><code>key</code></em> in <em class="parameter"><code>group_name</code></em> from the key file.</p>
2147 <div class="variablelist"><table border="0">
2148 <col align="left" valign="top">
2151 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
2152 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
2156 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
2161 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
2162 <td> a key name to remove
2166 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
2167 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a> or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
2171 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2172 <td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if the key was removed, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a> otherwise
2178 <p class="since">Since 2.6</p>
2181 <div class="refsect2" title="g_key_file_remove_comment ()">
2182 <a name="g-key-file-remove-comment"></a><h3>g_key_file_remove_comment ()</h3>
2183 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean" title="gboolean"><span class="returnvalue">gboolean</span></a> g_key_file_remove_comment (<a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="returnvalue">GKeyFile</span></a> *key_file,
2184 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *group_name,
2185 const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *key,
2186 <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="returnvalue">GError</span></a> **error);</pre>
2188 Removes a comment above <em class="parameter"><code>key</code></em> from <em class="parameter"><code>group_name</code></em>.
2189 If <em class="parameter"><code>key</code></em> is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> then <em class="parameter"><code>comment</code></em> will be removed above <em class="parameter"><code>group_name</code></em>.
2190 If both <em class="parameter"><code>key</code></em> and <em class="parameter"><code>group_name</code></em> are <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, then <em class="parameter"><code>comment</code></em> will
2191 be removed above the first group in the file.</p>
2192 <div class="variablelist"><table border="0">
2193 <col align="left" valign="top">
2196 <td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
2197 <td> a <a class="link" href="glib-Key-value-file-parser.html#GKeyFile" title="GKeyFile"><span class="type">GKeyFile</span></a>
2201 <td><p><span class="term"><em class="parameter"><code>group_name</code></em> :</span></p></td>
2202 <td> a group name, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>
2206 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
2211 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
2212 <td> return location for a <a class="link" href="glib-Error-Reporting.html#GError" title="GError"><span class="type">GError</span></a>
2216 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2217 <td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS" title="TRUE"><code class="literal">TRUE</code></a> if the comment was removed, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS" title="FALSE"><code class="literal">FALSE</code></a> otherwise
2223 <p class="since">Since 2.6</p>
2226 <div class="refsect2" title="G_KEY_FILE_DESKTOP_GROUP">
2227 <a name="G-KEY-FILE-DESKTOP-GROUP:CAPS"></a><h3>G_KEY_FILE_DESKTOP_GROUP</h3>
2228 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_GROUP "Desktop Entry"
2231 The name of the main group of a desktop entry file, as defined in the
2232 <a class="ulink" href="http://freedesktop.org/Standards/desktop-entry-spec" target="_top">Desktop
2233 Entry Specification</a>. Consult the specification for more
2234 details about the meanings of the keys below.
2236 <p class="since">Since 2.14</p>
2239 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_TYPE">
2240 <a name="G-KEY-FILE-DESKTOP-KEY-TYPE:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_TYPE</h3>
2241 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_TYPE "Type"
2244 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2245 whose value is a string giving the type of the desktop entry. Usually
2246 <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-TYPE-APPLICATION:CAPS" title="G_KEY_FILE_DESKTOP_TYPE_APPLICATION"><code class="literal">G_KEY_FILE_DESKTOP_TYPE_APPLICATION</code></a>,
2247 <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-TYPE-LINK:CAPS" title="G_KEY_FILE_DESKTOP_TYPE_LINK"><code class="literal">G_KEY_FILE_DESKTOP_TYPE_LINK</code></a>, or
2248 <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-TYPE-DIRECTORY:CAPS" title="G_KEY_FILE_DESKTOP_TYPE_DIRECTORY"><code class="literal">G_KEY_FILE_DESKTOP_TYPE_DIRECTORY</code></a>.
2250 <p class="since">Since 2.14</p>
2253 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_VERSION">
2254 <a name="G-KEY-FILE-DESKTOP-KEY-VERSION:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_VERSION</h3>
2255 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_VERSION "Version"
2258 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2259 whose value is a string giving the version of the Desktop
2260 Entry Specification used for the desktop entry file.
2262 <p class="since">Since 2.14</p>
2265 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_NAME">
2266 <a name="G-KEY-FILE-DESKTOP-KEY-NAME:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_NAME</h3>
2267 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_NAME "Name"
2270 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2271 whose value is a localized string giving the specific name of the
2274 <p class="since">Since 2.14</p>
2277 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME">
2278 <a name="G-KEY-FILE-DESKTOP-KEY-GENERIC-NAME:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME</h3>
2279 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME "GenericName"
2282 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2283 whose value is a localized string giving the generic name of the
2286 <p class="since">Since 2.14</p>
2289 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY">
2290 <a name="G-KEY-FILE-DESKTOP-KEY-NO-DISPLAY:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY</h3>
2291 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY "NoDisplay"
2294 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2295 whose value is a boolean stating whether the desktop entry should be
2298 <p class="since">Since 2.14</p>
2301 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_COMMENT">
2302 <a name="G-KEY-FILE-DESKTOP-KEY-COMMENT:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_COMMENT</h3>
2303 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_COMMENT "Comment"
2306 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2307 whose value is a localized string giving the tooltip for the desktop
2310 <p class="since">Since 2.14</p>
2313 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_ICON">
2314 <a name="G-KEY-FILE-DESKTOP-KEY-ICON:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_ICON</h3>
2315 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_ICON "Icon"
2318 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2319 whose value is a localized string giving the name of the icon to be
2320 displayed for the desktop entry.
2322 <p class="since">Since 2.14</p>
2325 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_HIDDEN">
2326 <a name="G-KEY-FILE-DESKTOP-KEY-HIDDEN:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_HIDDEN</h3>
2327 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_HIDDEN "Hidden"
2330 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2331 whose value is a boolean stating whether the desktop entry has been
2332 deleted by the user.
2334 <p class="since">Since 2.14</p>
2337 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN">
2338 <a name="G-KEY-FILE-DESKTOP-KEY-ONLY-SHOW-IN:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN</h3>
2339 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN "OnlyShowIn"
2342 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2343 whose value is a list of strings identifying the environments that
2344 should display the desktop entry.
2346 <p class="since">Since 2.14</p>
2349 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN">
2350 <a name="G-KEY-FILE-DESKTOP-KEY-NOT-SHOW-IN:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN</h3>
2351 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN "NotShowIn"
2354 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2355 whose value is a list of strings identifying the environments that
2356 should not display the desktop entry.
2358 <p class="since">Since 2.14</p>
2361 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_TRY_EXEC">
2362 <a name="G-KEY-FILE-DESKTOP-KEY-TRY-EXEC:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_TRY_EXEC</h3>
2363 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_TRY_EXEC "TryExec"
2366 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2367 whose value is a string giving the file name of a binary on disk
2368 used to determine if the program is actually installed. It is only
2369 valid for desktop entries with the <code class="literal">Application</code>
2372 <p class="since">Since 2.14</p>
2375 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_EXEC">
2376 <a name="G-KEY-FILE-DESKTOP-KEY-EXEC:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_EXEC</h3>
2377 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_EXEC "Exec"
2380 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2381 whose value is a string giving the command line to execute. It is only
2382 valid for desktop entries with the <code class="literal">Application</code>
2385 <p class="since">Since 2.14</p>
2388 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_PATH">
2389 <a name="G-KEY-FILE-DESKTOP-KEY-PATH:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_PATH</h3>
2390 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_PATH "Path"
2393 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2394 whose value is a string containing the working directory to run the
2395 program in. It is only valid for desktop entries with the
2396 <code class="literal">Application</code> type.
2398 <p class="since">Since 2.14</p>
2401 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_TERMINAL">
2402 <a name="G-KEY-FILE-DESKTOP-KEY-TERMINAL:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_TERMINAL</h3>
2403 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_TERMINAL "Terminal"
2406 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2407 whose value is a boolean stating whether the program should be
2408 run in a terminal window. It is only valid for desktop entries with
2409 the <code class="literal">Application</code> type.
2411 <p class="since">Since 2.14</p>
2414 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_MIME_TYPE">
2415 <a name="G-KEY-FILE-DESKTOP-KEY-MIME-TYPE:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_MIME_TYPE</h3>
2416 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_MIME_TYPE "MimeType"
2419 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2420 whose value is a list of strings giving the MIME types supported
2421 by this desktop entry.
2423 <p class="since">Since 2.14</p>
2426 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_CATEGORIES">
2427 <a name="G-KEY-FILE-DESKTOP-KEY-CATEGORIES:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_CATEGORIES</h3>
2428 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_CATEGORIES "Categories"
2431 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2432 whose value is a list of strings giving the categories in which the
2433 desktop entry should be shown in a menu.
2435 <p class="since">Since 2.14</p>
2438 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY">
2439 <a name="G-KEY-FILE-DESKTOP-KEY-STARTUP-NOTIFY:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY</h3>
2440 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY "StartupNotify"
2443 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2444 whose value is a boolean stating whether the application supports
2445 the <a class="ulink" href="http://www.freedesktop.org/Standards/startup-notification-spec" target="_top">Startup
2446 Notification Protocol Specification</a>.
2448 <p class="since">Since 2.14</p>
2451 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS">
2452 <a name="G-KEY-FILE-DESKTOP-KEY-STARTUP-WM-CLASS:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS</h3>
2453 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS "StartupWMClass"
2456 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2457 whose value is string identifying the WM class or name hint of a
2458 window that the application will create, which can be used to emulate
2459 Startup Notification with older applications.
2461 <p class="since">Since 2.14</p>
2464 <div class="refsect2" title="G_KEY_FILE_DESKTOP_KEY_URL">
2465 <a name="G-KEY-FILE-DESKTOP-KEY-URL:CAPS"></a><h3>G_KEY_FILE_DESKTOP_KEY_URL</h3>
2466 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_KEY_URL "URL"
2469 A key under <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-GROUP:CAPS" title="G_KEY_FILE_DESKTOP_GROUP"><code class="literal">G_KEY_FILE_DESKTOP_GROUP</code></a>
2470 whose value is a string giving the URL to access. It is only valid
2471 for desktop entries with the <code class="literal">Link</code> type.
2473 <p class="since">Since 2.14</p>
2476 <div class="refsect2" title="G_KEY_FILE_DESKTOP_TYPE_APPLICATION">
2477 <a name="G-KEY-FILE-DESKTOP-TYPE-APPLICATION:CAPS"></a><h3>G_KEY_FILE_DESKTOP_TYPE_APPLICATION</h3>
2478 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_TYPE_APPLICATION "Application"
2481 The value of the <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-TYPE:CAPS" title="G_KEY_FILE_DESKTOP_KEY_TYPE"><code class="literal">G_KEY_FILE_DESKTOP_KEY_TYPE</code></a>
2482 key for desktop entries representing applications.
2484 <p class="since">Since 2.14</p>
2487 <div class="refsect2" title="G_KEY_FILE_DESKTOP_TYPE_LINK">
2488 <a name="G-KEY-FILE-DESKTOP-TYPE-LINK:CAPS"></a><h3>G_KEY_FILE_DESKTOP_TYPE_LINK</h3>
2489 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_TYPE_LINK "Link"
2492 The value of the <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-TYPE:CAPS" title="G_KEY_FILE_DESKTOP_KEY_TYPE"><code class="literal">G_KEY_FILE_DESKTOP_KEY_TYPE</code></a>
2493 key for desktop entries representing links to documents.
2495 <p class="since">Since 2.14</p>
2498 <div class="refsect2" title="G_KEY_FILE_DESKTOP_TYPE_DIRECTORY">
2499 <a name="G-KEY-FILE-DESKTOP-TYPE-DIRECTORY:CAPS"></a><h3>G_KEY_FILE_DESKTOP_TYPE_DIRECTORY</h3>
2500 <pre class="programlisting">#define G_KEY_FILE_DESKTOP_TYPE_DIRECTORY "Directory"
2503 The value of the <a class="link" href="glib-Key-value-file-parser.html#G-KEY-FILE-DESKTOP-KEY-TYPE:CAPS" title="G_KEY_FILE_DESKTOP_KEY_TYPE"><code class="literal">G_KEY_FILE_DESKTOP_KEY_TYPE</code></a>
2504 key for desktop entries representing directories.
2506 <p class="since">Since 2.14</p>
2510 <div class="footer">
2512 Generated by GTK-Doc V1.13</div>