Windows apps
Collapse the table of content
Expand the table of content
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::SetPreservedKeyDescription method

Syntax


HRESULT SetPreservedKeyDescription(
  [in]       REFGUID rguid,
  [inconst WCHAR   *pchDesc,
  [in]       ULONG   cchDesc
);

Parameters

rguid [in]

Contains the command GUID of the preserved key.

pchDesc [in]

Pointer to a Unicode string that contains the new description of the preserved key. This cannot be NULL unless cchDesc is zero.

cchDesc [in]

Number of characters in pchDesc. Pass zero for this parameter if no description is required.

Return value

This method can return one of these values.

ValueDescription
S_OK

The method was successful.

E_INVALIDARG

One or more parameters are 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
ITfKeystrokeMgr::GetPreservedKeyDescription

 

 

Show:
© 2017 Microsoft