PrlVmCfg_GetDisplayDev Function

Obtains a handle of type PHT_VIRTUAL_DEV_DISPLAY containing information about a display device in a virtual machine.

Syntax

PRL_RESULT PrlVmCfg_GetDisplayDev(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phDevice
);

File

PrlApi.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

nIndex

An index identifying the display device (beginning with 0). To obtain the number of display devices in a virtual machine, use the PrlVmCfg_GetDisplayDevsCount function.

phDevice

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

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.