KBDSetLockProcessing

C Specification

#include <revolution/kbd.h>

KBDEc KBDSetLockProcessing(KBDChannel ch, BOOL enable);

Arguments

`ch`	Keyboard channel to set.
`enable`	A BOOL value to use as the modifier processing state.

Return Values

KBDEc Keyboard error code.
KBD_SUCCESS if the call was successful.
KBD_ERR_NOT_INITIALIZED if the library was not initialized.
KBD_ERR_BAD_VALUE if ch is out of range.

Description

Sets the current modifier processing state of the USB keyboard on channel ch.

If the lock modifier processing state is TRUE, the KBD library processes all modifier keys as usual and sets the KBDModState accordingly. A lock modifier processing state of FALSE means that the KBD library will not process the locking modifier key presses, and the following KBDModState is left unchanged:

KBD_MS_CAPS_LOCK
KBD_MS_NUM_LOCK
KBD_MS_SCROLL_LOCK
KBD_MS_LANG1
KBD_MS_LANG2

The processing of other KBDModState is still handled as usual. That is, pressing the Shift key will still set the KBD_MS_SHIFT bit in the KBDModState, regardless of the lock modifier processing state. KBDModState is still used to translate HID codes into Unicodes.

The default value for enable is TRUE.

Revision History