C interface to command line options parsing class. More...
#include "name.h"
Include dependency graph for opt.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Classes | |
| struct | ptpmgmt_opt_option |
| struct | ptpmgmt_opt_t |
Typedefs | |
| typedef struct ptpmgmt_opt_t * | ptpmgmt_opt |
| typedef const struct ptpmgmt_opt_t * | const_ptpmgmt_opt |
Enumerations | |
| enum | ptpmgmt_opt_loop_val { PTPMGMT_OPT_ERR , PTPMGMT_OPT_MSG , PTPMGMT_OPT_HELP , PTPMGMT_OPT_DONE } |
Functions | |
| ptpmgmt_opt | ptpmgmt_opt_alloc () |
| ptpmgmt_opt | ptpmgmt_opt_alloc_empty () |
Detailed Description
C interface to command line options parsing class.
- Copyright
- © 2023 Erez Geva
Typedef Documentation
◆ const_ptpmgmt_opt
| typedef const struct ptpmgmt_opt_t* const_ptpmgmt_opt |
pointer to constant ptpmgmt options structure
◆ ptpmgmt_opt
| typedef struct ptpmgmt_opt_t* ptpmgmt_opt |
pointer to ptpmgmt options structure
Enumeration Type Documentation
◆ ptpmgmt_opt_loop_val
| enum ptpmgmt_opt_loop_val |
Parsing return code. Identical to Options::loop_val
| Enumerator | |
|---|---|
| PTPMGMT_OPT_ERR | Parsing error |
| PTPMGMT_OPT_MSG | Pass a message from parsing like a version string |
| PTPMGMT_OPT_HELP | Need to print help |
| PTPMGMT_OPT_DONE | parsing success |
Function Documentation
◆ ptpmgmt_opt_alloc()
| ptpmgmt_opt ptpmgmt_opt_alloc | ( | ) |
Allocate new options object
- Returns
- new options object or null on error
◆ ptpmgmt_opt_alloc_empty()
| ptpmgmt_opt ptpmgmt_opt_alloc_empty | ( | ) |
Allocate new options object without the PMC default options
- Returns
- new options object or null on error
