Edit

Share via

ITfKeyEventSink::OnKeyDown method (msctf.h)

  • Article

Called when a key down event occurs.

Syntax

HRESULT OnKeyDown(
  [in]  ITfContext *pic,
  [in]  WPARAM     wParam,
  [in]  LPARAM     lParam,
  [out] BOOL       *pfEaten
);

Parameters

[in] pic

Pointer to the input context that receives the key event.

[in] wParam

Specifies the virtual-key code of the key. For more information about this parameter, see the wParam parameter in WM_KEYDOWN.

[in] lParam

Specifies the repeat count, scan code, extended-key flag, context code, previous key-state flag, and transition-state flag of the key. For more information about this parameter, see the lParam parameter in WM_KEYDOWN.

[out] pfEaten

Pointer to a BOOL that, on exit, indicates if the key event was handled. If this value receives TRUE, the key event was handled. If this value is FALSE, the key event was not handled.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Target Platform Windows
Header msctf.h
DLL Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfKeyEventSink, WM_KEYDOWN, Keyboard Input