SetAbortedStatus Method

public JobStatus SetAbortedStatus( 
   string jobID,
   string jobMetadata
)

'Declaration
 
Public Function SetAbortedStatus( _
   ByVal jobID As String, _
   ByVal jobMetadata As String _
) As JobStatus

'Usage
 
Dim instance As JobBase
Dim jobID As String
Dim jobMetadata As String
Dim value As JobStatus
 
value = instance.SetAbortedStatus(jobID, jobMetadata)

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

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.

Target Platforms

Reference

JobBase Class
JobBase Members
Programming with the LEADTOOLS Distributed Computing (Job Processor) SDK
Creating Job Processor Worker Assemblies
Understanding The LEADTOOLS Job Processor Database
AbortJob Method