UpdatePercentage Method

public bool UpdatePercentage( 
   string jobID,
   int percentage,
   string workerMetadata
)

public bool UpdatePercentage( 
   string jobID,
   int percentage,
   string workerMetadata
)

 function Leadtools.Cloud.Job.JobBase.UpdatePercentage( 
   jobID ,
   percentage ,
   workerMetadata 
)

public:
bool UpdatePercentage( 
   String^ jobID,
   int percentage,
   String^ workerMetadata
) 

'Declaration
 
Public Function UpdatePercentage( _
   ByVal jobID As String, _
   ByVal percentage As Integer, _
   ByVal workerMetadata As String _
) As Boolean

'Usage
 
Dim instance As JobBase
Dim jobID As String
Dim percentage As Integer
Dim workerMetadata As String
Dim value As Boolean
 
value = instance.UpdatePercentage(jobID, percentage, 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 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 the process will be terminated.

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

If an emtpy 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 Cloud Database.

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

JobBase Class
JobBase Members
Programming with LEADTOOLS Cloud SDK
Creating Cloud Worker Assemblies
Understanding The LEADTOOLS Cloud Database