IRDPViewerInputSink::SendMouseButtonEvent method

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

buttonType [in]

The button that is pressed or released.

vbButtonDown [in]

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

xPos [in]

The mouse position in pixels along the horizontal axis.

yPos [in]

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

Minimum supported client

Windows 8.1 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 R2 [desktop apps | Windows Store apps]

Header

RdpEncomAPI.h

IDL

RdpEncomAPI.idl

Type library

RdpEncomAPI.tlb

DLL

RdpEncom.dll

See also

IRDPViewerInputSink

 

 

Show: