KBDGetModState

C Specification

#include <revolution/kbd.h>

KBDEc KBDGetModState(KBDChannel ch, KBDModState *modState);

Arguments

`ch`	Keyboard channel to query.
`modState`	Pointer to a `KBDModState` value to store the current modifier state.

Return Values

KBDEc Keyboard error code.
KBD_SUCCESS if the call was successful.
KBD_ERR_NOT_INITIALIZED is returned if the library is not initialized.
KBD_ERR_BAD_VALUE is returned if ch is out of range.
KBD_ERR_BAD_POINTER is returned if modState is not a valid pointer.

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.

Revision History