Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function places the specified layout in the available layout list.

Syntax

HKL LoadKeyboardLayout(
  LPCSTR 
pwszKLID,
  UINT 
Flags
);

Parameters

pwszKLID

[in] Input locale identifier.

Flags

[in] Ignored.

Return Value

If successful, returns the handle to the input locale identifier. Otherwise returns zero.

Remarks

This function fails for any input locales that are not keyboard layouts, such as Input Method Editors (IMEs).

This function must be re-entrant, because the input system exposes it through the LoadKeyboardLayoutfunction and multiple threads can call it.

Requirements

Header winuser.h
Library coredll.lib
Windows Embedded CE Windows CE .NET 4.2 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also