ITfInputProcessorProfiles::SubstituteKeyboardLayout method (msctf.h)

Sets a substitute keyboard layout for the specified language profile.

Syntax

HRESULT SubstituteKeyboardLayout(
  [in] REFCLSID rclsid,
  [in] LANGID   langid,
  [in] REFGUID  guidProfile,
  [in] HKL      hKL
);

Parameters

[in] rclsid

Contains the CLSID of the text service of the profile in question.

[in] langid

Contains a LANGID value that specifies the language of the profile in question.

[in] guidProfile

Contains a GUID value that identifies the profile in question.

[in] hKL

Contains an HKL value that specifies the input locale identifier for the substitute keyboard. Obtain this value by calling LoadKeyboardLayout.

Return value

This method can return one of these values.

Value Description
S_OK
The method was successful.
E_FAIL
An unspecified error occurred.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header msctf.h
DLL Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfInputProcessorProfiles

LoadKeyboardLayout