Method
GLibKeyFileset_comment
since: 2.6
Declaration [src]
gboolean
g_key_file_set_comment (
GKeyFile* key_file,
const gchar* group_name,
const gchar* key,
const gchar* comment,
GError** error
)
Description [src]
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.
Passing a non-existent group_name or key to this function returns
false and populates error. (In contrast, passing a non-existent
group_name or key to g_key_file_set_string()
creates the associated group name and key.)
Note that this function prepends a # comment marker to
each line of comment.
Available since: 2.6
Parameters
group_name-
Type:
const gchar*A group name, or
NULLto write a top-level comment.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, or
NULLto write a group comment.The argument can be NULL.The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string. comment-
Type:
const gchar*A comment.
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 aNULLGError*.The argument will be left initialized to NULLby 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.