KPRRemoveChar

Syntax

#include <cafe/kpr.h>

wchar_t KPRRemoveChar(KPRQueue *queue);

Parameters

queue Pointer to the queue from which to retrieve an unprocessed character.

Return Values

Character removed from tail of queue.

Description

This function retrieves a not-yet-processed character from the tail of a keyboard processing queue. If no character is available, it returns 0.

Do Not Call From

Background Do not call this function from the background.
Callbacks Do not call this function from any callback function.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.

See Also

KPRGetChar

Revision History

2013/05/08 Automated cleanup pass.


CONFIDENTIAL