KBDGetChannelStatus

C Specification

#include <revolution/kbd.h>

KBDEc KBDGetChannelStatus(KBDChannel ch, KBDChanStatus *status);

Arguments

`ch`	Keyboard channel to query.
`status`	Pointer to a KBDChanStatus value to store the channel status.

Return Values

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

Description

Returns the current status of the USB keyboard on channel ch. The returned status is written to the area pointed to by status. The channel status is a bit vector with the following possible values:

KBD_CS_OK - means the keyboard is connected and working normally
KBD_CS_DISCONNECTED - means the keyboard is not connected
KBD_CS_ROLL_OVER - means that too many keys are currently pressed down
KBD_CS_ERROR - means that either a keyboard POST (power-on self-test) failure or other undefined error has occurred

Revision History