方法

GLibKeyFileset_comment

自:2.6

声明 [src]

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

描述 [src]

在从 group_name 来的 key 上方放置一个注释。

如果 keyNULL,则 comment 将被写入在 group_name 上方。如果 keygroup_name 都为 NULL,则将 comment 写在文件中的第一个组上方。

请注意,此函数在每个 comment 的每行前都 prepends 一个 ‘#’ 注释标记。

自可用:2.6

参数

group_name

类型: const gchar*

一个组名,或者 NULL

该参数可以为 NULL
数据由方法调用方拥有。
值是一个以 NUL 结尾的 UTF-8 字符串。
key

类型: const gchar*

一个键。

该参数可以为 NULL
数据由方法调用方拥有。
值是一个以 NUL 结尾的 UTF-8 字符串。
评论

类型: const gchar*

一个评论。

数据由方法调用方拥有。
值是一个以 NUL 结尾的 UTF-8 字符串。
错误

类型: GError **

可恢复错误的返回位置。关于使用gerror的规则

该参数可以为 NULL
如果返回位置不是 NULL,则必须将其初始化为 NULLGError*
如果没有错误,方法将保持该参数初始化为 NULL
发生错误时,参数将被设置为一个新的 GError 分配;调用者将拥有数据,并负责释放它。

返回值

类型: gboolean

如果注释已写,则返回 TRUE,否则返回 FALSE