PrlVmCfg_GetScrRes Function

Obtains a handle of type PHT_SCREEN_RESOLUTION identifying the specified virtual machine screen resolution.

Syntax

PRL_RESULT PrlVmCfg_GetScrRes(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32 nScrResIndex, 
    PRL_HANDLE_PTR phVmScrRes
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

nScrResIndex

A numeric index identifying the screen resolution (beginning with 0). To determine the number of the available resolutions, use PrlVmCfg_GetScrResCount.

phVmScrRes

[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.

Remarks

Once you obtain the handle, you can use its functions to modify the screen resolution settings.