GetPotentialDefinitionsWithFilterScheme Method

In This Topic

Returns PotentialDefinitions matching given filter from potentials-navigator.

Syntax

C#
C++/CLI

public PotentialDefinition[] GetPotentialDefinitionsWithFilterScheme( 
   string strFilterScheme
)

public:
array<PotentialDefinition^>^ GetPotentialDefinitionsWithFilterScheme( 
   String^ strFilterScheme
)

Parameters

strFilterScheme: Scheme-name of filter potentials-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
PotentialDefinition Class

Send Feedback