ITfKeyEventSink::OnPreservedKey method (msctf.h)

Called when a preserved key event occurs.

Syntax

HRESULT OnPreservedKey(
  [in]  ITfContext *pic,
  [in]  REFGUID    rguid,
  [out] BOOL       *pfEaten
);

Parameters

[in] pic

Pointer to the input context that receives the key event.

[in] rguid

Contains the command GUID of the preserved key.

[out] pfEaten

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

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

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