ITfInputProcessorProfileSubstituteLayout::GetSubstituteKeyboardLayout method (msctf.h)

Retrieves the input locale identifier (keyboard layout).

Syntax

HRESULT GetSubstituteKeyboardLayout(
  [in]  REFCLSID rclsid,
  [in]  LANGID   langid,
  [in]  REFGUID  guidProfile,
  [out] HKL      *phKL
);

Parameters

[in] rclsid

Contains the class identifier of the text service.

[in] langid

Specifies the language of the profile. See Language Identifiers.

[in] guidProfile

Identifies the profile GUID.

[out] phKL

Pointer to an HKL value that specifies the substitute input locale identifier.

Return value

This method can return one of these values.

Value Description
S_OK
The method was successful.

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 (include Msctf.h)
DLL Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfInputProcessorProfileSubstituteLayout

Language Identifiers

LoadKeyboardLayout

Text Service Registration