Ets_Showcase_Object_List_Feature()

Abstract

Modifies the featured objects of a showcase using the objects in a list.

Syntax

Ets_Showcase_Object_List_Feature (showcase_hndl, obj_lptr, feature_list_op, do_register_undo)
Argument Type Description
showcase_hndl EtsT_Showcase_Handle Showcase object of interest. (If PRGC_NIL, the active showcase is used.)
obj_lptr EtsT_Obj_List * List of objects to feature.
feature_list_op EtsT_Showcase_Feature_List_Operation Specifies how to handle the existing featured object list (see Details).
do_register_undo EtsT_Boolean Enables optional undo support. When set to EtsC_True, the beginning state of the showcase is saved so that the change to the featured objects can be undone.

Return Type

EtsT_Compcode

EtsC_Compcode_Success if the featured objects set was changed; EtsC_Compcode_Failure otherwise.

ets_api_showcase.h

Details

This function changes the featured objects set of a showcase using the qualifying objects in the list specified by obj_lptr. Qualifying objects are nodes, links, paths, demands, and subnets.

feature_list_op should be one of the following symbolic constants:

  • NtC_Showcase_Feature_List_Op_Add_To_Existing—Add objects in obj_lptr to featured objects set.
  • NtC_Showcase_Feature_List_Op_Replace_Existing_Complete—Destroy existing featured objects set and replace with objects in obj_lptr.
  • NtC_Showcase_Feature_List_Op_Replace_Existing_Transform—Transform existing featured objects set by removing objects not in obj_lptr, then adding new objects from obj_lptr. (This option preserves any user moves affecting objects in both the featured set and the obj_lptr list.)

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com