Method

GLibKeyFileremove_comment

Declaration

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

Description

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.

Available since:

2.6

Parameters

`group_name`	`const gchar*`
	A group name, or `NULL`.
	The argument can be `NULL`.
	The data is owned by the caller of the function.
	The string is a NUL terminated UTF-8 string.
`key`	`const gchar*`
	A key.
	The argument can be `NULL`.
	The data is owned by the caller of the function.
	The string is a NUL terminated UTF-8 string.
`error`	`GError **`
	The return location for a `GError*`, or `NULL`.

Return value

Returns:	`gboolean`
	`TRUE` if the comment was removed, `FALSE` otherwise.