方法

GLibOptionContextget_help

自 2.14 开始

声明 [src]

gchar*
g_option_context_get_help (
  GOptionContext* context,
  gboolean main_help,
  GOptionGroup* group
)

描述 [src]

返回给定上下文的格式化、已翻译的帮助文本。要获取由 --help 生成的文本，请调用 g_option_context_get_help (context, TRUE, NULL)。要获取由 --help-all 生成的文本，请调用 g_option_context_get_help (context, FALSE, NULL)。要获取选项组的帮助文本，请调用 g_option_context_get_help (context, FALSE, group)。

自 2.14 开始可用

参数

main_help

类型: gboolean

如果 TRUE，仅包含主组。

group

类型: GOptionGroup

为创建帮助文本的 GOptionGroup，或 NULL。

此参数可以是 NULL。

数据由方法调用者拥有。

返回值

类型: gchar*

包含帮助文本的新分配的字符串。

方法调用者将拥有返回的数据，并负责释放它。

此值是空终止的 UTF-8 字符串。