GetKeyboardLayoutList function (Windows)

Applies to: desktop apps only

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 WINAPI GetKeyboardLayoutList(
  __in   int nBuff,
  __out  HKL *lpList
);

Parameters

nBuff [in]

Type: int

The maximum number of handles that the buffer can hold.

lpList [out]

Type: HKL*

A pointer to the buffer that receives the array of input locale identifiers.

Return value

Type: UINT

If the function succeeds, the return value is the number of input locale identifiers copied to the buffer or, if nBuff is 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 get extended error information, call GetLastError.

Remarks

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

Requirements

See also

Reference

GetKeyboardLayout

Conceptual

Keyboard Input

Send comments about this topic to Microsoft

Build date: 3/6/2012