PrlVmCfg_SetAutoCaptureReleaseMouse Function

Enables or disables the automatic capture and release of the mouse pointer in a virtual machine.

Syntax

PRL_RESULT PrlVmCfg_SetAutoCaptureReleaseMouse(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL bEnabled
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

bEnabled

Action type. Specify PRL_TRUE to enable the feature or 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

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