方法

GLibKeyFileget_comment

自 2.6 开始

声明 [源]

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

描述 [源]

从 group_name 中检索位于 key 之上的注释。如果 key 是 NULL，则从 group_name 之上读取 comment。如果 key 和 group_name 都为 NULL，则从文件中的第一个组之上读取 comment。

注意，返回的字符串不包括 ‘#’ 注释标记，但包括标记之后的任意空白（每一行）。它包括行之间的换行符，但不包括最后的换行符。

自 2.6 开始可用

参数

group_name

类型: const gchar*

组名，或 NULL。

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

类型: const gchar*

一个  key。

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

类型: GError **

用于存储可恢复错误的返回位置。

参数可以是 NULL。
如果返回位置不是 NULL，则必须将其初始化为 NULL GError*。
如果没有错误，方法将保留参数的初始化为 NULL。
出错时，参数将被设置为一个新的 GError；调用者将获取数据的所有权，并负责释放它。

返回值

类型: gchar*

一个应该与 g_free() 一起释放的注释。

方法调用者获取返回数据的所有权，并负责释放它。
该值是一个以NUL结尾的UTF-8字符串。