PrlVmCfg_CreateScrRes Function

Creates a new handle of type PHT_SCREEN_RESOLUTION and adds it to the specified virtual machine resolution list.

Syntax

PRL_RESULT PrlVmCfg_CreateScrRes(
    PRL_HANDLE hVmCfg, 
    PRL_HANDLE_PTR phVmScrRes
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

phVmScrRes

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

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Use this function when you want to add an additional screen resolution to the virtual machine. Once you obtain the handle, use its functions to set the screen resolution parameters, such as width and height. It is the responsibility of the caller to free the handle when it is no longer needed.