A shell command is simply a program written in the Robox X/script language, whose functions are called directly by RDE3 when it needs to be executed within a command shell. The main operations involved are:
•Documentation of the command.
Command Execution.
The concerned function that deals with the execution of the command is called execute and must be mandatorily implemented in the command.
Syntax |
execute(cmdline @cl): bool |
|---|---|
cmdLine |
Reference to shell command line information |
Execute |
Returns logical outcome |
The function should return TRUE if and only if the command was processed and executed correctly.
Note: If the function returns FALSE, the shell will automatically cancel the execution of any commands queued to it.
Example usage
code execute(cmdline @cl): BOOL ; TODO: code to execute the command return true end |
Command documentation
The function involved that deals with the execution of the command is called help and its implementation is optional.
Syntax |
help(): bool |
|---|---|
Outcome |
Returns logical outcome |
The function usually invokes the appropriate documentation via the appropriately parameterized invokeHelp() function.
Note: If the function returns FALSE, the shell will automatically cancel the execution of any commands queued to it.
Example usage
code help(): bool ; TODO: code to request help, such as print() or invokeHelp() return true end |
