Ets_Topo_Connect_Get()
Abstract
Returns a handle to the indexed object of the specified type which connects the specified source object to the specified.
Syntax
Ets_Topo_Connect_Get (src_obj_hndl, dest_obj_hndl, connect_mtype, connect_index)
| Argument | Type | Description |
|---|---|---|
src_obj_hndl |
EtsT_Obj_Handle |
Handle to source object. |
dest_obj_hndl |
EtsT_Obj_Handle |
Handle to destination object. |
connect_mtype |
“EtsT_Obj_Type“ |
Value specifying the type or meta-type of connecting object (one of the values in Table 33 “General Sub-Package Symbolic Constants“ on page 1046). |
connect_index |
int |
Index of connector of interest.Index specifying which of the connecting objects to return. |
Return Type
EtsT_Obj_Handle
Handle to the object connecting source object to destination object.
Header
ets_api_topo.h
Details
When the source and destination objects are network node (or bus) objects, the connecting objects are either simplex links (or taps) that point from the source object to the destination object, or are duplex links or paths. Currently, both the source and destination object must be in the same subnet and all connecting objects will also be in that subnet.
The connect_mtype argument can be either a specific object type (e.g., EtsC_Obj_Type_Lkdup) or a general object meta-type (e.g., EtsC_Obj_Mtype_All).
The connect_index argument must be a value between zero (inclusive) and the count (exclusive) returned by Ets_Topo_Connect_Count_Get(), when called with the same source and destination objects and the same object type.