Description

Structure to hold the information for each console command.

Data Fields
const char *	name
	Command name matched at the command line.

command_function_t	command
	Function that runs the command.

int	arg_count
	Minimum number of arguments.

const char *	delimit
	Custom string of characters that may delimit the arguments for this command - NULL value will use the default for the console.

help_example_function_t	help_example
	Command-specific help function. More...

const char *	format
	String describing the argument format used by the generic help generator function.

const char *	brief
	Brief description of the command used by the generic help generator function.

Field Documentation

help_example_function_t cy_command_console_cmd_t::help_example

Command-specific help function.

Generally set to NULL.