Ets_Obj_Path_Install_Connect()
Abstract
Connect an unconnected path to a set of nodes and links.
Syntax
Ets_Obj_Path_Install_Connect (installee_path_hndl, circuit_connections_lptr)
| Argument | Type | Description |
|---|---|---|
installee_path_hndl |
EtsT_Obj_Handle * |
Path to be installed |
circuit_connections_lptr |
EtsT_Obj_List * |
List of nodes and links to which the path will be connected. |
Return Type
EtsT_Compcode
See Details.
Header
ets_api_obj.h
Details
Make a path that is not currently associated with a model associated with the model and connected to nodes and links from the circuit connection list.
The network to which the nodes and links belong will take ownership of the path, so other code should not free it.
Circuit connectivity is not checked after installation.
The following conditions must be satisfied:
- The path to be installed must not belong to a model.
- The object to be installed must be a path.
- All nodes and links in the connection list must be from the same network model.
- The elements in the connection list must be pointers to objects representing nodes or links.
If any of the above conditions are not met, EtsC_Compcode_Failure is returned. Otherwise, EtsC_Compcode_Success is returned.