函数

GLibOptionContextnew

自：2.6

声明 [源码]

GOptionContext*
g_option_context_new (
  const gchar* parameter_string
)

描述 [源码]

创建一个新的选项上下文。

parameter_string 可以用于多个目的。它可以用来添加对“剩余”参数的描述，这些参数不会被 GOptionContext 解析，通常是像“FILES”或“FILE1 FILE2…”这样的东西。如果你使用 G_OPTION_REMAINING 来收集“剩余”参数，GLib 会自动通过使用使用说明汇总中的对应的 GOptionEntry 的 arg_description 来处理这一点。

另一种用法是给出程序功能的简短总结，例如“- frob the strings”，这将显示在用法行的同一行。如果要显示在用法行下方作为段落的长篇描述，请使用 g_option_context_set_summary()。

请注意，parameter_string 是通过 g_option_context_set_translate_func() 设置的函数翻译的，因此通常应该是未翻译的。

自：2.6

此函数对语言绑定不可直接访问。

参数

parameter_string

类型： const gchar*

一个字符串，它显示在 --help 输出的第一行，在用法总结 programname [OPTION...] 之后。

该参数可以是 NULL。
数据归函数调用者所有。
值是一个以 NUL 终止的 UTF-8 字符串。

返回值

类型： GOptionContext

一个新创建的 GOptionContext，在使用后必须使用 g_option_context_free() 释放。

函数调用者获取数据的所有权，并负责释放它。