IrrReadKeyEvent

section index

## NAME

IrrReadKeyEvent - read the oldest key event in the buffer

## SYNOPSIS

IrrReadKeyEvent()

## INPUTS

## FUNCTION

Read a key event out

## EXAMPLE

       ; while there are key events waiting to be processed
       While IrrKeyEventAvailable()

           ; read the key event out. the key event has three parameters the key
           ; scan code, the direction of the key and flags that indicate whether
           ; the control key or the shift keys were also pressed
           *KeyEvent.IRR_KEY_EVENT = IrrReadKeyEvent()

           ; arbitrate based on the key that was pressed
           Select *KeyEvent\key
           ; .. now check the Key and start the action ...
           EndSelect

       Wend

## RESULT

pointer to a IRR_KEY_EVENT-Structure