### Method

# GLib KeyFile get_comment

since: 2.6

#### Declaration

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

#### Description

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.

Available since: 2.6

#### Parameters

`group_name`

  Type: `const gchar*`

  A group name, or `NULL`.

  The argument can be `NULL`.
  The data is owned by the caller of the method.
  The value is a NUL terminated UTF-8 string.

`key`

  Type: `const gchar*`

  A key.

  The argument can be `NULL`.
  The data is owned by the caller of the method.
  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 be 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: `gchar*`

A comment that should be freed with `g_free()`

The caller of the method takes ownership of the data, and is responsible for freeing it.
The value is a NUL terminated UTF-8 string.