ITfContextKeyEventSink::OnTestKeyDown method (msctf.h)

Called to determine if a text service will handle a key down event.

Syntax

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

Parameters

[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 value that, on exit, indicates if the key event is handled. If this value receives TRUE, the key event is handled. If this value is FALSE, the key event is 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 only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header msctf.h
DLL Mscandui.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfContextKeyEventSink interface, WM_KEYDOWN, Keyboard Input