picofuse

Data Fields
sys_env_arg_flag_t Struct Reference

Describes a single command-line argument flag. More...

#include <picofuse/sys.h>

Data Fields

const char * long_name
 Name of the argument flag.
 
const char * short_name
 Short name or single-character alias for the argument flag. More...
 
sys_env_arg_type_t type
 Expected value type for the argument flag.
 
const char * value
 Default value, or the matched value after a successful parse. More...
 

Detailed Description

Describes a single command-line argument flag.

On input to sys_env_arg_parse(), long_name/short_name/type describe the flag to look for, and value holds its default. On return, value holds the matched argument's value if the flag was present on the command line, or is left untouched at its default otherwise.

Definition at line 96 of file env.h.

Field Documentation

◆ short_name

const char* sys_env_arg_flag_t::short_name

Short name or single-character alias for the argument flag.

Definition at line 98 of file env.h.

◆ value

const char* sys_env_arg_flag_t::value

Default value, or the matched value after a successful parse.

Definition at line 101 of file env.h.


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