| Table of Contents |
|---|
This section provides a reference to the µC/Shell API. Each of the user-accessible services is presented in alphabetical order. The following information is provided for each of those services:
- A brief description
- The function prototype
- The filename of the source code
- A description of the arguments passed to the function
- A description of the returned value(s)
- Specific notes and warnings on using the service
- A usage example
Shell_CmdTblAdd()
| File | Called from |
shell.c | Application |
Allocates and initializes a module command, and inserts a command table into it.
...
Example
Shell_CmdTblRem ()
| File | Called from |
shell.c | Application |
Removes a command table from the shell.
...
Returned Values
None.
Notes/Warnings
None.
Example
Shell_Exec ()
| File | Called from |
shell.c | Application |
Parses and executes the command passed in parameter.
Arguments
in
Pointer to a CPU_CHAR string holding a complete command and its argument(s).
...
The command may generate some output that should be transmitted to some device (socket, RS-232 link, ...). The caller of this function is hence responsible for the implementation of such function, if output is desired.
Example
Shell_Init()
| File | Called from |
shell.c | Application |
Initializes the shell.
...
The Shell_Init() function must be called before the other Shell function are invoked. Shell_Init() must also only be called once from product's application.