StopSteps Method—ArcGIS Pro

StopSteps Method

In This Topic

Stops running the steps in the array. Each step can be Run again or Finish can be used to complete them. In case of GP step and question step, the processing of each step is cancelled. In case of manual and open app step, each step is paused. Each step can be forced to stop by a user not assigned to the step with the jobForceStop privilege. This method must be called on the MCT. Use QueuedTask.Run. If no stepIds are specified, then all the current steps will be stopped.

Syntax

Visual Basic (Declaration)
C#

Sub StopSteps( _
   ByVal jobId As String, _
   Optional ByVal stepIds As List(Of String) _
)

void StopSteps( 
   string jobId,
   List<string> stepIds
)

Parameters

jobId
stepIds

Example

QueuedTask.Run(() => { var id = WorkflowClientModule.JobsManager.GetJobId(); var stepIds = new List() { "123456789", "234567890" }; WorkflowClientModule.JobsManager.StopSteps(id, stepIds); });

Stop running steps on a job

{
  var jobManager = WorkflowClientModule.JobsManager;
  // Get the job Id associated with the active map view
  jobId = jobManager.GetJobId();
  // Stop the current steps in the job with the given id.
  jobManager.StopSteps(jobId);
}

Stop specific running steps on a job

{
  var jobManager = WorkflowClientModule.JobsManager;
  // Get the job Id associated with the active map view
  jobId = jobManager.GetJobId();
  // Specify specific running steps in a job to stop
  List<string> stepIds = ["step12345", "step67890"];
  jobManager.StopSteps(jobId, stepIds);
}

Requirements

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

ArcGIS Pro version: 3.2 or higher.

Reference

IJobsManager Interface
IJobsManager Members

Send feedback