←Select platform

AbortJob Method

Summary

Aborts the specified compare job.

Syntax
C#
VB
C++
public static void AbortJob( 
   ObjectCache cache, 
   string userToken, 
   string jobToken 
) 
Public Shared Sub AbortJob( 
   ByVal cache As ObjectCache, 
   ByVal userToken As String, 
   ByVal jobToken As String 
) 
public:  
   static void AbortJob( 
      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.

Remarks

AbortJob can be called at any time to abort the running job with the specified user and job tokens. If no such job was found, then this method will return.

After a job is aborted, the next call to QueryJobStatus will return a CompareJobData with the value of CompareJobData.JobStatus set to Aborted.

Requirements

Target Platforms

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

Leadtools.Document.Compare Assembly