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

    • LF API

      Release Date: 9/7/2021 Versions: 8.0 and higher This API takes a filespec, like C:\WINDOWS\*.*, and returns the next file in the specified directory for each successive call. Screen Parameters Comment LF,nn Input: SCREEN-LITERAL contains the ...

    • 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 ...

    • LN API

      Release Date: 5/17/17 LN: Length of String The LN API allows the developer to pass a string with a maximum length of 4000 bytes. The system will determine the position of the last non-space character in the string and pass the position back through ...

    • Programming API Codes

      This document is provided for Elliott software developers. If you are not an Elliott software developer, this document is not meaningful for you. AP: Get SMA Values This API returns various values from the Shared Memory Area. For example: Move ‘AP’ ...

    • 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 ...