AbortJob Method

Summary

Aborts a job in the Job Processor database.

Syntax
C#
VB
C++
[FaultContractAttribute(System.Type)] 
[OperationContractAttribute()] 
public AbortJobResponse AbortJob( 
   AbortJobRequest request 
) 
  
<OperationContractAttribute()> 
<FaultContractAttribute(DetailType=Leadtools.Services.JobProcessor.FaultContracts.CloudFault,  
   Action="",  
   Name="",  
   Namespace="",  
   ProtectionLevel=ProtectionLevel.None,  
   HasProtectionLevel=False)> 
Function AbortJob( _ 
   ByVal request As AbortJobRequest _ 
) As AbortJobResponse 
[OperationContractAttribute()] 
[FaultContractAttribute(DetailType=Leadtools.Services.JobProcessor.FaultContracts.CloudFault,  
   Action="",  
   Name="",  
   Namespace="",  
   ProtectionLevel=ProtectionLevel.None,  
   HasProtectionLevel=false)] 
AbortJobResponse^ AbortJob(  
   AbortJobRequest^ request 
)  

Parameters

request
An Leadtools.Services.JobProcessor.DataContracts.AbortJobRequest class containing information about the job to be aborted.

Return Value

An Leadtools.Services.JobProcessor.DataContracts.AbortJobResponse class that indicates whether the job was successfully marked for aborting.

Remarks

Use this method to mark a job for aborting. When calling the method, the cMustAbort column for the specified job is set to 1. The worker assembly is notified to abort the job via calls to the UpdatePercentage method. The job is not actually aborted (where the job status is set to JobStatus.Aborted) until the worker processing this job calls the SetAbortedStatus method from the worker assembly.

For more information, refer to Creating Job Processor Worker Assemblies.

Example
C#
VB
using LeadtoolsJobProcessorExamples.JobService; 
 
public void AbortJob(string jobID) 
{ 
   using (JobServiceClient jobServiceClient = new JobServiceClient()) 
   { 
      AbortJobRequest abortJobRequest = new AbortJobRequest(); 
      abortJobRequest.ID = jobID; 
      abortJobRequest.Reason = "Duplicate Job"; 
      AbortJobResponse abortJobResponse = jobServiceClient.AbortJob(abortJobRequest); 
      if (abortJobResponse.IsAborted) 
         Console.WriteLine("The job was successfully aborted."); 
      else 
         Console.WriteLine("The job was not aborted."); 
   } 
} 
Public Sub AbortJob(ByVal jobID As String) 
   Using jobServiceClient As JobServiceClient = New JobServiceClient() 
      Dim abortJobRequest As AbortJobRequest = New AbortJobRequest() 
      abortJobRequest.ID = jobID 
      abortJobRequest.Reason = "Duplicate Job" 
      Dim abortJobResponse As AbortJobResponse = jobServiceClient.AbortJob(abortJobRequest) 
      If abortJobResponse.IsAborted Then 
         Console.WriteLine("The job was successfully aborted.") 
      Else 
         Console.WriteLine("The job was not aborted.") 
      End If 
   End Using 
End Sub 

Requirements

Target Platforms

Help Version 20.0.2019.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.