[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 READKEY()*
 Determine what key terminated a READ
------------------------------------------------------------------------------
 Syntax

     READKEY() --> nReadkeyCode

 Returns

     READKEY() returns a code representing the key pressed to exit a READ.
     In CA-Clipper, the following keys are the standard READ exit keys and
     their READKEY() return codes:

     READKEY() Return Codes
     ------------------------------------------------------------------------
     Exit Key            Return Code
     ------------------------------------------------------------------------
     Up arrow             5
     Down arrow           2
     PgUp                 6
     PgDn                 7
     Ctrl+PgUp           31
     Ctrl+PgDn           30
     Esc                 12
     Ctrl+End, Ctrl+W    14
     Type past end       15
     Return              15
     ------------------------------------------------------------------------

 Description

     READKEY() is a keyboard function that emulates the READKEY() function in
     dBASE III PLUS.  Its purpose is to determine what key the user pressed
     to terminate a READ.  If UPDATED() is true (.T.), READKEY() returns the
     code plus 256.  Up arrow and Down arrow exit a READ only if READEXIT()
     returns true (.T.).  The default value is false (.F.).  To provide
     complete compatibility for these keys, execute a READEXIT (.T.) at the
     beginning of your main procedure.

     READKEY() is supplied as a compatibility function and, therefore, its
     use is strongly discouraged.  It is superseded entirely by LASTKEY()
     which determines the last keystroke fetched from the keyboard buffer.
     If the keystroke was a READ exit key, LASTKEY() will return the INKEY()
     code for that key.  To determine whether any Get object's buffer was
     modified during a READ, it is superseded by the UPDATED() function.

 Files   Library is EXTEND.LIB, source file is SOURCE\SAMPLE\READKEY.PRG


See Also: @...GET NEXTKEY() READ READEXIT()
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson