SET LOGFILE

Authorization

General User

Purpose

Use the SET LOGFILE command to control whether a log file is updated with data written to a virtual screen.

Operands

vname

is the name of the virtual screen.

ON

begins logging for the specified virtual screen.

OFF

discontinues logging for the specified virtual screen.

fn

is the file name of the file to which data is logged. The default file name is the name of the virtual screen.

LOGFILE

is the file type of the file to which data is logged.

fm

is the file mode of the file. The default is *, which is the first read/write disk or directory in the search order containing the specified file. For more information, see Usage Notes.

Initial Setting

LOGFILE OFF

Usage Notes

1. When the NOTYPE option is in effect for a specified virtual screen, data in the queue is not written to the virtual screen. However, the data is logged to a CMS file if logging was requested.
2. If the CMS file already exists, the data written to the virtual screen is appended to the existing CMS file. If the specified file does not exist, the file is created on the disk or directory accessed as A and the lines are inserted.
3. If you issue:

   SET LOGFILE vname ON

   and do not specify a file name, file type or a file mode, the current values from previous settings for the log file ID are used.
4. To specify the file mode, you must also specify fn and LOGFILE.
5. For each full-screen session, the following line is added to the file when the first message or warning is logged:

   **** Logging started for virtual screen vname
        on mm/dd/yr at hh:mm:ss

6. If you issue HX while using full-screen CMS, data is not logged in a LOGFILE for the command or program that is executing.
7. Logging occurs when the output text is moved from the queue to the virtual screen data buffer. This occurs when:
   • VSCREEN WAITREAD or VSCREEN WAITT has been issued for the particular virtual screen that has output data queued.
   • PSCREEN REFRESH has been issued.
   • A limit has been reached for the number of lines queued.
   For example, consider this scenario:
   1. Logging is in effect when a program writes three lines to a virtual screen.
   2. However, logging is set off for that particular virtual screen before the program exits.
   3. Therefore, you may not see the data logged in the log file. If the program had issued VSCREEN WAITREAD, VSCREEN WAITT, or PSCREEN REFRESH before exiting, then the data would have been moved from the queue to the virtual screen data buffer.

Messages and Return Codes

• DMS109S Virtual storage capacity exceeded [RC=104]
• DMS639E Error in NUCXLOAD routine; return code was nnn [RC=24]
• DMS921E Virtual screen vname is not defined [RC=28]
• DMS928E Command is not valid for virtual screen vname [RC=12]

Additional system messages may be issued by this command. The reasons for these messages and their location are: