PrlVm_StopEx Function

Stop the specified virtual machine.

Syntax

PRL_HANDLE PrlVm_StopEx(
    PRL_HANDLE hVm, 
    PRL_UINT32 nStopMode, 
    PRL_UINT32 nFlags
);

File

PrlApi.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

nStopMode

Virtual machine stop mode, an enumerator from the PRL_VM_STOP_MODE enumeration.

nFlags

Virtual machine stop option, an enumerator from the PRL_VM_STOP_FLAGS enumeration.

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

PrlApi.h , PHT_VIRTUAL_MACHINE