GetPlugsWithFilterScheme Method

In This Topic

Returns Eplan.EplApi.DataModel.EObjects.Plugs matching given filter from plugs-navigator.

Syntax

C#
C++/CLI

public Plug[] GetPlugsWithFilterScheme( 
   string strFilterScheme
)

public:
array<Plug^>^ GetPlugsWithFilterScheme( 
   String^ strFilterScheme
)

Parameters

strFilterScheme: Scheme-name of filter plugs-navigator

Return Value

* if scheme-name is empty, the current filter-scheme will be used. * if scheme-name is null, the method returns elements which are visible when no filter schema is used in a GUI navigator.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when internal used query throw exception.
System.ArgumentException	Thrown when filter schema does not exist.
System.ArgumentNullException	Thrown if strFilterScheme is set to null.

Reference

DMObjectsFinder Class
DMObjectsFinder Members
Plug Class

Send Feedback