Macro Command Help

SCROFF.

 

Macro Command Name

Menu Path

Link to Command Table

SCROFF

Access via macro or menu only

Click here

 

Introduction

Diverts text screen output into a system file during macro execution.

How to use

Only output created by interactive prompts, or created by the soft commands !ECHO, !PROMPT or !SCREEN is seen on the display.

!SCROFF only works from within a macro or menu, and then only after !HOLD or !ONERR has been executed. If neither !HOLD or !ONERR are active , a warning message is displayed, and screen output continues to be seen as macro execution proceeds.

Screen output is re-established by means of the !SCRON command, the !NOHOLD command, or whenever the macro or menu terminates.

For nested menus, each menu maintains its own !SCRON/SCROFF status. The default on macro entry is !SCRON. The system file name is based on the database directory name ("XXXXXLOG.DAT"), or from the first value assigned to an environment variable called "ScreenLog".

An optional parameter @CLEAR is also available. This is used to control the action to clear the logfile. If @CLEAR=2 or 3 the log file is cleared.  If it is set to any other value it is not cleared.