AP API

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 values can be obtained with this API:
AUTOSKIP
COMPANY-NAME
COMPANY-NO (1st two digits in Screen-Alpha-Field)
DOS-USER-ID
EDITOR
LOGIN-DATE
LOGIN-TIME
LOG-PATH
HELP-PATH
MACRO-PATH
MANIFEST
MCMD
MCNTRY
MDATA
MDRIVE
MHELP
MPROG
MROOT
MSYSTEM
NSI-CFG-PATH
NWSM-CFG-PATH
NWSMUSER-CFG-PATH
MAX-USERS
PROCESS-EVENTS
PROCESS-ID (Unique nine-digit number identifying the running .EXE)
REG-ADDR-1
REG-ADDR-2
REG-ADDR-3
REG-COBOL-DEVELOPER
REG-Elliott
REG-LIC-NO
REG-NAME
ROOT-DIR
SET-COMPANY-NO (Use 1st two digits in Screen-Alpha-Field to set the current Company No and to be returned by the COMPANY-NO API call)
SHUTDOWN-FLAG
STARTUP-PATH
SUPPORT-SEGMENTED-KEYS
SYSTEM-VERSION
USE-ED
USER-FONT
VERSION
WAVE-PATH
WIN-USER-ID
WIN-VERSION
EXENAME (Find the name of the current EXE, like EL850, EL850P or EL850RP, etc.)

Prior to Elliott V8.5, all values are returned in SCREEN-ALPHA-FIELD.  For Elliott V8.5 and newer, all values are returned in SCREEN-ALPHA-FIELD except the following, which are returned in SCREEN-AREA because they are longer than 80 characters:
NSI-CFG-PATH
NWSM-CFG-PATH
NWSMUSER-CFG-PATH
STARTUP-PATH
JEG


    • Related Articles

    • ID API

      Release Date: 3/19/2019 The ID API will return the current Help ID (the current major Application program running in Elliott): MOVE "ID" TO SCREEN-PARAMETERS. PERFORM SCREEN-ROUTINE. MOVE SCREEN-ALPHA-FIELD TO MY-LOCAL-HELP-ID. In certain situations, ...

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

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