C5_GETAPPLYKEY

 GETAPPLYKEY()
 Apply a key to a Get object from within a  reader
------------------------------------------------------------------------------
 Syntax

     GETAPPLYKEY(<oGet>, <nKey>, <GetList>, <oMenu>,
        <nMsgRow>, <nMsgLeft>, <nMsgRight>, <cMsgColor>)
        --> NIL

 Arguments

     <oGet> is a reference to a Get object.

     <nKey> is the INKEY() value to apply to <oGet>.

     <GetList> is a reference to the current list of Get objects.

     <oMenu> is a reference to any top bar menu.

     <nMsgRow> is a numeric value representing the row of the message
     bar.

     <nMsgLeft> is a numeric value representing the left column of the
     message bar.

     <nMsgRight> is a numeric value representing the right column of the
     message bar.

     <cMsgColor> is a character string representing the colors to be used
     for the message bar text.

 Returns

     GETAPPLYKEY() always returns NIL.

 Description

     GETAPPLYKEY() is a Get system function that applies an INKEY() value to
     a Get object.  Keys are applied in the default way.  That is, cursor
     movement keys change the cursor position within the GET, data keys are
     entered into the GET, etc.

     If the key supplied to GETAPPLYKEY() is a SET KEY, GETAPPLYKEY() will
     execute the set key and return; the key is not applied to the Get
     object.

 Notes

     .  Focus:  The Get object must be in focus before keys are
        applied. Refer to Get:setFocus and Get:killFocus for more
        information.

     .  CLEAR GETS:  The Get object must be in focus before keys are
        applied.  Refer to Get:setFocus and Get:killFocus for more
        information.

 Examples

     This example will apply keystrokes until Exit:

        WHILE (oGet:exitState == GE_NOEXIT)
           GETAPPLYKEY (oGet, INKEY(0), GetList, oMenu, nMsgRow,;
        nMsgLeft, nMsgRight, nMsgColor)
        ENDDO

 Files   Library is CLIPPER.LIB, source file is Getsys.prg.

See Also: GETDOSETKEY() GETPOSTVALID() GETPREVALID()