PrlDevDisplay_SetConfiguration Function

Sends a request to a virtual machine to set guest display configuration to specified values.

Syntax

PRL_RESULT PrlDevDisplay_SetConfiguration(
    PRL_HANDLE hVm, 
    const PRL_IO_DISPLAY_SCREEN_SIZE_PTR displays, 
    PRL_INT32 nCount
);

File

PrlApi.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

nCount

Count of displays in array.

size

Array of display configurations for all guest displays that will be enabled.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

The guest OS can accept or reject the new resolution depending on compatibility factors. The function does not provide information on whether the new resolution was accepted or not. The PRL_ERR_SECCESS return code means that the function didn't fail but it doesn't mean that the screen resolution was actually changed. To verify the results of the operation, you can capture the guest OS screen before and after executing this function and compare the results. You can use this function only if the Parallels Tools package is installed in the target virtual machine and if the Dynamic Resolution feature is turned on. To determine the status of the Dynamic Resolution feature, use the PrlDevDisplay_GetDynResToolStatus function.

Links

PrlApi.h , Primary Display Capture