Ets_Showcase_Object_List_Feature()
摘要
使用列表中的对象修改 Showcase 的焦点对象集合。
语法
Ets_Showcase_Object_List_Feature (showcase_hndl, obj_lptr, feature_list_op, do_register_undo)
| 参数 | 类型 | 说明 |
|---|---|---|
showcase_hndl |
EtsT_Showcase_Handle |
目标 Showcase 对象。(若为 PRGC_NIL,则使用当前活动的 Showcase。) |
obj_lptr |
EtsT_Obj_List * |
要设为焦点的对象列表。 |
feature_list_op |
EtsT_Showcase_Feature_List_Operation |
指定如何处理已有的焦点对象列表(见详情)。 |
do_register_undo |
EtsT_Boolean |
启用可选的撤销支持。设置为 EtsC_True 时,会保存 Showcase 的初始状态,从而可以撤销对焦点对象的更改。 |
返回类型
EtsT_Compcode
若焦点对象集合发生了更改,返回 EtsC_Compcode_Success;否则返回 EtsC_Compcode_Failure。
头文件
ets_api_showcase.h
详情
此函数使用 obj_lptr 指定列表中符合条件的对象来更改 Showcase 的焦点对象集合。符合条件的对象包括节点、链路、路径、需求(demand)和子网。
feature_list_op 应为以下符号常量之一:
NtC_Showcase_Feature_List_Op_Add_To_Existing——将obj_lptr中的对象添加到焦点对象集合。NtC_Showcase_Feature_List_Op_Replace_Existing_Complete——销毁已有的焦点对象集合,并用obj_lptr中的对象替换。NtC_Showcase_Feature_List_Op_Replace_Existing_Transform——转换已有的焦点对象集合:先移除不在obj_lptr中的对象,再添加来自obj_lptr的新对象。(此选项会保留同时影响焦点集合与obj_lptr列表中对象的用户移动操作。)