IRDPViewerInputSink::SendMouseButtonEvent method (rdpencomapi.h)

[The IRDPViewerInputSink interface is no longer available for use for UWP applications as of Windows 10, version 1709. It is still supported for Desktop apps.]

Sends a mouse button event message.

Syntax

HRESULT SendMouseButtonEvent(
  [in] RDPSRAPI_MOUSE_BUTTON_TYPE buttonType,
  [in] VARIANT_BOOL               vbButtonDown,
  [in] ULONG                      xPos,
  [in] ULONG                      yPos
);

Parameters

[in] buttonType

The button that is pressed or released.

[in] vbButtonDown

The button state: TRUE if the button is down and FALSE otherwise.

[in] xPos

The mouse position in pixels along the horizontal axis.

[in] yPos

The mouse position in pixels along the vertical axis.

Return value

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code.

Requirements

See also

IRDPViewerInputSink