Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlJob_Cancel Function
PHT_JOB

Cancel the specified job.

Syntax
PRL_HANDLE PrlJob_Cancel(
    PRL_HANDLE hJob
);
File

PrlApiCore.h

Parameters

hJob
A handle of type PHT_JOB identifying the job.

Returns

PRL_HANDLE to the job being canceled. 

PRL_INVALID_HANDLE - not enough memory to instantiate asynchronous operation. 

The results are retrieved using the PrlJob_GetRetCode function. Possible values: 

PRL_ERR_INVALID_ARG - invalid PHT_JOB handle was passed. 

PRL_ERR_UNINITIALIZED - job instance was not bound to Parallels Service connection. 

Remarks

If an asynchronous operation takes a long time to complete, you may cancel it by calling this function. The call does not destroy the job object.

Links
© 2021 Parallels International GmbH. All rights reserved.