SourceVu will show references to esp_console_cmd_t from the following samples and libraries:
Symbols ![]()
loading...
Files ![]()
loading...
esp_console_cmd_t struct
Console command description
Syntax
typedef struct
{
const char *command;
const char *help;
const char *hint;
esp_console_cmd_func_t func;
void *argtable;
esp_console_cmd_func_with_context_t func_w_context;
void *context;
} esp_console_cmd_t;
Fields
Field
Declared as
Description
const char *
Command name. Must not be NULL, must not contain spaces. The pointer must be valid until the call to esp_console_deinit.
const char *
Help text for the command, shown by help command. If set, the pointer must be valid until the call to esp_console_deinit. If not set, the command will not be listed in 'help' output.
const char *
Hint text, usually lists possible arguments. If set to NULL, and 'argtable' field is non-NULL, hint will be generated automatically.
Pointer to a function which implements the command. @note: Setting both \c func and \c func_w_context is not allowed.
void *
Array or structure of pointers to arg_xxx structures, may be NULL. Used to generate hint text if 'hint' is set to NULL. Array/structure which this field points to must end with an arg_end. Only used for the duration of esp_console_cmd_register call.
Pointer to a context aware function which implements the command. @note: Setting both \c func and \c func_w_context is not allowed.
void *
Context pointer to user-defined per-command context data. This is used if context aware function \c func_w_context is set.