GetFilteredFindPathsConfiguration Method

In This Topic

Gets the ArcGIS.Core.CIM.CIMFilteredFindPathsConfiguration with the specified name. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Function GetFilteredFindPathsConfiguration( _
   ByVal filteredFindPathsConfigurationName As String _
) As CIMFilteredFindPathsConfiguration

public CIMFilteredFindPathsConfiguration GetFilteredFindPathsConfiguration( 
   string filteredFindPathsConfigurationName
)

Parameters

filteredFindPathsConfigurationName: The name of the filtered find paths configuration to retrieve. This corresponds to ArcGIS.Core.CIM.CIMFilteredFindPathsConfiguration.Name.

Return Value

A ArcGIS.Core.CIM.CIMKnowledgeGraphQueryDefinition. If no filtered find paths configuration matching the name is found, null is returned. This method is case insensitive.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Example

Retrieve Investigation Filtered Find Paths Configurations

{
  // access the currently active knowledge graph investigation view
  KnowledgeGraphInvestigationView activeView = KnowledgeGraphInvestigationView.Active;
  KnowledgeGraphInvestigation investigation = activeView?.Investigation;
  if (investigation != null)
  {
    await QueuedTask.Run(() =>
    {
      // get all the configurations
      var configurations = investigation.GetAllFilteredFindPathsConfigurations();

      // get a specific FFP configuration
      var myConfiguration = investigation.GetFilteredFindPathsConfiguration("FFPConfig1");
    });
  }
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.7 or higher.

Reference

KnowledgeGraphInvestigation Class
KnowledgeGraphInvestigation Members

Send feedback