arg_opts_s Struct Reference

This structure represents a possible argument to an application. More...

#include <args.h>

Data Fields
char	short_arg
	The short form of the argument without the leading dash e.g.
const char *	long_arg
	The long form of the argument without the leading double-dash e.g.
const char *	description
	A description of the argument used when generating application help text.
int	required
	If non-zero (ARG_REQUIRED), this argument is mandatory.
int	has_value
	If non-zero (ARG_HAS_VALUE), this argument is followed by a value to be captured and associated with it.
const char *	default_value
	If an argument is optional but not provided, and this is non-NULL, then it is used as that argument's value.

Detailed Description

This structure represents a possible argument to an application.

Field Documentation

long_arg

const char* arg_opts_s::long_arg

The long form of the argument without the leading double-dash e.g.

–help

short_arg

char arg_opts_s::short_arg

The short form of the argument without the leading dash e.g.

-x, -h

---

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

• main/public/include/args.h