KBDGetChannelStatus

Syntax

#include <cafe/kbd.h>

KBDEc KBDGetChannelStatus(KBDChannel ch, KBDChanStatus *status);

Parameters

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 was not initialized.
KBD_ERR_BAD_VALUE if ch was out of range.

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:

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