esp_console_run() function

Run command line

Syntax

Show:

Summary

Declaration

Definition

from esp_console.h:260

esp_err_t esp_console_run(const char *cmdline, int *cmd_ret);

Implemented in commands.c:234

Arguments

Argument

Description

cmdline

command line (command name followed by a number of arguments)

cmd_ret

return code from the command (set if command was run)

Return value

- ESP_OK, if command was run - ESP_ERR_INVALID_ARG, if the command line is empty, or only contained whitespace - ESP_ERR_NOT_FOUND, if command with given name wasn't registered - ESP_ERR_INVALID_STATE, if esp_console_init wasn't called

Examples

esp_console_run() is referenced by 2 libraries and example projects:

References

from examples

esp_console_run() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle