/*****************************************************************************
*                                                                            *
*   VIEWHISTORY.SPL  Copyright (C) 2023 DSP Development Corporation          *
*                               All Rights Reserved                          *
*                                                                            *
*   Author:      Randy Race                                                  *
*                                                                            *
*   Synopsis:    Displays user history file                                           *
*                                                                            *
*   Revisions:   27 Jun 2023  RRR  Creation                                  *
*                                                                            *
*****************************************************************************/


#if @HELP_VIEWHISTORY

    VIEWHISTORY

    Purpose:
             Displays the user history file.

    Format:
             VIEWHISTORY("histfile")

              "histfile" - Optional. A string, the name of the history file
                           to view. Defaults to current history file.

    Returns:
             Nothing, the history file is displayed.

    Example:
             setconfig("history_logging", 1);

             W1: rand(10);
             W2: integ(w1)

             viewhistory

             History logging is enabled for the session. The current
             contents of the history file is displayed.

    Remarks:
             The history file contains user input text only, no informational
             or error messages are saved.

             VIEWHISTORY requires that history logging is enabled with the
             HISTORY_LOGGING configuration parameter.

             See VIEWLOG to display the log file that contains both user
             input and messages.

             See MONITOR to monitor messages in real time.

    See Also:
             Monitor
             Viewfile
             Viewlog
#endif


/* display hsitory file */
viewhistory(histfile)
{
        if (argc < 1)
        {
                histfile = getconf("history_logname");
        }

        viewfile(histfile);
}