GetHistoryScreenImage Method

The zero-based index of the history screen to capture. This must be a value between 0 and Count-1.
Returns a history screen as an image.
Function GetHistoryScreenImage( _
   ByVal index As Integer _
) As Byte()
Dim instance As IScreenHistory
Dim index As Integer
Dim value() As Byte
value = instance.GetHistoryScreenImage(index)
byte[] GetHistoryScreenImage( 
   int index


The zero-based index of the history screen to capture. This must be a value between 0 and Count-1.

Return Value

An image of the specified history screen.
System.ArgumentOutOfRangeException This exception is thrown if the index does not correspond to a valid screen index in the current Screen History list.
Returned images are subject to currently configured privacy filters. The returned image can be used in conjunction with the Productivity.OfficeTools CreateWordProcessingDocumentWithGraphicSet method if the installed Office Suite and Office Tools adapter assembly support the use of graphics in word-processing documents.
This sample uses GetHistoryScreenImage to save the screens in the Screen History list as images in a Word document before the session is disconnected.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Attachmate.Reflection.UserInterface;
using Attachmate.Reflection.Productivity;
using Attachmate.Reflection.Emulation.IbmHosts;
using Attachmate.Reflection.Framework;
using System.Drawing;
using System.Drawing.Imaging;
using System.IO;
using Word = Microsoft.Office.Interop.Word; 

namespace ScreenHistory
    class Program

        static void terminal_BeforeDisconnect(object sender, EventArgs e)
            IIbmTerminal terminal = (IIbmTerminal)sender;

            IScreenHistory history = terminal.Productivity.ScreenHistory;

            //Delete the first screen from the history

            List<Image> screenImages = new List<Image>();

            for (int i = 0; i < history.Count; i++)
                byte[] screenImage = history.GetHistoryScreenImage(i);

                MemoryStream memstr = new MemoryStream(screenImage);
                Image image = Image.FromStream(memstr);


            IOfficeTools tools = terminal.Productivity.OfficeTools;

            tools.CreateWordProcessingDocumentWithGraphicSet(screenImages, null, null);

            Word.Application word = (Word.Application)System.Runtime.InteropServices.Marshal.GetActiveObject("Word.Application");

            string screenLog = Environment.UserName + DateTime.Now.ToString("yyyyMMddHHmmssfff");
            word.ActiveDocument.SaveAs(Environment.GetEnvironmentVariable("USERPROFILE") + @"\Documents\" + screenLog);

            history.SaveScreenHistoryFile(Environment.GetEnvironmentVariable("USERPROFILE") + @"\Documents\Micro Focus\Reflection\myScreens.rshx", true);

        static void Main(string[] args)
            //Start a visible instance of Reflection or get the instance running at the given channel name
            Application app = MyReflection.CreateApplication("myWorkspace", true);

            //Create a terminal from the session document file
            string sessionPath = Environment.GetEnvironmentVariable("USERPROFILE") + @"\Documents\Micro Focus\Reflection\demoSession.rd3x";
            IIbmTerminal terminal = (IIbmTerminal)app.CreateControl(sessionPath);

            //Make the session visible in the workspace
            IFrame frame = (IFrame)app.GetObject("Frame");

            IScreenHistory history = terminal.Productivity.ScreenHistory;

            history.ManualCaptureOnly = false;


            history.ScreenHistoryPanelVisible = true;

            history.NumberOfScreensToRemember = 25;

            history.ClearHistoryOnDisconnect = false;

            terminal.BeforeDisconnect += terminal_BeforeDisconnect;



See Also