PrlVm_Pause Function

Pauses the specified virtual machine.

Syntax

PRL_HANDLE PrlVm_Pause(
    PRL_HANDLE hVm, 
    PRL_BOOL bAcpi
);

File

PrlApi.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

bAcpi

Specifies if ACPI should be used to pause the virtual machine. If set to PRL_FALSE , ACPI will not be used. In this case, all processes of the virtual machine sill be simply be stopped. If the parameter is set to PRL_TRUE , ACPI will be used to pause the machine. With ACPI, the machine will be paused using a method supported by the guest operating system (sleep, hibernate, etc.). The actual method used will depend on the type and configuration of the guest OS.

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