Edit

ITfKeystrokeMgr::SimulatePreservedKey method (msctf.h)

  • Article

Simulates the execution of a preserved key sequence.

Syntax

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

Parameters

[in] pic

Pointer to the application context. This value was returned by a previous call to ITfDocumentMgr::CreateContext.

[in] rguid

Contains the command GUID of the preserved key.

[out] pfEaten

Pointer to a BOOL that 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.
S_FALSE
 The preserved key cannot be simulated.
E_INVALIDARG
 One or more parameters are invalid.
E_FAIL
 An unspecified error occurred.

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

ITfDocumentMgr::CreateContext

ITfKeystrokeMgr