UnloadKeyboardLayout

The UnloadKeyboardLayout function removes a keyboard layout.

BOOL UnloadKeyboardLayout(
  HKL hkl   // handle to keyboard layout
);
 

Parameters

hkl

Handle to the keyboard layout to unload.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. The function can fail for the following reasons:

• An invalid keyboard layout handle was passed.
• The layout was preloaded.
• The layout is in use.

To get extended error information, call GetLastError.

Remarks

Windows 95: UnloadKeyboardLayout cannot unload the system default keyboard layout. This ensures that an appropriate character set is always available for the user to type commands for the shell or names for the file system.

Windows NT: UnloadKeyboardLayout can unload the system default keyboard layout.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in winuser.h.
  Import Library: Use user32.lib.

See Also

Keyboard Input Overview, Keyboard Input Functions, ActivateKeyboardLayout, GetKeyboardLayoutName, LoadKeyboardLayout