KBDGetLockProcessing

Syntax

#include <cafe/kbd.h>

KBDEc KBDGetLockProcessing(KBDChannel ch, BOOL *enable);

Parameters

ch Keyboard channel to query.
enable Pointer to a BOOL value for storing 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

Returns the current lock modifier processing state of the USB keyboard on channel ch. The returned state is written to the area pointed to by enable.

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 indicates that the KBD library will not process the locking modifier key presses, and the following KBDModState will be left unchanged:

Processing of other KBDModState is still handled routinely. That is, pressing the SHIFT key will still set the KBD_MS_SHIFT bit in KBDModState regardless of the lock modifier processing state. The KBDModState is used to convert HID code to Unicode.

Do Not Call From

Background Do not call this function from the background.

Revision History

2013/05/08 Automated cleanup pass.
2013/01/13 Removed KBD_ERR_BAD_POINTER.
2011/12/21 Moved to Cafe.
2007/03/27 Initial version.


CONFIDENTIAL