GPS Device
Loading...
Searching...
No Matches
CMD_INFO_ts Struct Reference
Command Module » Command Types

Describes a single command exposed by a client. More...

#include <cmd.h>

Public Attributes

const char *const name
const char *const help
const CMD_HANDLER_tf handler

Detailed Description

Describes a single command exposed by a client.

An array of these structures is provided to CMD_CLIENT_INFO_ts to register all commands belonging to a subsystem client.

Definition at line 72 of file cmd.h.

Member Data Documentation

◆ name

const char* const CMD_INFO_ts::name

Null-terminated command name as typed on the console (e.g. "getpushed").

Definition at line 74 of file cmd.h.

◆ help

const char* const CMD_INFO_ts::help

Null-terminated help string displayed by the built-in help command.

Definition at line 77 of file cmd.h.

◆ handler

const CMD_HANDLER_tf CMD_INFO_ts::handler

Pointer to the function that handles this command.

Definition at line 80 of file cmd.h.

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