SetCompletedStatus Method

Summary

Sets the status of a job to Jobstatus.Completed.

Syntax
C#
VB
C++
public JobStatus SetCompletedStatus( 
   string jobID, 
   string jobMetadata 
) 
  
Public Function SetCompletedStatus( _ 
   ByVal jobID As String, _ 
   ByVal jobMetadata As String _ 
) As JobStatus 
public: 
JobStatus SetCompletedStatus(  
   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 that represents the new status of the specified job.

Remarks

Use this method to set the status of a job to Jobstatus.Completed indicating the job has been successfully processed. If the job is not found, 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. Depending on the programming language being used, the demo will be found in either the <installationdir>\Examples\DotNet\CS\OCRJobProcessorDemo directory. or the <installationdir>\Examples\DotNet\VB\OCRJobProcessorDemo directory. The <installationdir> represents the directory in which you installed the LEADTOOLS toolkit.

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.