PrlVmCfg_IsAutoCaptureReleaseMouse Function

Determines whether the automatic capture and release of the mouse pointer is enabled or not.

Syntax

PRL_RESULT PrlVmCfg_IsAutoCaptureReleaseMouse(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL_PTR pbEnabled
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pbEnabled

A pointer to a variable that receives the result. PRL_TRUE indicates that the feature is enabled. PRL_FALSE indicates that it is disabled.

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

When this feature is enabled, the mouse input is automatically redirected from the host OS to the virtual machine and vise versa as soon as the mouse pointer is positioned over the host OS or the virtual machine desktop. This feature requires Parallels Tools installed in a virtual machine.

Links

PHT_VM_CONFIGURATION