PrlDevMouse_Event Function

Sends absolute or relative mouse event with specified parameters within the virtual machine display coordinate grid.

Syntax

PRL_RESULT PrlDevMouse_Event(
    PRL_HANDLE hObj, 
    const PRL_IO_MOUSE_EVENT_EX4 * mouse, 
    PRL_UINT32 size, 
    PRL_BOOL absolute
);

File

PrlApiVm.h

Parameters

hObj

A handle of type PHT_VIRTUAL_MACHINE or PHT_DESKTOP_CONTROL.

mouse

Mouse event parameters.

size

Parameters structure size.

absolute

Whether event location is absolute.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Absolute event can only be sent if Parallels Tools package is installed in the target virtual machine and if Sliding Mouse feature is enabled. To find out if Sliding Mouse is enabled, use the PrlDevDisplay_IsSlidingMouseEnabled function.

Links

PHT_VIRTUAL_MACHINE