Ets_Obj_List_File_Read()
Abstract
Creates a list of objects specified in a selection set file.
Syntax
Ets_Obj_List_File_Read (tfile_name, obj_lpptr)
| Argument | Type | Description |
|---|---|---|
tfile_name |
const char * |
Selection set file to read (base name with no file extension). The file directory must be listed in mod_dirs. |
obj_lpptr |
EtsT_Obj_List ** |
Pointer to the list created by the function. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if a list can be created (even if some names cannot be resolved to actual network objects); EtsC_Compcode_Failure if any errors occur.
Header
ets_api_obj.h
Details
This function reads a selection set tfile and creates a list of pointers to every object named in the tfile that exists in the current scenario. This function will not create objects; any object in the tfile that is not in (or cannot be recognized in) the current scenario will be ignored. The caller owns the list created by this function and should destroy it with Ets_Obj_List_Destroy() when no longer needed.