QueryJobStatus Method

Summary

Retrieves the status of the specified job.

Syntax

C++

public static CompareJobData QueryJobStatus( 
   ObjectCache cache, 
   string userToken, 
   string jobToken 
)

Public Shared Function QueryJobStatus( 
   ByVal cache As ObjectCache, 
   ByVal userToken As String, 
   ByVal jobToken As String 
) As CompareJobData

public:  
   static CompareJobData^ QueryJobStatus( 
      ObjectCache^ cache, 
      String^ userToken, 
      String^ jobToken 
   )

Parameters

cache

Cache containing the status data.

userToken

Value indicating the user token of the job.

jobToken

Value indicating the job token of the job.

Return Value

Data containing the last status of this job if found; otherwise, null if no such job was found.

Remarks

QueryJobStatus is the main method of communication between the application and the runner to obtain the status of the job. The CompareJobData returned from this method contains a clone of the object found in the cache and can be changed or stored by the application.

Requirements

Target Platforms