Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITfKeystrokeMgr::GetPreservedKeyDescription method

Syntax


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

Parameters

rguid [in]

Contains the command GUID of the preserved key.

pbstrDesc [out]

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

Return value

This method can return one of these values.

ValueDescription
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.

 

Remarks

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

Requirements

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

See also

ITfKeystrokeMgr
SysFreeString

 

 

Community Additions

Show:
© 2015 Microsoft