PrlVm_ToolsGetShutdownCapabilities Function

Check graceful shutdown tool capabilities.

Syntax

PRL_RESULT PrlVm_ToolsGetShutdownCapabilities(
    PRL_HANDLE hVm, 
    PRL_UINT32_PTR pCapsMask
);

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

pCapsMask

Mask containing types of shutdown (see PRL_GRACEFUL_SHUTDOWN_CAPABILITIES in PrlEnums.h)

PRL_RESULT. Possible values:

PRL_ERR_FAILURE - means that for some reason capabilities of graceful shutdown tool can't be obtained.

PRL_ERR_INVALID_ARG - invalid vm handle or null pointer was passed.

PRL_ERR_UNINITIALIZED - Desktop object is not accessible

PRL_ERR_UNIMPLEMENTED - guest OS shutdown isn't supported

PRL_ERR_SUCCESS - function completed successfully.

Depends on capabilities of the guest OS.