BEEP-8 Helper Lib 1.0.0
Loading...
Searching...
No Matches
CShellCmd Class Referenceabstract
Inheritance diagram for CShellCmd:
CClearShellCmd CHelpShellCmd

Public Member Functions

int Main (const std::vector< str16 > &tokens)
 Executes the command with the provided tokens.
 
 CShellCmd (const char *name_)
 Constructor for CShellCmd.
 

Protected Member Functions

bool ShowHelp (const std::vector< str16 > &tokens, const char *help)
 Displays help information for the command.
 

Protected Attributes

CShellObj_pShellObj = nullptr
 

Friends

class CShellObj
 

Constructor & Destructor Documentation

◆ CShellCmd()

CShellCmd::CShellCmd ( const char * name_)

Constructor for CShellCmd.

Parameters
name_The name of the command.

Member Function Documentation

◆ Main()

int CShellCmd::Main ( const std::vector< str16 > & tokens)
inline

Executes the command with the provided tokens.

Parameters
tokensThe command line arguments passed to the command.
Returns
The return value indicates the success or failure of the command.

◆ ShowHelp()

bool CShellCmd::ShowHelp ( const std::vector< str16 > & tokens,
const char * help )
protected

Displays help information for the command.

Parameters
tokensThe command line arguments passed to the command.
helpThe help message to display.
Returns
Returns true if help was displayed, false otherwise.

The documentation for this class was generated from the following files: