PrlVm_Stop Function

Stop the specified virtual machine.

Syntax

PRL_HANDLE PrlVm_Stop(
    PRL_HANDLE hVm, 
    PRL_BOOL bGraceful
);

File

PrlApiVm.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

bGraceful

If graceful shutdown is used, the machine will be properly shutdown by means of Guest tools (if available), or by ACPI request, If shutdown timeout expired the Vm will be forcebly stopped. If graceful shutdown is not used, the machine will be simply "unplugged"

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.

Links

PHT_VIRTUAL_MACHINE