Method

GLibKeyFileget_boolean

since: 2.6

Declaration

gboolean
g_key_file_get_boolean (
  GKeyFile* key_file,
  const gchar* group_name,
  const gchar* key,
  GError** error
)

Description

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.

Available since: 2.6

Parameters

group_name

Type: const gchar*

A group name.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
key

Type: const gchar*

A key.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will left initialized to NULL by the method if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gboolean

The value associated with the key as a boolean, or FALSE if the key was not found or could not be parsed.