# READKEY()*

Find out which key terminated a READ.

Syntax

  READKEY() --> nKeyCode

Arguments

  None.

Returns

  READKEY() returns a numeric code representing the key that caused READ to terminate.

Description

  READKEY() is used after a READ was terminated to determine the exit key pressed. If the GET buffer was updated during READ, 256 is added to the return code.

Exit | Return code |
Key | (not updated) | (updated)
Up | 4 | 260
Down | 5 | 261
Page-Up | 6 | 22
Page-Down | 7 | 263
Ctrl Page-Up | 34 | 290
Ctrl Page-Down | 35 | 291
Esc | 12 | 268
Ctrl End | 14 | 270
Enter | 15 | 271
Key >= 32 | 15 | 271
otherwise | 0 |

  READKEY() is a compatibility function so try not to use it. READKEY() is superseded by LASTKEY() which returns the INKEY() code for that key. UPDATED() could be used to find if the GET buffer was changed during the READ.

Status

  Ready

Compliance

  READKEY() is compliant with CA-Clipper 5.3

Files

  Library is rtl

See Also

- @...GET
- INKEY()
- LASTKEY()
- READ
- READEXIT()
- UPDATED()