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

6.20 $STACK

Returns information about the program execution stack. The $STACK intrinsic function has both a one-argument form and a two-argument form.

Syntax (One-Argument)

 $STACK(<num>)

If num is 0, returns the command with which this FreeM instance was invoked.

If num is -1, returns the current program execution stack level.

If num represents a valid program execution stack depth above 0, returns one of the following values indicating the reason for which the referenced program execution stack level was created:

$$

If $STACK(<num>)="$$", program execution stack level num was created as the result of an extrinsic function call

<m-command>

If $STACK(<num>) returns a valid M command, the referenced program execution stack level was created as a result of the m-command command.

Syntax (Two-Argument)

 $STACK(<num>,"[ECODE|MCODE|PLACE]")

Returns the error codes, M program code, or entryref applicable to the action that created program execution stack level num.


This document was generated on November 11, 2022 using texi2html 5.0.