ImportFilteredFindPathsConfiguration Method

In This Topic

Import a filtered find paths configuration from a filtered find paths configuration file (*.ffpcfg) and add it to the investigation.

Syntax

Visual Basic (Declaration)
C#

Public Function ImportFilteredFindPathsConfiguration( _
   ByVal filePath As String _
) As Task(Of CIMFilteredFindPathsConfiguration)

public Task<CIMFilteredFindPathsConfiguration> ImportFilteredFindPathsConfiguration( 
   string filePath
)

Parameters

filePath: A filtered find paths configuration file.

Return Value

A Task to a ArcGIS.Core.CIM.CIMFilteredFindPathsConfiguration. If the import is not successful, then null is returned.

Exceptions

Exception	Description
System.ArgumentNullException	The filePath is null or empty.
System.ArgumentException	An invalid file Path was supplied.

Remarks

Filtered find paths configuration names must be unique within an investigation. If the name of the ArcGIS.Core.CIM.CIMFilteredFindPathsConfiguration to be imported already exists in the investigation, then a numerical suffix is applied to the name of the new ArcGIS.Core.CIM.CIMFilteredFindPathsConfiguration to ensure it is unique. This check is case insensitive.

Example

Import a Filtered Find Paths Configuration

{
  // access the currently active knowledge graph investigation view
  KnowledgeGraphInvestigationView activeView = KnowledgeGraphInvestigationView.Active;
  KnowledgeGraphInvestigation investigation = activeView?.Investigation;
  if (investigation != null)
  {
    string pathName = @"d:\data\EntityFFPConfig.ffpcfg";
    // import from ffpcfg
    var ffpConfig = await investigation.ImportFilteredFindPathsConfiguration(pathName);
  }
}

Requirements

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

ArcGIS Pro version: 3.7 or higher.

Reference

KnowledgeGraphInvestigation Class
KnowledgeGraphInvestigation Members

Send feedback