Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlJob_GetRetCode Function
PHT_JOB

Obtains the return code from the specified job object.

Syntax
PRL_RESULT PrlJob_GetRetCode(
    PRL_HANDLE hJob, 
    PRL_RESULT_PTR retcode
);
File

PrlApiCore.h

Parameters

hJob
A handle of type PHT_JOB identifying the job.
retcode
[out] A pointer to a variable that receives the return code.

Returns

PRL_RESULT. Possible values: 

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed. 

PRL_ERR_SUCCESS - function completed successfully. 

Remarks

On asynchronous operation completion, the job object will contain a return code indicating whether the operation succeeded or failed. Different jobs may return different error codes. The most common codes are: PRL_ERR_INVALID_ARG (invalid input parameters were specified in the asynchronous function call) and PRL_ERR_SUCCESS (function successfully completed).

Links
© 2021 Parallels International GmbH. All rights reserved.