Method
GLibKeyFileset_comment
Declaration
gboolean
g_key_file_set_comment (
GKeyFile* key_file,
const gchar* group_name,
const gchar* key,
const gchar* comment,
GError** error
)
Description
Places a comment above key
from group_name
.
If key
is NULL
then comment
will be written above group_name
.
If both key
and group_name
are NULL
, then comment
will be
written above the first group in the file.
Note that this function prepends a ‘#’ comment marker to
each line of comment
.
Available since: | 2.6 |
Parameters
group_name |
const gchar* |
A group name, or |
|
The argument can be NULL . | |
The data is owned by the caller of the function. | |
The value 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 value is a NUL terminated UTF-8 string. | |
comment |
const gchar* |
A comment. |
|
The data is owned by the caller of the function. | |
The value is a NUL terminated UTF-8 string. | |
error |
GError ** |
The return location for a GError* , or NULL . |