ITfKeystrokeMgr::IsPreservedKey method (msctf.h)
Determines if a command GUID and key combination is a preserved key.
Syntax
HRESULT IsPreservedKey(
[in] REFGUID rguid,
[in] const TF_PRESERVEDKEY *pprekey,
[out] BOOL *pfRegistered
);
Parameters
[in] rguid
Specifies the command GUID of the preserved key. This is the GUID passed in the text service call to ITfKeystrokeMgr::PreserveKey.
[in] pprekey
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.
[out] pfRegistered
Pointer to a BOOL that receives TRUE if the command GUID and key combination is a registered preserved key, or FALSE otherwise.
Return value
This method can return one of these values.
| Value | Description |
|---|---|
|
The method was successful and the preserved key was found. |
|
The method was successful, but the preserved key was not found. |
|
One or more parameters are invalid. |
|
An unspecified error occurred. |
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 |