Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlVm_DropSuspendedState Function
PHT_VIRTUAL_MACHINE

Resets a suspended virtual machine.

Syntax
PRL_HANDLE PrlVm_DropSuspendedState(
    PRL_HANDLE hVm
);
File

PrlApiVm.h

Parameters

hVm
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

When a virtual machine is suspended with the PrlVm_Suspend call, the current state of the virtual machine processes is saved into a temporary file on the hard disk, and the virtual machine is stopped. When a suspended virtual machine is resumed with the PrlVm_Resume call, the data in the temp file is used to restore the state of the virtual machine processes. The PrlVm_DropSuspendedState function resets a suspended virtual machine by deleting the temp file from the drive Once the function successfully completes, the virtual machine can no longer be resumed with the PrlVm_Resume call. It still can be started normally, however. 

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_SUCCESS - function completed successfully. 

Links
© 2021 Parallels International GmbH. All rights reserved.