KBDSetAccessSticky

Syntax

#include <cafe/kbd.h>

KBDEc KBDSetAccessSticky(KBDChannel ch, BOOL enable);

Parameters

ch Keyboard channel to set.
enable A BOOL value for setting the keyboard sticky key 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 was out of range.

Description

Sets the "sticky" key state of the USB keyboard on channel ch. The state is set to enable.

The sticky bit state controls the behavior of modifier keys that normally are active only while the keys such as SHIFT and CONTROL are pressed down. With the sticky mode enabled, pressing the modifier key toggles the modifier state on or off. With the sticky mode disabled, the modifier state is only on while an appropriate modifier key is pressed down.

The default value for enable is FALSE.

Do Not Call From

Background Do not call this function from the background.

Revision History

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


CONFIDENTIAL