Reflection Desktop VBA Guide
Attachmate.Reflection.Objects Library / Attachmate.Reflection.Objects.Productivity Library / ScreenHistory Object / OpenScreenHistoryFile Method
The name of the file to load screen history from.
If true, clears current contents first before loading from the file. If false, file contents are appended to the screen list.
Example
In This Topic
OpenScreenHistoryFile Method
In This Topic
Loads a screen history file into the session document.
Syntax
expression.OpenScreenHistoryFile( _
   ByVal path As String, _
   ByVal overwrite As Boolean _
) As ReturnCode
where expression is a variable that represents a ScreenHistory Object

Parameters

path
The name of the file to load screen history from.
overwrite
If true, clears current contents first before loading from the file. If false, file contents are appended to the screen list.

Return Value

One of the following ReturnCode values:
Member Description
Cancelled Cancelled.
Error Error.
PermissionRequired Permission is required.
Success Success.
Timeout Timeout condition.
Truncated The text is truncated.
Example
This example opens a screen history file and shows the last screen in the screen history.
Sub OpenScreenHistoryAndShowLastScreen()
    Dim rcode As ReturnCode
    Dim lastScreen As Integer
    
    Dim path As String
    path = Environ("USERPROFILE") & "\Documents\Micro Focus\Reflection\test.rshx"
    
    Dim history As ScreenHistory
    Set history = ThisIbmTerminal.Productivity.ScreenHistory
 
    'Clear the screen history and wait for the screens to clear
    history.ClearAllScreens
    ThisIbmScreen.Wait (2000)
    
    'Open the screen history panel
    history.ScreenHistoryPanelVisible = True
    
    'Open a screen history file
    history.OpenScreenHistoryFile path, True
        
    'Show the last screen in the list
    lastScreen = history.Index
    history.ShowScreen lastScreen
    
End Sub
See Also