Esa_Odb_Command_Register()
摘要
向 ODB 添加一条命令。
语法
Esa_Odb_Command_Register (esa_state_ptr, command_name, usage, category, short_desc, long_desc, callback, state_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
esa_state_ptr |
EsaT_State_Handle |
由 Esa_Init() 生成的 ESA 状态信息 |
command_name |
const char * |
命令名称 |
usage |
const char * |
命令名称与参数列表 |
category |
const char * |
用于对相关命令分组(例如:event、trace) |
short_desc |
const char * |
命令的简要说明(用于 help 类别) |
long_desc |
const char * |
命令的详细说明(用于 help 命令) |
callback |
EsaT_Odb_Command_Callback_Proc |
在 ODB 中输入新命令时调用的例程 |
state_ptr |
void * |
传递给回调例程的用户自定义信息 |
返回类型
EsaT_Compcode
命令能够注册时返回 EsaC_Comp_Success;否则返回 EsaC_Comp_Failure。
头文件
esa.h
详情
此函数可用于向 ODB 添加自定义命令;例如,用于显示联合仿真的相关信息。
callback 函数的原型见 EsaT_Odb_Command_Callback_Proc