PrlVmCfg_SetLockInFullScreenMode Function

Enables or disables the lock in screen mode feature in a virtual machine configuration.

Syntax

PRL_RESULT PrlVmCfg_SetLockInFullScreenMode(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL bValue
);

File

PrlApi.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

bValue

Action type. Specify PRL_TRUE to enable feature. Specify PRL_FALSE to disable it.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Lock in screen mode is feature of Parallels Player product that allows to mandatory apply full screen mode for Parallels GUI until guest OS started and go to the windowed mode just after guest OS will be stopped.