Method

GLibKeyFileremove_group

since: 2.6

Declaration

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

Description

Removes the specified group, group_name, from the key file.

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.

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

TRUE if the group was removed, FALSE otherwise.