PrlVmInfo_GetState Function

Returns the virtual machine state information.

Syntax

PRL_RESULT PrlVmInfo_GetState(
    PRL_HANDLE handle, 
    VIRTUAL_MACHINE_STATE_PTR pVmState
);

PrlApiVm.h

handle

A handle of type PHT_VM_INFO.

pVmState

[out] A pointer to a variable that receives the virtual machine state information.

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_NO_DATA - the virtual machine state information is not available.

PRL_ERR_SUCCESS - function completed successfully.