GetKey

FreeBASIC

GetKey
 
Returns the ascii code of the first key in the keyboard buffer

Syntax

Declare Function GetKey ( ) As Long

Usage

result = GetKey

Return Value

The value of the ascii code returned.

Description

It returns the ascii code of the first key in the keyboard buffer. The key is removed from the buffer. If no key is present, GetKey waits for it. For extended keys (returning two characters), the extended code is returned in the first byte, and the regular code is returned in the second byte. (see example below)

The key read is not echoed to the screen.

For a keyword not stopping the program if no key is at the buffer see Inkey or MultiKey.

Example

Dim As Integer foo
Do
    foo = GetKey
    Print "total return: " & foo
    
    If( foo > 255 ) Then
        Print "extended code: " & (foo And &hff)
        Print "regular code: " & (foo Shr 8)
    Else
        Print "regular code: " & (foo)
    End If
    Print 
Loop Until foo = 27



Dialect Differences

  • Not available in the -lang qb dialect unless referenced with the alias __Getkey.

Differences from QB

  • New to FreeBASIC

See also