Please enable JavaScript to view this site.

A-Shell Reference

All of the functions listed in the table below except MEM() require COMPIL /X:2 or higher.

Function

Description

.ARGTYP()

Returns the type of the specified argument passed to the current SBX, function, or procedure.

.ARGSIZ()

Returns the size of the specified argument passed to the current SBX, function, or procedure.

.ARGTYP_READONLY()

Indicates whether the specified argument is read-only.

.ARG_PASSED()

Indicates whether the specified argument was passed to the current SBX, function, or procedure.

ERR()

ERR() is used within an error trap to return information relating to an ASB error that has occurred.

ERRMSG()

ERRMSG(X) returns the message associated with ASB error X, based on contents of sys:errmsg.xxx.

.EXTENT()

Returns the "extent" of the specified array or collection. See Special ORDMAP Functions.

GETKEY()

This function inputs a single keyboard character and returns its numeric (ASCII or Latin1) character value.

.ISNULL()

Tests for the .NULL condition. See Special ORDMAP Functions.

.KEY()

Returns the key associated with the element currently indexed by the iterator. See Special ORDMAP Functions.

MEM()

MEM(X) returns information about available memory and resources. See table of MEM(X) Values below.

.NEXT()

Advances the iterator, returning the associated key or .null if no more. See Special ORDMAP Functions.

PYFUNC()

Provides a means to call an external function written in Python version 3.

XFUNC(), XFUNC$()

XFUNC and XFUNC$ execute an external SBX routine, returning a numeric or string value.

MEM(X) Values

Function

Description

MEM(0)

returns the number of bytes of free space remaining in the "partition," which is used mostly for variable storage, expression evaluation, stack, and possibly SBX loading.

MEM(1)

returns total size of "partition." See MEMORY.LIT, MX_MEMORYXS, and MEMORYSP for further discussion and methods of configuring partition size.

MEM(5)

size of compiled object code area

MEM(6)

size of DATA pool

MEM(7)

size of array storage area

MEM(8)

size of variable storage area (excluding arrays)

 

See Also