SetAbortedStatus Method

Summary

Sets the status of a job to Jobstatus.Aborted.

Syntax
C#
VB
C++
public JobStatus SetAbortedStatus( 
   string jobID, 
   string jobMetadata 
) 
  
Public Function SetAbortedStatus( _ 
   ByVal jobID As String, _ 
   ByVal jobMetadata As String _ 
) As JobStatus 
public: 
JobStatus SetAbortedStatus(  
   String^ jobID, 
   String^ jobMetadata 
)  

Parameters

jobID
ID (GUID) of the job to update.

jobMetadata
Metadata which contains information on how this job should be processed.

Return Value

A JobStatus value that represents the new status of the specified job.

Remarks

Use this method to set the status of a job to Jobstatus.Aborted. If a client or administrator deletes a job, or calls the AbortJob Method, the next call to UpdatePercentage will return false, informing you to abort the job and call SetAbortedStatus to finalize the abort operation. If the job is not found (it was deleted), Jobstatus.NotFound will be returned.

If an empty string is passed for the jobMetadata parameter, the existing job metadata for the job is maintained. For more information on how the jobMetadata property is used, refer to Understanding The LEADTOOLS Job Processor Database.

Example

Refer to the OCRJobProcessorDemo (LEADTOOLS Installation Directory\Examples\DotNet\'CS or VB'\OCRJobProcessorDemo).

Requirements

Target Platforms

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