Method

GLibKeyFileget_keys

since: 2.6

Declaration

gchar**
g_key_file_get_keys (
  GKeyFile* key_file,
  const gchar* group_name,
  gsize* length,
  GError** error
)

Description

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.

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.

length

Type: gsize*

Return location for the number of keys returned, or NULL.

The argument will be set by the function.

The argument can be NULL.

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: An array of utf8

A newly-allocated NULL-terminated array of strings. Use g_strfreev() to free it.

The array is NULL-terminated.

The caller of the method takes ownership of the data, and is responsible for freeing it.

Each element is a NUL terminated UTF-8 string.