GetPotentialDefinitionsWithFilterScheme Method

In This Topic

Returns Eplan.EplApi.DataModel.PotentialDefinitions matching the given filter from the potential navigator.

Syntax

C#
C++/CLI

public PotentialDefinition[] GetPotentialDefinitionsWithFilterScheme( 
   string strFilterScheme
)

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

Parameters

strFilterScheme: Scheme name of filter from the potential navigator

Return Value

• If scheme name is empty, the current filter scheme will be used.
• If scheme name is NULL, the method returns elements that are visible if no filter scheme is used in a GUI navigator.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown if internally used query throws exception.
System.ArgumentException	Thrown if filter scheme does not exist.
System.ArgumentNullException	Thrown if strFilterScheme is set to NULL.

Reference

DMObjectsFinder Class
DMObjectsFinder Members
PotentialDefinition Class

Use the Eplan Global Support Portal for feedback and support