KeyFile.setComment

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.

class KeyFile
bool
setComment
(
string groupName
,
string key
,
string comment
)

Parameters

groupName string

a group name, or %NULL

key string

a key

comment string

a comment

Return Value

Type: bool

%TRUE if the comment was written, %FALSE otherwise

Throws

GException on failure.

Meta