OptDef Struct Reference

A structure that is used by the user to define a single option. An array of these option structs is passed to GetOpt() for command line parsing. More...

#include <optarg.h>

Data Fields
const char *	short_name_str
	The short multi-character short name of the option (short opt).
const char *	long_name_str
	The multiple-character long name of the option (long opt).
int	num_args
	The number of expected arguments for the option.
const char *	argument_str
	A string that describes the arguments to the option.
const CdiEnumStringKey *	arg_choices_array_ptr
	Pointer to array of strings of option argument choices.
const char *	description_str
	A string that describes the function of the option. Max length is OPTARG_MAX_DESCRIPTION_STRING_LEN.

Detailed Description

A structure that is used by the user to define a single option. An array of these option structs is passed to GetOpt() for command line parsing.

---

The documentation for this struct was generated from the following file:

• src/test/optarg.h