|
LIBCOM_API void epicsStdCall | iocshRegister (const iocshFuncDef *piocshFuncDef, iocshCallFunc func) |
| This function is used to register a command with the IOC shell. More...
|
|
LIBCOM_API void epicsStdCall | iocshRegisterVariable (const iocshVarDef *piocshVarDef) |
|
LIBCOM_API const iocshCmdDef
*epicsStdCall | iocshFindCommand (const char *name) EPICS_DEPRECATED |
| Returns a struct of type iocshCmdDef whose element values are determined by the name parameter. This function calls the function registryFind, defined in Registry.h. More...
|
|
LIBCOM_API const iocshVarDef
*epicsStdCall | iocshFindVariable (const char *name) |
| Returns a struct of type iocshVarDef whose element values are determined by the name parameter. This function calls the function registryFind, defined in Registry.h. More...
|
|
LIBCOM_API void epicsStdCall | iocshFree (void) |
| Frees all memory allocated to registered commands and variables. More...
|
|
LIBCOM_API int epicsStdCall | iocsh (const char *pathname) |
| This function is used to execute IOC shell commands from a file. More...
|
|
LIBCOM_API int epicsStdCall | iocshCmd (const char *cmd) |
| This function is used to exectute a single IOC shell command. More...
|
|
LIBCOM_API int epicsStdCall | iocshLoad (const char *pathname, const char *macros) |
| Read and evaluate IOC shell commands from the given file. A list of macros can be supplied as a parameter. These macros are treated as environment variables during exectution of the file's commands. More...
|
|
LIBCOM_API int epicsStdCall | iocshRun (const char *cmd, const char *macros) |
| Evaluate a single IOC shell command. A list of macros can be supplied as a parameter. These macros are treated as environment variables during exectution of the command. More...
|
|
LIBCOM_API int | iocshSetError (int err) |
| Signal error from an IOC shell function. More...
|
|
LIBCOM_API void epicsStdCall | iocshEnvClear (const char *name) |
| Unsets macro values. More...
|
|
The iocsh API provides an interface for running commands in the shell of the IOC, as well as registering commands and variables for use in the shell. It consists of 4 functions for the former and 2 functions for the latter.
- Command functions:
- int iocsh (const char *pathname)
int iocshLoad (const char *pathname, const char *macros)
int iocshCmd (const char *cmd)
int iocshRun (const char *cmd, const char *macros)
- Registration functions:
- void iocshRegister (const iocshFuncDef * piocshFuncDef, iocshCallFunc func)
void epicsStdCall iocshRegisterVariable (const iocshVarDef *piocshVarDef)
Definition in file iocsh.h.