iPXE
Data Fields
option_descriptor Struct Reference

A command-line option descriptor. More...

#include <parseopt.h>

Data Fields

const char * longopt
 Long option name, if any.
char shortopt
 Short option name.
uint8_t has_arg
 Argument requirement (as for struct option)
uint16_t offset
 Offset of field within options structure.
int(* parse )(char *text, void *value)
 Parse option.

Detailed Description

A command-line option descriptor.

Definition at line 22 of file parseopt.h.


Field Documentation

Long option name, if any.

Definition at line 24 of file parseopt.h.

Referenced by print_usage().

Short option name.

Definition at line 26 of file parseopt.h.

Referenced by print_usage().

Argument requirement (as for struct option)

Definition at line 28 of file parseopt.h.

Referenced by print_usage().

Offset of field within options structure.

Definition at line 30 of file parseopt.h.

int( * option_descriptor::parse)(char *text, void *value)

Parse option.

Parameters:
textOption text
valueOption value to fill in
Return values:
rcReturn status code

Definition at line 37 of file parseopt.h.


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