ITfKeystrokeMgr::GetPreservedKeyDescription method (msctf.h)

Obtains the description string of an existing preserved key.

Syntax

HRESULT GetPreservedKeyDescription(
  [in]  REFGUID rguid,
  [out] BSTR    *pbstrDesc
);

[in] rguid

Contains the command GUID of the preserved key.

[out] pbstrDesc

Pointer to a BSTR value the receives the description string. The caller must free this memory using SysFreeString.

This method can return one of these values.

Value	Description
S_OK	The method was successful.
E_INVALIDARG	One or more parameters is invalid or the preserved key is not found.
E_FAIL	An unspecified error occurred.

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

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