SetFailureStatus Method

public JobStatus SetFailureStatus( 
   string jobID,
   int failedErrorID,
   string failedMessage,
   string jobMetadata
)

'Declaration
 
Public Function SetFailureStatus( _
   ByVal jobID As String, _
   ByVal failedErrorID As Integer, _
   ByVal failedMessage As String, _
   ByVal jobMetadata As String _
) As JobStatus

'Usage
 
Dim instance As JobBase
Dim jobID As String
Dim failedErrorID As Integer
Dim failedMessage As String
Dim jobMetadata As String
Dim value As JobStatus
 
value = instance.SetFailureStatus(jobID, failedErrorID, failedMessage, jobMetadata)

public:
JobStatus SetFailureStatus( 
   String^ jobID,
   int failedErrorID,
   String^ failedMessage,
   String^ jobMetadata
) 

Parameters

jobID

ID (GUID) of the job to update.

failedErrorID

Error code for the job.

failedMessage

Error message for the job.

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.Failed. 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.

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