esp_console_get_hint() function

Callback which provides command hints for linenoise library When using linenoise for line editing, hints support can be enabled as follows: linenoiseSetHintsCallback((linenoiseHintsCallback*) &esp_console_get_hint); The extra cast is needed because linenoiseHintsCallback is defined as returning a char* instead of const char*.

Syntax

Show:

Summary

Declaration

Definition

from esp_console.h:318

const char *esp_console_get_hint(const char *buf, int *color, int *bold);

Implemented in commands.c:204

Arguments

Argument

Declared as

Description

buf

const char *

line typed by the user

color

int *

ANSI color code to be used when displaying the hint

bold

int *

set to 1 if hint has to be displayed in bold

Return value

string containing the hint text. This string is persistent and should not be freed (i.e. linenoiseSetFreeHintsCallback should not be used).

Examples

esp_console_get_hint() is referenced by 1 libraries and example projects:

References

from examples

esp_console_get_hint() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle