EtsT_Nt_Subnet_Grouping_Perform_Callback
Abstract
Callback: Used to perform a subnet grouping operation.
Syntax
<grouping_perform_callback_name> (input_nodes, params)
| Argument | Type | Description |
|---|---|---|
input_nodes |
EtsT_Obj_List * |
List of nodes to be grouped into a subnet. |
params |
PrgT_List * |
Parameters used to govern the grouping operation. |
Return Type
PrgT_List *
List of object groups of type EtsT_Obj_Group.
Header
ets_api_nt.h
Details
This callback type is used with the Group Nodes into Subnets feature. A function of this type is called whenever the GUI needs to perform a grouping operation.
The function should use the parameters in params to process the nodes listed in input_nodes and group them accordingly. The grouping results should be returned as follows:
- Nodes that have been successfully grouped should be removed from the
input_nodeslist and added to created object groups. The groups should be returned as elements of a PrgT_List. - Nodes that do not belong to any groups should remain in the
input_nodeslist.
The object groups to be returned can be manipulated with the following functions from the Object package (see “General Sub-Package“ on page 1006):
- Ets_Obj_Group_Create()
- Ets_Obj_Group_Destroy()
- Ets_Obj_Group_Name_Get()
- Ets_Obj_Group_Name_Set()
- Ets_Obj_Group_Obj_List_Get()
Note: The PrgT_List pointed to by params is owned by the application; the function can add or delete elements, but should not destroy the list.
Functions of this type are registered in a grouping definition (.gpf) file. See Subnet Grouping for details.