Enable Logging to File

This Subprogram enables logging such that all subsequent Input will be saved in the specified file.

Short Name Calling Sequence

STATUS = UIENLG(FILNAM[,OLDLOG])

Long Name Calling Sequence

STATUS = UI_ENABLE_LOG(...)

Input Arguments

FILNAM (Character) File Name

Output Arguments

OLDLOG (Logical) Old Log Mode (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__OPEN_OUTPUT ) Unable to open File UICOFI

Note:

1. This call will be ignored if Logging is already enabled.
2. Logging may be disabled by a later call to UI_DISABLE_LOG.
3. A failure to open the specified Log File will give to rise to Function Value UI__OPEN_OUTPUT. This is treated as a User Interaction Error and causes the Command File Stack to be unwound and further input to be taken from the keyboard.
4. On a VAX, the file type defaults to ``.UIL" if it isn't explicitly specified within FILNAM, and the file defaults to ``UIPACK.UIL" if FILNAM is null (all spaces).
5. The OLDLOG Argument is optional and, if present, will be set to the old Logging Enabled Status (.TRUE. or .FALSE.) prior to this call.
6. UI_ATTACH_LOG and UI_ENABLE_LOG are alternatives whereby Logging may be established.