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 retrieves the input locale identifiers, formerly called keyboard layout handles, corresponding to the current set of input locales in the system. The function copies the identifiers to the specified buffer.

Syntax 

UINT GetKeyboardLayoutList(
  int 
nBuff, 
  HKL* 
lpList
);

Parameters

nBuff

[in] Maximum number of handles that the buffer can hold.

lpList

[out] Pointer to the buffer that receives the array of input locale identifiers.

Return Value

If the function succeeds, the return value is the number of input locale identifiers copied to the buffer or, if nBuffis zero, the return value is the size, in array elements, of the buffer needed to receive all current input locale identifiers.

If the function fails, the return value is zero. To obtain extended error information, call GetLastError.

Remarks

The input locale identifier is a broader concept than a keyboard layout, because it can also encompass a speech-to-text converter, an IME, or any other form of input.

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