AbortJob Method

Summary

Aborts the specified compare job.

Syntax

C++/CLI

Python

public static void AbortJob( 
   ObjectCache cache, 
   string userToken, 
   string jobToken 
)

public:  
   static void AbortJob( 
      ObjectCache^ cache, 
      String^ userToken, 
      String^ jobToken 
   )

def AbortJob(self,cache,userToken,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