PrlVmCfg_IsLockInFullScreenMode Function

Determines whether the lock in screen mode sign is set or not in a virtual machine configuration.

Syntax

PRL_RESULT PrlVmCfg_IsLockInFullScreenMode(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL_PTR pbValue
);

File

PrlApi.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pbValue

[out] A pointer to a variable that receives the result. PRL_TRUE indicates that feature is enabled. PRL_FALSE indicates otherwise.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer to buffer 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.