PrlDevDisplay_IsSlidingMouseEnabled Function

Determines if Sliding Mouse feature is enabled in the specified virtual machine.

Syntax

PRL_RESULT PrlDevDisplay_IsSlidingMouseEnabled(
    PRL_HANDLE hObj, 
    PRL_BOOL_PTR flag
);

File

PrlApiVm.h

Parameters

hObj

A handle of type PHT_VIRTUAL_MACHINE or PHT_DESKTOP_CONTROL.

flag

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

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Sliding Mouse is a feature that comes with Parallels Tools package. If Sliding Mouse is enabled, the mouse cursor can "slide" from the virtual machine desktop to the host OS desktop without pressing any of the special keys on the keyboard. This function is used when writing remote desktop applications with graphical user interfaces. For more information, see the Mouse Control section in this chapter.

Links

Primary Display Capture