Returns the value associated with key under group_name as a
boolean.
If key cannot be found then %FALSE is returned and error is set
to %G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value
associated with key cannot be interpreted as a boolean then %FALSE
is returned and error is set to %G_KEY_FILE_ERROR_INVALID_VALUE.
a group name
a key
Returns the values associated with key under group_name as
booleans.
If key cannot be found then %NULL is returned and error is set to
%G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
with key cannot be interpreted as booleans then %NULL is returned
and error is set to %G_KEY_FILE_ERROR_INVALID_VALUE.
a group name
a key
Retrieves a comment above key from group_name.
If key is %NULL then comment will be read from above
group_name. If both key and group_name are %NULL, then
comment will be read from above the first group in the file.
Note that the returned string does not include the '#' comment markers, but does include any whitespace after them (on each line). It includes the line breaks between lines, but does not include the final line break.
a group name, or %NULL
a key
Returns the value associated with key under group_name as a
double. If group_name is %NULL, the start_group is used.
If key cannot be found then 0.0 is returned and error is set to
%G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
with key cannot be interpreted as a double then 0.0 is returned
and error is set to %G_KEY_FILE_ERROR_INVALID_VALUE.
a group name
a key
Returns the values associated with key under group_name as
doubles.
If key cannot be found then %NULL is returned and error is set to
%G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
with key cannot be interpreted as doubles then %NULL is returned
and error is set to %G_KEY_FILE_ERROR_INVALID_VALUE.
a group name
a key
Returns all groups in the key file loaded with key_file.
The array of returned groups will be %NULL-terminated, so
length may optionally be %NULL.
Returns the value associated with key under group_name as a signed
64-bit integer. This is similar to g_key_file_get_integer() but can return
64-bit results without truncation.
a non-%NULL group name
a non-%NULL key
Returns the value associated with key under group_name as an
integer.
If key cannot be found then 0 is returned and error is set to
%G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
with key cannot be interpreted as an integer, or is out of range
for a #gint, then 0 is returned
and error is set to %G_KEY_FILE_ERROR_INVALID_VALUE.
a group name
a key
Returns the values associated with key under group_name as
integers.
If key cannot be found then %NULL is returned and error is set to
%G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
with key cannot be interpreted as integers, or are out of range for
#gint, then %NULL is returned
and error is set to %G_KEY_FILE_ERROR_INVALID_VALUE.
a group name
a key
Returns all keys for the group name group_name. The array of
returned keys will be %NULL-terminated, so length may
optionally be %NULL. In the event that the group_name cannot
be found, %NULL is returned and error is set to
%G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
a group name
Returns the actual locale which the result of g_key_file_get_locale_string() or g_key_file_get_locale_string_list() came from.
If calling g_key_file_get_locale_string() or
g_key_file_get_locale_string_list() with exactly the same key_file,
group_name, key and locale, the result of those functions will
have originally been tagged with the locale that is the result of
this function.
a group name
a key
a locale identifier or %NULL
Returns the value associated with key under group_name
translated in the given locale if available. If locale is
%NULL then the current locale is assumed.
If locale is to be non-%NULL, or if the current locale will change over
the lifetime of the #GKeyFile, it must be loaded with
%G_KEY_FILE_KEEP_TRANSLATIONS in order to load strings for all locales.
If key cannot be found then %NULL is returned and error is set
to %G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the value associated
with key cannot be interpreted or no suitable translation can
be found then the untranslated value is returned.
a group name
a key
a locale identifier or %NULL
Returns the values associated with key under group_name
translated in the given locale if available. If locale is
%NULL then the current locale is assumed.
If locale is to be non-%NULL, or if the current locale will change over
the lifetime of the #GKeyFile, it must be loaded with
%G_KEY_FILE_KEEP_TRANSLATIONS in order to load strings for all locales.
If key cannot be found then %NULL is returned and error is set
to %G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated
with key cannot be interpreted or no suitable translations
can be found then the untranslated values are returned. The
returned array is %NULL-terminated, so length may optionally
be %NULL.
a group name
a key
a locale identifier or %NULL
Returns the name of the start group of the file.
Returns the string value associated with key under group_name.
Unlike g_key_file_get_value(), this function handles escape sequences
like \s.
In the event the key cannot be found, %NULL is returned and
error is set to %G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
event that the group_name cannot be found, %NULL is returned
and error is set to %G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
a group name
a key
Returns the values associated with key under group_name.
In the event the key cannot be found, %NULL is returned and
error is set to %G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
event that the group_name cannot be found, %NULL is returned
and error is set to %G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
a group name
a key
Returns the value associated with key under group_name as an unsigned
64-bit integer. This is similar to g_key_file_get_integer() but can return
large positive results without truncation.
a non-%NULL group name
a non-%NULL key
Returns the raw value associated with key under group_name.
Use g_key_file_get_string() to retrieve an unescaped UTF-8 string.
In the event the key cannot be found, %NULL is returned and
error is set to %G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
event that the group_name cannot be found, %NULL is returned
and error is set to %G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
a group name
a key
Looks whether the key file has the group group_name.
a group name
Loads a key file from the data in bytes into an empty #GKeyFile structure.
If the object cannot be created then %error is set to a #GKeyFileError.
a #GBytes
flags from #GKeyFileFlags
Loads a key file from memory into an empty #GKeyFile structure. If the object cannot be created then %error is set to a #GKeyFileError.
key file loaded in memory
the length of data in bytes (or (gsize)-1 if data is nul-terminated)
flags from #GKeyFileFlags
This function looks for a key file named file in the paths
returned from g_get_user_data_dir() and g_get_system_data_dirs(),
loads the file into key_file and returns the file's full path in
full_path. If the file could not be loaded then an %error is
set to either a #GFileError or #GKeyFileError.
a relative path to a filename to open and parse
flags from #GKeyFileFlags
This function looks for a key file named file in the paths
specified in search_dirs, loads the file into key_file and
returns the file's full path in full_path.
If the file could not be found in any of the search_dirs,
%G_KEY_FILE_ERROR_NOT_FOUND is returned. If
the file is found but the OS returns an error when opening or reading the
file, a %G_FILE_ERROR is returned. If there is a problem parsing the file, a
%G_KEY_FILE_ERROR is returned.
a relative path to a filename to open and parse
%NULL-terminated array of directories to search
flags from #GKeyFileFlags
Loads a key file into an empty #GKeyFile structure.
If the OS returns an error when opening or reading the file, a %G_FILE_ERROR is returned. If there is a problem parsing the file, a %G_KEY_FILE_ERROR is returned.
This function will never return a %G_KEY_FILE_ERROR_NOT_FOUND error. If the
file is not found, %G_FILE_ERROR_NOENT is returned.
the path of a filename to load, in the GLib filename encoding
flags from #GKeyFileFlags
Removes a comment above key from group_name.
If key is %NULL then comment will be removed above group_name.
If both key and group_name are %NULL, then comment will
be removed above the first group in the file.
a group name, or %NULL
a key
Removes the specified group, group_name,
from the key file.
a group name
Removes key in group_name from the key file.
a group name
a key name to remove
Writes the contents of key_file to filename using
g_file_set_contents(). If you need stricter guarantees about durability of
the written file than are provided by g_file_set_contents(), use
g_file_set_contents_full() with the return value of g_key_file_to_data().
This function can fail for any of the reasons that g_file_set_contents() may fail.
the name of the file to write to
Associates a new boolean value with key under group_name.
If key cannot be found then it is created.
a group name
a key
%TRUE or %FALSE
Associates a list of boolean values with key under group_name.
If key cannot be found then it is created.
If group_name is %NULL, the start_group is used.
a group name
a key
an array of boolean values
Places a comment above key from group_name.
If key is %NULL then comment will be written above group_name.
If both key and group_name are %NULL, then comment will be
written above the first group in the file.
Note that this function prepends a '#' comment marker to
each line of comment.
a group name, or %NULL
a key
a comment
Associates a new double value with key under group_name.
If key cannot be found then it is created.
a group name
a key
a double value
Associates a list of double values with key under
group_name. If key cannot be found then it is created.
a group name
a key
an array of double values
Associates a new integer value with key under group_name.
If key cannot be found then it is created.
a group name
a key
an integer value
Associates a new integer value with key under group_name.
If key cannot be found then it is created.
a group name
a key
an integer value
Associates a list of integer values with key under group_name.
If key cannot be found then it is created.
a group name
a key
an array of integer values
Sets the character which is used to separate values in lists. Typically ';' or ',' are used as separators. The default list separator is ';'.
the separator
Associates a string value for key and locale under group_name.
If the translation for key cannot be found then it is created.
a group name
a key
a locale identifier
a string
Associates a list of string values for key and locale under
group_name. If the translation for key cannot be found then
it is created.
a group name
a key
a locale identifier
a %NULL-terminated array of locale string values
Associates a new string value with key under group_name.
If key cannot be found then it is created.
If group_name cannot be found then it is created.
Unlike g_key_file_set_value(), this function handles characters
that need escaping, such as newlines.
a group name
a key
a string
Associates a list of string values for key under group_name.
If key cannot be found then it is created.
If group_name cannot be found then it is created.
a group name
a key
an array of string values
Associates a new integer value with key under group_name.
If key cannot be found then it is created.
a group name
a key
an integer value
Associates a new value with key under group_name.
If key cannot be found then it is created. If group_name cannot
be found then it is created. To set an UTF-8 string which may contain
characters that need escaping (such as newlines or spaces), use
g_key_file_set_string().
a group name
a key
a string
This function outputs key_file as a string.
Note that this function never reports an error,
so it is safe to pass %NULL as error.
Decreases the reference count of key_file by 1. If the reference count
reaches zero, frees the key file and all its allocated memory.
The GKeyFile struct contains only private data and should not be accessed directly.