Edit

Share via

ITfKeystrokeMgr::UnpreserveKey method (msctf.h)

  • Article

Unregisters a preserved key.

Syntax

HRESULT UnpreserveKey(
  [in] REFGUID               rguid,
  [in] const TF_PRESERVEDKEY *pprekey
);

Parameters

[in] rguid

Contains the command GUID of the preserved key.

[in] pprekey

Pointer to a TF_PRESERVEDKEY structure that specifies the preserved key. The uVKey member contains the virtual key code and the uModifiers member identifies the modifiers of the preserved key.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
CONNECT_E_NOCONNECTION
 The preserved key is not registered.
E_INVALIDARG
 One or more parameters are invalid.

Remarks

Preserved keys are registered by TSF text services and provide keyboard shortcuts to common commands implemented by the TSF text service.

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

ITfKeystrokeMgr

ITfKeystrokeMgr::PreserveKey

TF_PRESERVEDKEY