Ets_Obj_Install_Connect()
Abstract
Installs a newly created link between two other objects.
Syntax
Ets_Obj_Install_Connect (src_hndl, dest_hndl, installee_hndl_ptr)
| Argument | Type | Description |
|---|---|---|
src_hndl |
EtsT_Obj_Handle |
Source endpoint handle. |
dest_hndl |
EtsT_Obj_Handle |
Destination endpoint handle. |
installee_hndl_ptr |
EtsT_Obj_Handle* |
Handle of connector to be installed. |
Return Type
void
No return value.
Header
ets_api_obj.h
Details
Associates the given link with a model and connects it to the given source and destination nodes. The link cannot already be associated with the model when this function is invoked. It is assumed that the name, model, etc., have already been set appropriately. The object’s name cannot be set at object creation time because the model into which the object will be installed is not known then. Likewise, it cannot be set now, because the user may have set the name already. To allow the user to set the name to a reasonable value, an API function has been provided to recommend a name for an object. This functionality can also be invoked by installing an object with its name equal to “”.
This procedure fails if installee_hndl_ptr* references a path object that requires links between its connected sites.