General
Application area: | Starting, interrupting and terminating; see "Starting, interrupting and terminating" |
Macro type: | Type S, MF format 1: |
Macro description
The LGOFF macro allows the user to issue the EXIT-JOB command via the macro interface of the macro command language processor (MCLP) without interrupting program mode (see section “Macro Command Language Processor macros” (Standard header)). Messages concerning command processing are issued on SYSOUT.
The user ends a job with the EXIT-JOB command. Thereupon, the operating system deallocates the virtual memory pages and devices used by the job and prepares the output system files for output on printer or tape. If, during job execution, new file generations have been created, the system updates the base value of the file generation group (see the DMS manuals [7 (Related publications)] and [8 (Related publications)]). The name of the relevant file generation group, the first and the current generation and the base value are output in a message on SYSOUT.
Macro format and description of operands
LGOFF |
[ { 'BUT[,TAPE]' / 'TAPE[,BUT]' / 'BUT[,NOSPOOL]' / 'NOSPOOL[,BUT]'} ] [,MF=C / D / L / (E,..)] |
BUT=
This operand applies only to interactive users and is ignored in batch mode. It enables users to specify that they wish to start a new job after termination of the current one and that the connection to the server should therefore not be cleared down. If the BUT operand is omitted, a connection cleardown will be initiated.
TAPE=
This operand causes the system files to be spooled out to tape rather than to the printer. The SYSLST and/or SYSOUT files are written to a file on the same tape named
“TAPE.TSNnnnn”, where nnnn is the TSN of the job to br terminated.
The SYSOPT file is written to a separate tape and is also given the file name
“TAPE.TSNnnnn”, where nnnn is a new TSN of which the user is informed via the SYSOUT file.
NOSPOOL=
This operand prevents the system files SYSLST and SYSOUT (for
LOGGING=PARAMETERS (LISTING=YES) in the SET-LOGON-PARAMETERS or MODIFY-JOB-OPTIONS commands) and SYSOPT from being output on the printer.
MF=
For a general description of the MF operand, its operand values and any subsequent operands (e.g. for a prefix), see "S-type macros". The valid MF values are given at the start of the macro description under “Macro type” and are included in the macro format.
Notes on the macro call
The command operands must be enclosed in single quotes.
An STXIT routine defined in the calling program for the “program termination” event class will be activated.
Monitoring job variables (program and job) are set to '$T'.
Return information and error flags
R15:
+---------------+ | | | | | | | | | | | |a|a| +---------------+
A return code relating to the execution of the LGOFF macro is transferred in the rightmost byte of register R15.
X'aa' | Meaning |
X'00' | Normal termination. |
X'04' | The request has not been processed, due to insufficient memory space. |
X'08' | Error in the operand list (address area). |
X'0C' | The last output record entered in the user area has been truncated. |
X'10' | Macro/command error (the command returned an error to MCLP). |
Example
LGOFF START
PRINT NOGEN
BALR 3,0
USING *,3
LGOFF 'NOSPOOL,BUT'
TERM
END
Runtime log:
/start-assembh % BLS0500 PROGRAM 'ASSEMBH', VERSION '<ver>' OF '<date>' LOADED % ASS6010 <ver> OF BS2000 ASSEMBH READY //compile source=*library-element(macexmp.lib,lgoff), - // compiler-action=module-generation(module-format=llm), - // module-library=macexmp.lib, - // listing=parameters(output=*library-element(macexmp.lib,lgoff)) % ASS6011 ASSEMBLY TIME: 408 MSEC % ASS6018 0 FLAGS, 0 PRIVILEGED FLAGS, 0 MNOTES % ASS6019 HIGHEST ERROR-WEIGHT: NO ERRORS % ASS6006 LISTING GENERATOR TIME: 77 MSEC //end % ASS6012 END OF ASSEMBH /start-executable-program library=macexmp.lib,element-or-symbol=lgoff % BLS0523 ELEMENT 'LGOFF', VERSION '@' FROM LIBRARY ':2OSG:$QM212.MACEXMP.LIB' IN PROCESS % BLS0524 LLM 'LGOFF', VERSION ' ' OF '<date> <time>' LOADED /LOGOFF NOSPOOL,BUT % EXC0419 /LOGOFF AT 1505 ON <date> FOR TSN '52IS' % EXC0421 CPU TIME USED: 1.5734 % JMS0150 INSTALLATION ' S200-40', BS2000 VERSION 'V190', HOST 'D016ZE04': PLEASE ENTER '/SET-LOGON-PARAMETERS' OR '?'
The output of system files was suppressed. The connection to the server is retained. A new SET-LOGON-PARAMETERS command may be entered immediately (see also the “Commands” manual [19 (Related publications)], EXIT-JOB command).