Skip to content

cmd_args_t

概述

命令行处理。

函数

函数名称说明
cmd_args_init初始化。
cmd_args_process处理。
cmd_args_process_str处理。
cmd_args_process_wstr处理。
cmd_args_show_help显示帮助信息。

cmd_args_init 函数

  • 函数功能:

初始化。

  • 函数原型:
cmd_args_t* cmd_args_init (cmd_args_t* args, const char* usage, const cmd_arg_desc_t* desc, uint32_t desc_nr, cmd_arg_on_arg_t on_arg, void* on_arg_ctx);
  • 参数说明:
参数类型说明
返回值cmd_args_t*返回CMD_ARGS对象。
argscmd_args_t*args对象。
usageconst char*帮助信息。
descconst cmd_arg_desc_t*参数描述。
desc_nruint32_t参数描述个数。
on_argcmd_arg_on_arg_t参数处理回调函数。
on_arg_ctxvoid*参数处理回调函数的上下文。

cmd_args_process 函数

  • 函数功能:

处理。

  • 函数原型:
ret_t cmd_args_process (cmd_args_t* args, int argc, char** argv);
  • 参数说明:
参数类型说明
返回值ret_t返回RET_OK表示成功,否则表示失败。
argscmd_args_t*args对象。
argcint参数个数。
argvchar**参数数组。

cmd_args_process_str 函数

  • 函数功能:

处理。

  • 函数原型:
ret_t cmd_args_process_str (cmd_args_t* args, const char* cmd_line);
  • 参数说明:
参数类型说明
返回值ret_t返回RET_OK表示成功,否则表示失败。
argscmd_args_t*args对象。
cmd_lineconst char*字符串格式的参数(适用于Windows)。

cmd_args_process_wstr 函数

  • 函数功能:

处理。

  • 函数原型:
ret_t cmd_args_process_wstr (cmd_args_t* args, int argc, wchar_t** argv);
  • 参数说明:
参数类型说明
返回值ret_t返回RET_OK表示成功,否则表示失败。
argscmd_args_t*args对象。
argcint参数个数。
argvwchar_t**参数数组。

cmd_args_show_help 函数

  • 函数功能:

显示帮助信息。

  • 函数原型:
ret_t cmd_args_show_help (cmd_args_t* args);
  • 参数说明:
参数类型说明
返回值ret_t返回RET_OK表示成功,否则表示失败。
argscmd_args_t*args对象。