GetConnections Method

In This Topic

Returns Eplan.EplApi.DataModel.Connections matching the given filter.
If the filter parameter is NULL, all the project connection objects are returned.
Note: If no filter is used, the number of objects returned may be bigger than the number of connections visible in the GUI connection navigator.
The GUI connection navigator by default shows connections of the following placement types only:
• Circuit
• CircuitSingleLine
• Overview
• PairCrossReference
• ProcessAndInstrumentationDiagram
• PanelLayout

Syntax

C#
C++/CLI

public Connection[] GetConnections( 
   ConnectionsFilter filter
)

public:
array<Connection^>^ GetConnections( 
   ConnectionsFilter^ filter
)

Parameters

Parameter Name	Description
filter	A Eplan.EplApi.DataModel.ConnectionsFilter, can be `NULL`

Return Value

• Eplan.EplApi.DataModel.Connections matching the given Eplan.EplApi.DataModel.ConnectionsFilter
• All Eplan.EplApi.DataModel.Connections if the filter is NULL

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown if internally used query throws exception.

Remarks

If the project setting "CableLog.CableManuell.CalcSrcDestInWireOrderOfNavigator" is set to TRUE, the connections that are cable conductors are sorted in order of the cable navigator.
If this project setting is set to FALSE, the order is based on the position of the cable conductors in the plot frame.

Reference

DMObjectsFinder Class
DMObjectsFinder Members
Connection Class
ConnectionsFilter Class

Use the Eplan Global Support Portal for feedback and support