Embedded TCP/IP stack: fnet_shell_command Struct Reference

FNET

fnet_shell_command Struct Reference

Shell command control structure. More...

Data Fields

const fnet_char_tname
 Command name (null-terminated string). More...
 
fnet_index_t min_args
 Minimum number of arguments the command accepts. More...
 
fnet_index_t max_args
 Maximum number of arguments the command accepts. More...
 
fnet_shell_cmd_function_t cmd_ptr
 Pointer to the actual command function defined by the fnet_shell_cmd_function_t type. More...
 
fnet_char_tdescription
 Brief description of the command (null-terminated string).
This field is used by the fnet_shell_help() function.
. More...
 
fnet_char_tsyntax
 Syntax of the command (null-terminated string).
This field is used by the fnet_shell_help() function. The standard command line syntax information which will be helpful to describe the possible command line parameters in a help display is: More...
 

Detailed Description

Shell command control structure.

This structure is used to define properties of a command that will be supported by the shell.
An application should define the command table and pass it to the fnet_shell structure.
The last table element must have all fields set to zero as the end-of-table mark. The good example of fnet_shell_command usage is in the FNET Shell application.

See also
fnet_shell

Definition at line 189 of file fnet_shell.h.


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

© 2005-2018 by Andrey Butok. http://fnet.sourceforge.net