Esa_Odb_Command_Register()
Abstract
Adds a command to ODB.
Syntax
Esa_Odb_Command_Register (esa_state_ptr, command_name, usage, category, short_desc, long_desc, callback, state_ptr)
| Argument | Type | Description |
|---|---|---|
esa_state_ptr |
EsaT_State_Handle |
ESA state information generated by Esa_Init() |
command_name |
const char * |
name of the command |
usage |
const char * |
command name and argument list |
category |
const char * |
used to group related commands (for example: event, trace) |
short_desc |
const char * |
short explanation of the command (for the help category) |
long_desc |
const char * |
detailed explanation of the command (for the help command) |
callback |
EsaT_Odb_Command_Callback_Proc |
routine invoked when the new command is entered in ODB |
state_ptr |
void * |
user-defined information passed to the callback routine |
Return Type
EsaT_Compcode
EsaC_Comp_Success if the command can be registered; EsaC_Comp_Failure otherwise.
Header
esa.h
Details
This function can be used to add custom commands to ODB; for example, to display information about a cosimulation.
The callback function prototype is described in EsaT_Odb_Command_Callback_Proc