ArduinoLibs
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Friends | List of all members
ShellArguments Class Reference

Convenience class that encapsulates an array of shell command arguments. More...

#include <Shell.h>

Public Member Functions

int count () const
 Returns the number of arguments, including the name of the command. More...
 
const char * operator[] (int index) const
 Gets a specific argument for the command. More...
 

Friends

class Shell
 

Detailed Description

Convenience class that encapsulates an array of shell command arguments.

See Also
Shell

Definition at line 119 of file Shell.h.

Member Function Documentation

int ShellArguments::count ( ) const
inline

Returns the number of arguments, including the name of the command.

See Also
operator[]

Definition at line 127 of file Shell.h.

const char * ShellArguments::operator[] ( int  index) const

Gets a specific argument for the command.

Parameters
indexThe argument index between 0 and count() - 1.
Returns
The argument, or NULL if index is out of range.

The name of the command is argument 0. The command's remaining arguments are numbered 1 to count() - 1.

See Also
count()

Definition at line 927 of file Shell.cpp.


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