PrlVmCfg_GetOsType Function

Returns the type of the operating system that the specified virtual machine is running.

Syntax

PRL_RESULT PrlVmCfg_GetOsType(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32_PTR pnVmOsType
);

PrlApiVm.h

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pnVmOsType

[out] A pointer to a variable that receives the OS type.

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_NO_DATA - VM - the OS information is not present in the virtual machine configuration.

PRL_ERR_SUCCESS - function completed successfully.

The OS types are defined in the PrlOses.h file as macros. Look for the macros that are prefixed with PVS_GUEST_TYPE_ (e.g. PVS_GUEST_TYPE_MACOS).