Ets_Tool_Nth_Info_Get()
注意: 需要 OPNET Development Kit
摘要
返回某个已打开工具窗口的信息。
语法
Ets_Tool_Nth_Info_Get (index, dest_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
index |
int |
要查询信息的工具窗口的索引。 |
dest_ptr |
EtsT_Tool_Info * |
用于写入工具窗口信息的 EtsT_Tool_Info 结构的地址。 |
返回类型
EtsT_Compcode
如果 "index" 参数超出范围(不在 0 到 Ets_Tool_Count_Get() - 1(含)之间),返回 EtsC_Compcode_Failure;否则返回 EtsC_Compcode_Success。
头文件
ets_api_tool.h
详情
此函数返回由 index 参数选定的当前已打开工具窗口的信息。其设计意图是:客户端可以先调用 Ets_Tool_Count_Get() 获取工具窗口数量,然后以从 0 到(数量 - 1)的索引调用此函数,从而遍历所有已打开的工具窗口。
信息以 EtsT_Tool_Info 类型的结构返回,该结构的地址通过 dest_ptr 参数传入函数。此结构类型包含以下字段:
short_tool_name:工具窗口的基础类型,由 ETS 配置文件中的 "base_type" 属性指定(例如 "project")。full_tool_name:工具窗口的标题,由 ETS 配置文件中的 "title" 属性指定(例如 "Project")。model_name:该工具窗口中打开的模型的名称。