←Select platform

QueryJobStatus Method

Summary

Retrieves the status of the specified job.

Syntax
C#
VB
C++
public static StatusJobData QueryJobStatus( 
   ObjectCache cache, 
   string userToken, 
   string jobToken 
) 
Public Shared Function QueryJobStatus( 
   ByVal cache As ObjectCache, 
   ByVal userToken As String, 
   ByVal jobToken As String 
) As StatusJobData 
public:  
   static StatusJobData^ 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 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 StatusJobData returned from this method contain a clone of the object found in the cache and can be changed or stored by the application.

Example

For an example, refer to StatusJobDataRunner.

Requirements

Target Platforms

Help Version 20.0.2020.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.Converter Assembly