UpdatePercentage Method

Summary

Sends updated progress information for the current job to the windows service.

Syntax
C#
VB
C++
public bool UpdatePercentage( 
   string jobID, 
   int percentage, 
   string workerMetadata 
) 
  
Public Function UpdatePercentage( _ 
   ByVal jobID As String, _ 
   ByVal percentage As Integer, _ 
   ByVal workerMetadata As String _ 
) As Boolean 
public: 
bool UpdatePercentage(  
   String^ jobID, 
   int percentage, 
   String^ workerMetadata 
)  

Parameters

jobID
ID (GUID) of the job to update.

percentage
Progress (0-100) of the current job.

workerMetadata
Metadata which contains any extra information about the job as reported by the worker assembly.

Return Value

A boolean value indicating whether processing should continue for this job (true = continue processing; false = stop processing).

Remarks

A value of false indicates the job was either aborted or deleted by an administrator or client.

Failure to update the progress can cause the windows service to assume the process is hung. This will result in the OnJobTerminated method to be called and the process will be terminated.

Progress should be posted at the interval specified by the percentage parameter.

If an empty string is passed for the workerMetadata parameter, the existing worker metadata for the job is maintained. For more information on how the workerMetadata 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.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.