[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3. Intrinsic Special Variables


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.1 $DEVICE

Returns the status of the device currently in use, and is writable.

If $DEVICE returns 1, an error condition exists on the current device.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.2 $ECODE

Returns a comma-delimited list of error conditions currently present, and is writable. An empty $ECODE indicates no errors.

FreeM currently sets $ECODE only for errors established by the MDC (MUMPS Development Committee).

Setting $ECODE has no effect, as FreeM does not currently implement standard error-handling with $ETRAP.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.3 $ESTACK

Returns an empty string, as FreeM does not currently implement standard error-handling with $ETRAP.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.4 $ETRAP

Returns an empty string and is writable, but unused as FreeM does not currently implement standard error-handling with $ETRAP.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.5 $HOROLOG

Returns a string containing the current date and time as <days>,<seconds>, where <days> represents the number of days since the MUMPS epoch (midnight on 31 December 1840), and <seconds> represents the number of seconds since the most recent midnight.

Non-Standard Behavior

In FreeM, $HOROLOG is writable, and will set the current system time as long as the user has sufficient permissions to do so.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.6 $IO

Represents the current input/output device. Read-only.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.7 $JOB

Represents the process ID of the FreeM instance currently in use.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.8 $KEY

Represents the sequence of control characters that terminated the last READ command on $IO.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.9 $PRINCIPAL

Represents the primary input/output device. Usually a terminal or virtual terminal.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.10 $QUIT

If the current execution context was invoked as an extrinsic function, $QUIT returns 1. Otherwise, returns 0.

When $QUIT returns 1, a subsequent QUIT command must have an argument.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.11 $STACK

Represents the current stack level.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.12 $STORAGE

Represents the number of bytes of free space available in FreeM’s heap.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.13 $SYSTEM

Returns the MDC system ID of FreeM.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.14 $TEST

$TEST is a writable ISV that is 1 if the most recent conditional expression returned true. Otherwise, returns false.

$TEST is implicitly NEWed when entering a new stack frame.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.15 $TLEVEL

Returns an empty string, as FreeM does not currently implement transaction processing.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.16 $TRESTART

Returns an empty string, as FreeM does not currently implement transaction processing.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.17 $X

Represents the current column position of the FreeM cursor. In FreeM, setting

Non-Standard Behavior

In FreeM, setting $X will move the FreeM cursor.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.18 $Y

Represents the current row position of the FreeM cursor.

Non-Standard Behavior

In FreeM, setting $Y will move the FreeM cursor.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.19 $ZA


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.20 $ZB


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.21 $ZCONTROLC


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.22 $ZDATE


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.23 $ZERROR


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.24 $ZF


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.25 $ZHOROLOG


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.26 $ZINRPT


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.27 $ZJOB


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.28 $ZLOCAL


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.29 $ZMATCHCONTROL


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.30 $ZMATCHNUMERIC


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.31 $ZMATCHPUNCTUATION


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.32 $ZMATCHALPHABETIC


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.33 $ZMATCHLOWERCASE


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.34 $ZMATCHUPPERCASE


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.35 $ZMATCHEVERYTHING


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.36 $ZNAME


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.37 $ZORDER


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.38 $ZPRECISION


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.39 $ZREFERENCE


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.40 $ZSYSTEM


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.41 $ZTIME


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.42 $ZTRAP


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3.43 $ZVERSION


[ << ] [ >> ]           [Top] [Contents] [Index] [ ? ]

This document was generated by John P. Willis on March 13, 2020 using texi2html 1.82.