History-related properties of the HostOptions object

Applies To Objects

Description

The properties in this group specify values for history buffer operations.

If you want to retain History from the current session to use in a future session, select Retain History and specify a file name in which to store the history information. When you start the session again, existing history is restored to the history buffer.

They are equivalent to the options on the page Settings, Display, History.

Syntax

Unless noted, all history-related properties have the following syntax:

object.Property

Element	Description
Object	The HostOptions object.
Property	A history-related property.

Names and Descriptions of individual properties

HistoryEnable Property

Returns or sets whether to store information scrolled off the screen. Set this property TRUE to store information no longer displayed on the screen in the history buffer.

HistoryFile Property

Returns or sets the name of the file in which to store history. Although you can store history in memory without specifying a file name, you cannot retain the history between sessions unless you specify a file name. See also the HistoryRetain property.

HistoryMaxSize Property

Returns or sets the maximum size of history buffer. Use a constant or value from the following table.

Constant	Value
xUNLIMITED	0
x16K	1
x32K	2
x64K	3
x128K	4
x256K	5
x512K	6
x1024K	7

HistoryRetain Property

Returns or sets whether retain data stored in the history buffer when you exit. If you retain the history, it is available for use in future sessions. Use the HistoryFile property to specify where history is to be saved.

HistoryScrollingRegion Property

Returns or sets what sort of data is saved in the history buffer. If TRUE, all data scrolled off or cleared from the screen is saved in the history buffer. If FALSE, only data scrolled from the top line of the page is saved.