Ets_Nt_Object_Palette_Model_List_Get()
Abstract
Gets a list of all models of a specific type found in an object palette.
Syntax
Ets_Nt_Object_Palette_Model_List_Get (palette_name, obj_type)
| Argument | Type | Description |
|---|---|---|
palette_name |
const char * |
Object palette of interest. |
obj_type |
EtsT_Obj_Type |
Model type to return (see Details). |
Return Type
PrgT_List *
List of model names.
Header
ets_api_nt.h
Details
This function returns a list containing the names of all models of a specific metatype found in the specified object palette. Object palettes can contain the following metatypes:
- node
- link
- wireless domain
- demand
- path
- shared risk group
- annotation
obj_type should be a symbolic constant for one of these metatypes or a subtype. For example, to get a list of all node models in the object palette, obj_type could be either the metatype (EtsC_Obj_Mtype_Node) or a specific type of node (such as EtsC_Obj_Type_Node_Mob). See “General Sub-Package Symbolic Constants“ on page 1046 for a list of object type symbolic constants.
Note: To get a list of all models in the object palette, you can set obj_type to EtsC_Obj_Mtype_All.
The user is responsible for destroying the returned list when it is no longer needed.