PrlVm_Suspend Function

Suspends the specified virtual machine.

Syntax

PRL_HANDLE PrlVm_Suspend(
    PRL_HANDLE hVm
);

File

PrlApi.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

When a running virtual machine is suspended, the state of the virtual machine processes is saved into a file on the host and after that the machine is stopped. To resume the machine, use the PrlVm_Resume function. If, after suspending a machine, you don't want to resume it but would like to return to the previous state, you may call the PrlVm_DropSuspendedState function.

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.