1.2.3.4.2 SYS_CMD_ADDGRP Function

C

bool SYS_CMD_ADDGRP(const SYS_CMD_DESCRIPTOR* pCmdTbl, int nCmds,
    const char* groupName,
    const char* menuStr)

Summary

Allows clients to add command process to the Command Processor System Service.

Description

Client modules may call this function to add command process to the Command Processor System Service.

Precondition

SYS_CMD_Initialize was successfully run once.

Parameters

None.

Example

static const SYS_CMD_DESCRIPTOR cmdTbl= { {"command_as_typed_at_the_prompt", _Function_Name_That_Supports_The_Command, ": Helpful description of the command for the user"}, };

bool APP_AddCommandFunction() { if (!SYS_CMD_ADDGRP(cmdTbl, sizeof(cmdTbl)/sizeof(*cmdTbl), "Command Group Name", ": Command Group Description")) { return false; } return true; }

Returns

true - Indicates success

false - Indicates an error occurred

Remarks

None.