Menu::command Struct Reference

#include <AP_Menu.h>

Public Member Functions
	FUNCTOR_DECLARE (func, int8_t, uint8_t, const struct arg *)

Public Attributes
const char	command [MENU_COMMAND_MAX]

Detailed Description

menu command description

Definition at line 71 of file AP_Menu.h.

Member Function Documentation

FUNCTOR_DECLARE()

Menu::command::FUNCTOR_DECLARE	(	func	,
		int8_t	,
		uint8_t	,
		const struct arg *
	)

The function to call when the command is received.

The argc argument will be at least 1, and no more than MENU_ARGS_MAX. The argv array will be populated with arguments typed/received up to MENU_ARGS_MAX. The command name will always be in argv[0].

Commands may return -2 to cause the menu itself to exit. The "?", "help" and "exit" commands are always defined, but can be overridden by explicit entries in the command array.

Member Data Documentation

command

const char Menu::command::command[MENU_COMMAND_MAX]

Name of the command, as typed or received. Command names are limited in size to keep this structure compact.

Definition at line 75 of file AP_Menu.h.

---

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

• libraries/AP_Menu/AP_Menu.h