ITfKeystrokeMgr::IsPreservedKey method

Syntax


HRESULT IsPreservedKey(
  [in]        REFGUID         rguid,
  [in]  const TF_PRESERVEDKEY *pprekey,
  [out]       BOOL            *pfRegistered
);

rguid [in]: Specifies the command GUID of the preserved key. This is the GUID passed in the text service call to ITfKeystrokeMgr::PreserveKey.
pprekey [in]: Pointer to a TF_PRESERVEDKEY structure that identifies the preserved key. 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.
pfRegistered [out]: Pointer to a BOOL that receives TRUE if the command GUID and key combination is a registered preserved key, or FALSE otherwise.

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.
E_INVALIDARG	One or more parameters are invalid.
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.

Minimum supported client	Windows 2000 Professional [desktop apps \| Windows Store apps]
Minimum supported server	Windows 2000 Server [desktop apps \| Windows Store apps]
Redistributable	TSF 1.0 on Windows 2000 Professional
Header	Msctf.h
IDL	Msctf.idl
DLL	Msctf.dll