[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 GETKXLAT()
 Determines the current key code table
------------------------------------------------------------------------------
 Syntax

     GETKXLAT(<nKeyValue>) --> nKeyValue

 Argument

     <nKeyValue>  Designates the original key code so that its current
     value can be tested for translation or lock out.

 Returns

     GETKXLAT() returns the status of the key designated by <nKeyValue>.  A
     return value of 0 indicates that there is no translation.  A return
     value of -1 indicates that the key is locked out.  And any other return
     indicates that the designated key is translated into that key value.

     With CHR(NUMLOW(<nkeyValue>)) + CHR(NUMHIGH(<nkeyValue>)) the return
     value can be converted to the form used in the include file CTSCAN.CH

 Description

     GETKXLAT() allows you to test to see if a key designated under
     SETKXLAT() has been locked out or translated.  <nKeyValue> is the
     original key code.  The key codes used are described in detail in the
     SETKXLAT() function.

 Notes

     .  Symbolic constants for key codes can be found in the CTSCAN.CH
        file.

     .  You can also use the symbolic constants from the CA-Clipper
        file INKEY.CH for <cKeyValue>.

 Example

     Has the "A" key been locked out or translated?

     nVar  := GETKXLAT(KS_A)

     IF nVar <> 0
        * Undo translation/lock out for "A"
        SETKXLAT(KS_A)               // "A" returns to "A"
     ENDIF


See Also: SETKXLAT() SETKXTAB() GETKXTAB()
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson