iPXE
Data Fields
command_descriptor Struct Reference

A command descriptor. More...

#include <parseopt.h>

Data Fields

struct option_descriptoroptions
 Option descriptors. More...
 
uint8_t num_options
 Number of option descriptors. More...
 
uint8_t len
 Length of option structure. More...
 
uint8_t min_args
 Minimum number of non-option arguments. More...
 
uint8_t max_args
 Maximum number of non-option arguments. More...
 
const char * usage
 Command usage. More...
 

Detailed Description

A command descriptor.

Definition at line 76 of file parseopt.h.

Field Documentation

◆ options

struct option_descriptor* command_descriptor::options

Option descriptors.

Definition at line 78 of file parseopt.h.

◆ num_options

uint8_t command_descriptor::num_options

Number of option descriptors.

Definition at line 80 of file parseopt.h.

◆ len

uint8_t command_descriptor::len

Length of option structure.

Definition at line 82 of file parseopt.h.

◆ min_args

uint8_t command_descriptor::min_args

Minimum number of non-option arguments.

Definition at line 84 of file parseopt.h.

◆ max_args

uint8_t command_descriptor::max_args

Maximum number of non-option arguments.

Definition at line 86 of file parseopt.h.

◆ usage

const char* command_descriptor::usage

Command usage.

This excludes the literal "Usage:" and the command name, which will be prepended automatically.

Definition at line 92 of file parseopt.h.


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