Subroutines
Below is a table listing the subroutines (aka xcalls) found in A-Shell. For general information about subroutines, see the following Introduction topic.
This table alphabetically lists A-Shell’s most generally useful routines. Most of these routines are embedded in A-Shell, but some are written in BASIC and are provided as separate files. In the "Origin" column abbreviations are used for Alpha Accounting ("AA"), Alpha Accounting UK ("AA UK") and MicroSabio ("MS").
Follow the links to the individual pages providing details about the routines.
Routine |
Origin |
Function |
|---|---|---|
Unknown |
Draw a box. |
|
A-BASIC |
Input single character with no echo. |
|
A-BASIC |
Input single character with echo. |
|
Misc |
Display one-line menu, accept one-character input. |
|
AMBTOA |
AM Belgium |
Miscellaneous functions including timed input. |
MS |
Deprecated; see ASHELL. |
|
AA / MS |
Input "Any change?" number. |
|
Unknown |
ASCII-EBCDIC conversion. |
|
MS |
Set A-Shell runtime flags: read-only, sync-write, etc. |
|
MS |
Execute A-Shell system command or run program. |
|
MS |
Provides direct access to SQL databases. |
|
MS |
Transfers a file from application server to ATE client PC. |
|
MS |
Retrieves a file from the PC via the ATE terminal connection. |
|
MS |
Creates a customized ATE login script. |
|
ATSYNC |
MS |
Synchronize directories between server and PC. See ATSYNC.LIT. |
ATHTTP |
MS |
A variant of HTTP, which see for details. |
MS |
A-Shell's GUI interface and toolkit. |
|
AUTLOG |
Soft Machines |
Interface to AutoLog. |
A-Shell |
Base 64 encoding (for email attachments). |
|
A-BASIC |
Sort sequential and random data files. |
|
HMOpro |
Bit field operations. |
|
AA UK |
Return number of free disk blocks. |
|
MS |
Implements the Blowfish encryption algorithm. |
|
BOX1C |
Debug plc |
Various box drawing functions. |
BUTTED |
Unknown |
xcall butted, string removes all but 0-9 and A-Z. |
AA UK |
Disable Ctrl+C interrupts. |
|
AA UK |
Enable Ctrl+C interrupts. |
|
A-Shell |
CGI programming utilities. |
|
CHKKBD |
Misc |
Check keyboard; optionally input char if available: xcall chkkbd, flag (B,1) {,char (S,1)}. |
Unknown |
Check keyboard to see if character is available. |
|
CHKSPL |
Unknown |
Checks if spooler exists; must use ALIAS=CHKSPL:PRTCHK; similar to PRTCHK. |
MS |
Interface to CISAM file system. |
|
Debug plc |
Put command file in :R mode. |
|
MS |
Serial port I/O under Windows. |
|
A-BASIC |
Inter-program communication; configurable. |
|
A-Shell |
Get IP address, console device or machine name. |
|
ERS |
Calculate 16 bit CRC on block of data. |
|
CREMLX |
ADGAP |
Build multi-level index used by SEARCH. |
MS |
Provides a collection of cryptographic-related functions. |
|
Unknown |
Many date conversions, Julian, etc. |
|
DELCHR |
A-Shell |
xcall DELCHR, chrlst, string removes all the characters that are specified in chrlst from string. See the BASICplus function EDIT$() for related functionality. |
DERR |
A-Shell |
See ERRMSG. |
DEVCHK |
AA UK |
xcall DEVCHK, dev, status checks whether an AMOS logical device is defined to A-Shell. The dev parameter should contain the name of the device (e.g. DSK0); on return the status parameter (F,6) will be set to 1 if the device exists or 0 if it does not. |
A-Shell |
Returns various cryptographic digests of strings or files. |
|
A-Shell |
Disk-based equivalent of COMMON. |
|
Unknown |
Return disk and ppn. |
|
DSPLY |
AA |
Display variables with various formats. |
A-Shell |
Convert separated date to Julian. |
|
A-Shell |
Loads, unloads, calls routines in external function libraries. |
|
Unknown |
ASCII-EBCDIC conversion. |
|
A-BASIC |
Enter line mode. Turn on terminal echo. |
|
ERS |
Encrypted file service. |
|
MS |
Email a report. |
|
MS |
Send email. |
|
MS |
Error trap reporting routine; must alias to DERR. |
|
MS |
Event tracing; see Event Tracing. |
|
MS |
Send file to printer with enhanced options. |
|
MS |
Display file with paging, 80/132 switching. |
|
EXTRAI |
Celibec |
|
A-Shell |
Convert F,6 to IEEE format. |
|
MS |
Named pipe communications under Unix. |
|
FILL |
Unknown |
Variation of BASICplus FILL$() function: xcall fill, var, pattern {,length}. |
Unknown |
Returns file name for the specified channel. |
|
FILOCK |
AA UK |
Front-end to FLOCK. |
FINB |
Debug plc |
Input 1 byte from file: xcall finb, chan, byte, status. |
A-BASIC |
File/record locking control. |
|
AMOS |
Retrieves information about the current (or another) user from the database. |
|
A-Shell |
Force characters into another job’s input. |
|
A-Shell |
FTP file transfer, standard version. |
|
A-Shell |
FTP file transfer, modified version. |
|
FUNKEY |
MS |
Display function key line message. |
MS |
Send report to AshLite client for printing. |
|
AlphaSoft |
Get single character from keyboard or file. |
|
MS |
Return address and size of variable. |
|
Unknown |
Read raw bytes from a sequential file. |
|
AA UK |
Get current device. |
|
GETDSK |
AA UK |
Get current device. |
AA UK |
Get job name, program, ppn, job number. |
|
Debug plc |
Get job table information. |
|
GETLOG |
Unknown |
Get jobname, number, and ppn; must use ALIAS=GETLOG:GETJOB. |
MS |
Get MAC (hardware) address of Ethernet controller. |
|
AA UK |
Get current PPN. |
|
MS |
Get current program or SBX name. |
|
GETTRM |
MS |
Get current terminal name: xcall gettrm, trmdef$. |
Custom |
Get user login name. |
|
MS |
Get current program version. |
|
A-Shell |
Get single character with function key translation. |
|
SSCI |
Various Julian date manipulations. |
|
GTJBNO |
A-Shell |
xcall gtjbno, jobnam, jobno returns job number for specified job name (0 for error). |
A-BASIC |
Return current language information. |
|
A-Shell |
Generate a hash code from a string of characters. |
|
A-Shell |
Convert IEEE 4 or 8 byte float to BASIC 6 byte. |
|
A-Shell |
Execute host operating system cmd as a subroutine. |
|
MS |
View report in browser. |
|
MS |
Handle various kinds of HTTP requests. |
|
A-BASIC |
Input date. |
|
A-Shell |
Display images of common image file types. |
|
MS |
Variation of COMMON. |
|
MS |
Extended Alpha Accounting input routine. |
|
Steve Evans |
Read and write to ini files. |
|
MS |
Memo/Jotter editing/handling routine. |
|
INPUT |
UK |
Identical to INFLD. |
INPUTC |
AA UK |
Input variation used in the UK. |
INVUE |
Foxware |
Requires ALIAS=INVUE:INFLD. |
MS |
Create ISAM 1.0 file. |
|
MS |
Return information from the ISAM "rock" about filespec. |
|
DMSI |
Return information from the ISAM "rock" about currently open ISAM file. |
|
MegaSoft |
Send message to another process (Unix only). |
|
MS |
Performs various JSON-related utility functions. |
|
MS |
Set command to be executed whenever at command level (dot prompt). |
|
inSight |
Get information about your job. |
|
JOBNAM |
Unknown |
Equivalent to GETJOB. |
AA UK |
Return unique job number. |
|
Unknown |
Return jobnam, trmdef, tdvnam. |
|
Unknown |
Julian date conversions. |
|
KDAY |
AA UK |
Calculate elapsed days to given date (b,2). |
LAPSED |
AA UK |
Calculate elapsed days to given date (F,6). |
MS |
Lock users out of A-Shell. |
|
MS |
Log to a new PPN or retrieve PPN info. |
|
LOGRIO |
MS |
Logical record i/o (any size records). |
A-Shell |
Return last command line. |
|
HMOpro |
Compares a data field to a list of values or ranges. |
|
MESAG |
AA |
Display message on bottom line of screen. |
A-Shell |
Large library of A-Shell interface functions. |
|
MMENU |
AA |
Display file maintenance menu. |
MOUNT |
AA |
Display device mount message. |
MPSCOM |
Custom |
Interface to MacDonald PartSelect catalog. |
MS |
Box and window utility. |
|
MS |
Displays a message in a dialog box format. |
|
A-BASIC |
Output coded message to SYSLOG.SYS. |
|
AA UK |
Perform string search forwards or backwards. |
|
A-BASIC |
Enter image mode. Turn off terminal echo. |
|
NOEKO |
MS |
Same as NOECHO. |
MS |
Does nothing, provides a useful target for ALIAS directives for disabling an existing xcall that no longer serves any purpose. |
|
MS |
Checks a string for numeric only characters. |
|
MS |
Provides the means to obtain an OAUTH2 access token. |
|
A-BASIC |
Output formatted time and date. |
|
PACK |
A-Shell |
Pack three character string to B,2 RAD50: xcall pack, str, rad. |
HMOpro |
Display a pop-up pick list. |
|
PGMID |
MS |
Display screen header with program name, time, etc. |
PGMND |
AA |
Display end of program message. |
MS |
Return detailed job info about current or other job. |
|
PPNSWP |
Unknown |
Log to a new device:[p,pn]. Must use ALIAS=PPNSWP:SETPPN. |
AA |
Build formatted print file. |
|
PRIV |
AA |
Dummy routine, same as NOP. Was needed in AA, but not in A-Shell. |
AA UK |
Check printer name and printer queue. |
|
Unknown |
Write raw bytes to a sequential file. |
|
RDATE |
AA |
Get system date. |
MS |
Regular expression processor. |
|
MS |
Regular expression processor that acts on a single string subject, pattern and replacement specification |
|
RENAM |
MS |
Same as RENAME. |
A-BASIC |
Rename a file. |
|
ROUND |
Custom |
Round argument to nearest integer. |
RVCOMN |
Custom |
Like COMMON with one 1024 byte packet. |
MS |
Checks a string for unprintable characters. |
|
MS |
Check input buffer for function key (Windows only). |
|
SBRC |
UK |
Misc functions used by the R/W and P/G packages. |
Firmaware |
INFLD wrapper that simplifies some INFLD operations. |
|
SCGINP |
Unknown |
Variation of INPUT. |
SCRN |
Willowtree |
Willowtree Screen Handler. |
MS |
Scrolling status window handler. |
|
SEARCH |
ADGAP |
Enhanced (disk optimized) variation of SERCH. |
A-Shell |
Send a message to another terminal. |
|
AA |
Search random data file. |
|
SETDEV |
AA UK |
Change current device: xcall setdev, « dsk2 ». |
Debug plc |
Set job table information. |
|
SETPPN |
AA UK |
Change current PPN: xcall setppn,b2. |
A-Shell |
Returns size of specified file in bytes. |
|
SLEEP |
A-BASIC |
Stall processing for number of seconds. |
MegaSoft |
Sort array in memory. |
|
SPOOL |
A-BASIC |
Send file to printer. See EZSPL. |
MS |
Implements the data "squeeze" algorithm used by MX_FILEHOOK. |
|
MS |
Provides access to SQL databases. |
|
SRCH2 |
AA |
Search random data file. |
STALL |
AA |
Stall processing for number of seconds. |
STENO |
AA |
Input starting/ending numbers. |
STIME |
Dalcon |
Return current time in formatted string. |
A-BASIC |
Strip trailing spaces from string. |
|
MS |
Parse strings. |
|
Custom |
Launch a background task (Unix only). |
|
Swap |
Various Swap-related functions. |
|
SYS000 |
Misc |
Like COMMON (one packet, passive read): xcall sys000, sr (b,1), packet (x,100). |
TBOX |
Misc |
Draw box around specified SR,SC,ER,EC. |
TCKI |
MS |
Check to see if an input char is available without inputting it; xcall tcki, flag; flag (String) returns 0 if no char is available, 1 if one or more chars are available. |
MS |
Socket communications (client interface). |
|
MS |
Socket communications (server interface). |
|
MS |
Socket communications. |
|
MS |
Returns high-precision time information. |
|
AlphaSoft |
Check for terminal input. |
|
AA |
Display full transaction menu. |
|
AA |
Display partial transaction menu. |
|
Debug plc |
Strip trailing and leading spaces from string. |
|
A-BASIC |
Return terminal characteristics. |
|
Unknown |
Generate unique temp filename. |
|
UNPACK |
AA UK |
Unpack RAD50 word, e.g. xcall unpack,b2,s3. |
MS |
Creates an encoded bar string for the US Post Office intelligent bar codes. |
|
MS |
Get current user count and number of nodes licensed. |
|
USRTBL |
Custom |
xcall usrtbl, name, code, opcode. |
Swap |
Edit a rectangular array of text. |
|
WAIT |
AA |
Output "Please wait...." message. |
MS |
Wake up a sleeping job (Unix only). |
|
WHOAMI |
AA UK |
Get job name. |
inSight |
Get inSight information about your job. |
|
MS |
XTREE-based enhanced calendar control |
|
MS |
Insert text into the type-ahead buffer. |
|
HMOpro |
Intelligent folding of names. |
|
MS |
Move or copy an INMEMO logical memo. |
|
A-BASIC |
Shared resource control. |
|
XLSUTL |
MS |
Used internally by APEX, not suitable or intended for use in programs. Do not use! |
XMOUNT |
A-BASIC |
Mount a device. Dummy routine. |
MS |
Ennables the sending of instant messages using the XMPP protocol. |
|
MS |
Execute an AlphaPAINT 2.0 screen display. |
|
Unknown |
Get ppn, device, job, term. |
|
MS |
Enables customized activity tracking. |
|
MS |
Platform-independent "Shell Execute." |
|
MS |
Perform various string manipulations. |
|
MS |
Windows text control. |
|
MS |
Windows tree control. |
