PrlVm_GetSuspendedScreen Function

Retrieves the virtual machine screen state before it was suspending.

Syntax

PRL_HANDLE PrlVm_GetSuspendedScreen(
    PRL_HANDLE hVm
);

File

PrlApiVm.h

Parameters

handle

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

Remarks

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_VM_IS_NOT_SUSPENDED - the virtual machine is not in the suspended state.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_VIRTUAL_MACHINE