GetConnections Method

In This Topic

Returns Connections matching given filter. If null parameter is passed, all the project's connection objects are returned. Note: In case no filter used, number of objects returned may be bigger than the number of connections visible in the GUI's connection navigator. The GUI's 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

filter: a ConnectionsFilter, can be null

Return Value

* Connections matching given ConnectionsFilter. * all Connections when filter is null.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when internal used query throw exception.

Reference

DMObjectsFinder Class
DMObjectsFinder Members
Connection Class
ConnectionsFilter Class

Send Feedback