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

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

    • SYSPASS DDF Shared Memory Not Available When Starting Up Elliott

      Release Date: 1/18/2019 Q - I just started to use Elliott 8.5, on a user's computer, with the EL850.EXE utility, I created the Run Local icon for the user on the desktop. When I logged in to Elliott 8.5 for the first time, right after the system ...

    • TP API: Temporary Path

      TP API: Temporary Path This API returns the Windows temporary path in SCREEN-ALPHA-FIELD (or SCREEN-AREA) or, if a file is passed in SCREEN-LITERAL, the file is returned with the Windows temporary path included. For example, to simply get the ...

    • FF API: File Functions

      Date Revised: 9/12/23 FF: File Function This API has several options that help perform operations for file names; in particular, on long file names (length greater than 100 characters and/or containing one of more embedded SPACEs). Notes: This API ...

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