KBDGetModState

Syntax

#include <cafe/kbd.h>

KBDEc KBDGetModState(KBDChannel ch, KBDModState *modState);

Parameters

ch Keyboard channel to query.
modState Pointer to a KBDModState value for storing the current modifier 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

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

The modifier key state is used by KBDTranslateHidCode to correctly translate HID codes into Unicodes. It also determines the state of the appropriate keyboard LEDs.

Do Not Call From

Background Do not call this function from the background.

See Also

Constants, Enumerators, and Types

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