Reflection .NET API
Attachmate.Reflection Assembly / Attachmate.Reflection.Productivity Namespace / IScreenHistory Interface / OpenScreenHistoryFile Method
The name of the file to load screen history from.
If true, clears current contents first before loading from file. If false, file contents are appended to screen list.


In This Topic
    OpenScreenHistoryFile Method
    In This Topic
    Loads a screen history file into the session document.
    Syntax
    'Declaration
     
    
    Function OpenScreenHistoryFile( _
       ByVal path As String, _
       ByVal overwrite As Boolean _
    ) As ReturnCode
    'Usage
     
    
    Dim instance As IScreenHistory
    Dim path As String
    Dim overwrite As Boolean
    Dim value As ReturnCode
     
    value = instance.OpenScreenHistoryFile(path, overwrite)
    ReturnCode OpenScreenHistoryFile( 
       string path,
       bool overwrite
    )

    Parameters

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

    Return Value

    ReturnCode.Success if the load succeeds, ReturnCode.Error if it failed.
    See Also