Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlJob_GetError Function
PHT_JOB

Provides additional job error information.

Syntax
PRL_RESULT PrlJob_GetError(
    PRL_HANDLE hJob, 
    PRL_HANDLE_PTR phError
);
File

PrlApiCore.h

Parameters

hJob
A handle of type PHT_JOB identifying the job.
phError
[out] A pointer to a variable that receives a handle of type PHT_EVENT containing the error information.

Returns

PRL_RESULT. Possible values: 

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed. 

PRL_ERR_NO_DATA - no additional error information is available. 

PRL_ERR_UNIMPLEMENTED - the functionality is not available for this job type. 

PRL_ERR_SUCCESS - function completed successfully. 

Remarks

If a job returned an error code (see PrlJob_GetRetCode), you may call this function to see if additional error information is available. If the information is available, the function returns with PRL_ERR_SUCCESS and obtains a handle of type PHT_EVENT containing the information. To extract the information from the object, use the PrlEvent_GetErrString function.

Links
© 2021 Parallels International GmbH. All rights reserved.