ExportFilteredFindPathsConfiguration Method

In This Topic

Exports the specified ArcGIS.Core.CIM.CIMFilteredFindPathsConfiguration to the file path. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Function ExportFilteredFindPathsConfiguration( _
   ByVal filteredFindPathsConfiguration As CIMFilteredFindPathsConfiguration, _
   ByVal filePath As String, _
   ByVal overwrite As Boolean _
) As Boolean

public bool ExportFilteredFindPathsConfiguration( 
   CIMFilteredFindPathsConfiguration filteredFindPathsConfiguration,
   string filePath,
   bool overwrite
)

Parameters

filteredFindPathsConfiguration: The ArcGIS.Core.CIM.CIMFilteredFindPathsConfiguration to export.
filePath: The export file name and path. The file extension should be .ffpcfg.
overwrite: If the export file already exists, this flag indicates if it should be overwritten. If the flag is false and the export file exists, then the function returns false.

Return Value

True if the export is successful.

Exceptions

Exception	Description
System.ArgumentNullException	The filteredFindPathsConfiguration or filePath is null.
System.ArgumentException	An invalid filePath was supplied.
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Example

Export a Filtered Find Paths Configuration

{
  // access the currently active knowledge graph investigation view
  KnowledgeGraphInvestigationView activeView = KnowledgeGraphInvestigationView.Active;
  KnowledgeGraphInvestigation investigation = activeView?.Investigation;
  if (investigation != null)
  {
    await QueuedTask.Run(() =>
    {
      // update FFPConfig properties
      var myFFPConig = investigation.GetFilteredFindPathsConfiguration("FFPConfig1");
      if (myFFPConig != null)
      {
        string pathName = @"d:\data\EntityFFPConfig.ffpcfg";
        // export from ffpcfg
        investigation.ExportFilteredFindPathsConfiguration(myFFPConig, pathName, true);
      }
    });
  }
}

Requirements

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

ArcGIS Pro version: 3.7 or higher.

Reference

KnowledgeGraphInvestigation Class
KnowledgeGraphInvestigation Members

Send feedback