IRDPViewerInputSink::SendKeyboardEvent 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 keyboard event message.

Syntax

HRESULT SendKeyboardEvent(
  RDPSRAPI_KBD_CODE_TYPE codeType,
  UINT16                 keycode,
  VARIANT_BOOL           vbKeyUp,
  VARIANT_BOOL           vbRepeat,
  VARIANT_BOOL           vbExtended
);

Parameters

codeType

The encoding of the key code.

keycode

The key code of the pressed or released key.

vbKeyUp

The state of the key: TRUE if the key is released, FALSE if the key is pressed.

vbRepeat

The key code is a repeated code: FALSE if this is the initial key code from a key press, TRUE if this is repeated code from a single key press.

vbExtended

The key code is extended: TRUE if the code is extended, FALSE otherwise.

Return value

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

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps only]
Minimum supported server Windows Server 2012 R2 [desktop apps only]
Target Platform Windows
Header rdpencomapi.h
DLL RdpEncom.dll

See also

IRDPViewerInputSink