PrlJob_Cancel Function

Cancel the specified job.

Syntax

PRL_HANDLE PrlJob_Cancel(
    PRL_HANDLE hJob
);

hJob

A handle of type PHT_JOB identifying the job.

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.

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.