UnloadKeyboardLayout info  Overview  Group

The UnloadKeyboardLayout function removes a keyboard layout.

BOOL UnloadKeyboardLayout(

HKL hkl	// handle of keyboard layout
);

Parameters

hkl

Identifies 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.

See Also

ActivateKeyboardLayout, GetKeyboardLayoutName, LoadKeyboardLayout