FreeNOS
Public Member Functions
ExitCommand Class Reference
bin » sh

Exit the Shell. More...

#include <ExitCommand.h>

Inheritance diagram for ExitCommand:
ShellCommand

Public Member Functions

 ExitCommand ()
 Constructor function. More...
 
virtual int execute (const Size nparams, const char **params)
 Executes the command. More...
 
- Public Member Functions inherited from ShellCommand
 ShellCommand (const char *name, const Size minParams=0)
 Constructor. More...
 
virtual ~ShellCommand ()
 Destructor. More...
 
const char * getName () const
 Get command name. More...
 
const char * getHelp () const
 Get command help. More...
 
Size getMinimumParams () const
 Get the minimum number of parameters required. More...
 

Additional Inherited Members

- Protected Attributes inherited from ShellCommand
const char * m_name
 Unique name of the command. More...
 
const char * m_help
 Command help text. More...
 
const Size m_minParams
 Minimum number of parameters required. More...
 

Detailed Description

Exit the Shell.

Definition at line 35 of file ExitCommand.h.

Constructor & Destructor Documentation

◆ ExitCommand()

ExitCommand::ExitCommand ( )

Constructor function.

Definition at line 26 of file ExitCommand.cpp.

References ShellCommand::m_help.

Member Function Documentation

◆ execute()

int ExitCommand::execute ( const Size  nparams,
const char **  params 
)
virtual

Executes the command.

Parameters
nparamsNumber of parameters given.
paramsArray of parameters.
Returns
Error code or zero on success.

Implements ShellCommand.

Definition at line 33 of file ExitCommand.cpp.

References exit(), and EXIT_SUCCESS.


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