GK API

GK API

Release Date: 07/08/2021
Revised Date: 05/05/2022

This API allows the programmer to determine whether or not certain keystrokes have been pressed.

Screen-Parameters:
GK,nn                  nn provides different functionality as follows:

GK                        Wait for the next keystroke and return to the calling program (used mostly
                             for processing through a list of records in an OL window).
GK,95                   Wait for the next keystroke, but if none is pressed in a specified number of
                             seconds, return the specified default function key value
                             SCREEN-NUMERIC-FIELD = Number of seconds before timing out
                             FUNCTION-KEY-VALUE = the default function key value
GK,97                   (Version 8.6 and higher) Check for Ctrl+Shft+D (view I/O history), called
                              by BEXTFH after each 10th I/O operation -- useful to helping to detect I/O looping.
GK,98                    Used in a few special cases to avoid screen flashing.
GK,99                    Same as plain GK call, except returns immediately if no keystroke has been
                              pressed (used during report printing).

Return Value:
Screen-Function   The appropriate keystroke setting.

Example 1:

       MOVE "GK" TO SCREEN-PARAMETERS.
       PERFORM SCREEN-ROUTINE.
       IF  ABORT-KEY-PRESSED
     ...
Example 2:
A new paragraph has been added to GETKEY.PL, to facilitate using the timeout functionality.

       MOVE 10 TO SCREEN-NUMERIC-FIELD.
       MOVE "27" TO FUNCTION-KEY-VALUE.
       PERFORM GET-FUNCTION-KEY-WITH-TIMEOUT.

JEG


    • Related Articles

    • CV API

      Release Date: 10/31/2019 This API allows the programmer to determine whether or not thie current company's .DAT files have been converted to .BTR files. Screen-Parameters: CV Check the converted status for the current company. CV,nn Check the ...

    • AP API

      AP API This API returns various values from the Shared Memory Area. For example: MOVE "AP" TO SCREEN-PARAMETERS MOVE "EDITOR" TO SCREEN-LITERAL PERFORM SCREEN-ROUTINE This returns the user’s preferred Editor in SCREEN-ALPHA-FIELD. The following ...

    • DD API Changes (V9.0)

      DD: Drill Down The Drill Down API allows the developer to drill down to another Elliott application. The information provided in SCREEN-PARAMETERS will give the system the correct information to determine if the user has rights to the application ...

    • FA API Changes (V9.0)

      FA: File Access (Without File Handling) This API can be used to retrieve an individual field from a specific record in a file without specifying the file in the program and without opening and closing the file. In its simplest form, one can, for ...

    • FN API

      FN: Format Number (New) This API call will allow the programmer to pass a numeric value in SCREEN-NUMERIC-FIELD. This field will be formatted based on type and maximum size provided, and the results will be passed back as follows: · ...