Ets_Obj_Install_Interactive()
摘要
以交互方式向打开的网络模型中添加站点、链路或路径对象。
语法
Ets_Obj_Install_Interactive (installee_hndl, abort_handler, completion_handler, state_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
installee_hndl |
EtsT_Obj_Handle |
待安装对象的句柄。 |
abort_handler |
EtsT_Obj_Interactive_Installation_Callback |
用户取消操作时要调用的处理函数。 |
completion_handler |
EtsT_Obj_Interactive_Installation_Callback |
用户完成操作时要调用的处理函数。 |
state_ptr |
void* |
客户端指定的状态指针,将传递给 completion_handler() 或 abort_handler()。 |
返回类型
EtsT_CompCode
若操作成功则返回 EtsC_CompCode_Success;否则返回 EtsC_CompCode_Failure。
头文件
ets_api_obj.h
详情
该函数等效于从对象面板中选择并拖拽一个对象,并调用以下两个函数之一:
completion_handler()—用户选择并将对象拖入网络后调用abort_handler()—用户取消操作时调用
abort_handler() 和 completion_handler() 是可选的回调函数;其原型见 EtsT_Obj_Interactive_Installation_Callback。
installee_hndl 引用的对象必须是尚未安装的站点、链路或路径对象。注意,对象的基础属性(如 “model”)必须在该函数调用之前设置。
该函数在其终止之前拥有待安装的对象。因此,在 Ets_Obj_Install_Interactive() 终止之前,installee_hndl 引用的对象不能被其他任何进程销毁。