ITfKeystrokeMgr::GetPreservedKey method (msctf.h)

Article
10/13/2021

Obtains the command GUID for a preserved key.

Syntax

HRESULT GetPreservedKey(
  [in]  ITfContext            *pic,
  [in]  const TF_PRESERVEDKEY *pprekey,
  [out] GUID                  *pguid
);

Parameters

[in] pic

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

[in] pprekey

Pointer to a TF_PRESERVEDKEY structure that identifies the preserved key to obtain. The uVKey member contains the virtual key code and the uModifiers member identifies the modifiers of the preserved key. The uVKey member must be less than 256.

[out] pguid

Pointer to a GUID value that receives the command GUID of the preserved key. This is the GUID passed in the TSF text service call to ITfKeystrokeMgr::PreserveKey. This value receives GUID_NULL if the preserved key is not found.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful and the preserved key was found.
S_FALSE	The method was successful, but the preserved key was not found. pguid receives GUID_NULL.
E_INVALIDARG	One or more parameters are invalid.
E_FAIL	An unspecified error occurred.

Remarks

Preserved keys are registered by TSF text services and used to 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