InfoConnect API Guide
Attachmate.Reflection.Emulation.OpenSystems Namespace / ITerminal Interface
Properties Methods Events

In This Topic
    ITerminal Interface Members
    In This Topic

    The following tables list the members exposed by ITerminal.

    Public Properties
     NameDescription
     PropertyGets or sets a value indicating whether InfoConnect responds to host commands that are related to color table changes.  
     PropertyGets or sets a value indicating whether JIS escape sequences are allowed when other host character sets are selected.  
     PropertyGets or sets a string that is sent to the host when InfoConnect receives an Enq character from the host.  
     PropertyGets or sets a value indicating whether the answerback message (set with the AnswerBack property) is automatically sent to the host after a communications line connection.  
     PropertyGets or sets a value indicating whether to attempt to establish a host connection as soon as the current settings file is loaded.  
     PropertyGets or sets a sequence of action(s), such as running a macro, to run automatically before a connection is established.  
     PropertyGets or sets a value indicating whether a bell sounds when the ASCII bell character (decimal 7) is transmitted from the keyboard or received from the host.  
     PropertyGets or sets a block terminator character to be transmitted at the end of each block data transmission.  
     Property

    Gets or sets a value indicating whether InfoConnect caches the user name entered for a Secure Shell session.

     
     PropertyGets or sets a value indicating whether the character set translation state is enabled.  
     PropertyGets the IP address for a connection to a Citrix host.  
     PropertyGets the PC name returned by a Citrix host.  
     PropertyGets the Username value for a Citrix connection type.  
     PropertyGets or sets a value indicating how InfoConnect handles the display memory when you disconnect from the host.  
     PropertyGets the current DOS code page.  
     PropertyGets or sets a sequence of action(s), such as running a macro, to run automatically after a connection is established.  
     PropertyGets the error number that describes the specific cause of the most recent general connection failure (only when the last returned error has the value ErrConnectionError).  
     PropertyGets the text string that describes the specific cause of the most recent general connection failure (only when the last returned error has the value ErrConnectionError).  
     PropertyGets the integer value that uniquely identifies the current connection.  
     PropertyGets the IConnectionSettings object.  
     PropertyGets or sets a value indicating whether the InfoConnect status bar displays the length of time you have been connected to a host.  
     PropertyGets or sets the connection type.  
     PropertyGets the ContextMenus object.  
     PropertyGets or sets the application ID to use for DASO (Digital Certificate Access Server Automated Sign On) support.  
     PropertyGets the pass ticket for DASO (Digital Certificate Access Server Automated Sign On). This field will be empty until a successful call to GetDASOPassTicket is executed.  
     PropertyGets the session name that is used for DASO (Digital Certificate Access Server Automated Sign On). The session name and DASO application ID are used by the DASO server when mapping the current user to RACF logon credentials for host access.  
     PropertyGets the RACF USERID for DASO (Digital Certificate Access Server Automated Sign On). This field will be empty until a successful call to GetDASOPassTicket is executed.  
     PropertyGets or sets whether InfoConnect translates characters from the host to the PC, and vice versa, using the current translation table.  
     PropertyGets or sets whether InfoConnect uses default settings appropriate to a UNIX or OpenVMS host.  
     PropertyGets or sets the default printer to which InfoConnect sends printer output.  
     PropertyGets or sets how InfoConnect responds to a primary device attribute request from the host (usually when logging on).  
     PropertyGets or sets a value indicating whether Elf Autochem terminal emulation is enabled.  
     PropertyGets or sets a value indicating whether InfoConnect uses a form of handshaking called Enquire Acknowledge (EnqAck).  
     PropertyGets or sets a value indicating how InfoConnect responds if the ENTER key is pressed when not connected to a host.  
     PropertyGets the FileTransfer object.  
     PropertyGets or sets a value indicating whether InfoConnect interprets character codes in certain host character sets.  
     PropertyGets or sets the destination of graphics when you print using the ReGIS hard copy command.  
     PropertyGets or sets a value indicating whether the onscreen graphic is periodically updated from the offscreen graphic.  
     PropertyUse this property to match InfoConnect to the capabilities of a digital printer with regard to aspect ratio, horizontal grid size, background printing, and color printing.  
     PropertyGets or sets a value indicating whether the graphics output cursor is displayed.  
     PropertyGets or sets how graphics images are printed.  
     PropertyGets or sets a value indicating whether sixel images are scrolled.  
     PropertyGets ors sets which terminal is emulated, and how many shades or colors are available in ReGIS.  
     PropertyGets or sets a value indicating whether the column in which the cursor is located remains in the terminal window regardless of how the terminal window is resized, or which screen font size is used.  
     PropertyGets or sets a value indicating whether the horizontal scroll bar is visible.  
     PropertyGets or sets the host character set that InfoConnect uses when transmitting and receiving characters.  
     PropertyGets or sets the name and location of the host description file that is used by the GetHostElement method.  
     PropertyGets or sets the file path for the file that is used to populate the Host name/IP Address Drop-down list on the Create New VT Document dialog box.  
     PropertyGets or sets the current host status line display.  
     PropertyGets or sets the host trigger character value.  
     PropertyGets the instance ID of the control. (Inherited from Attachmate.Reflection.Framework.IControl)
     PropertyGets a value indicating whether InfoConnect is connected.  
     PropertyGets a value indicating whether the data carrier signal is high. Relevant only for serial connections.  
     PropertyGets a value indicating whether graphics is supported.  
     PropertyGets or sets a value indicating whether WinMASS software support is enabled.  
     PropertyGets the KeyboardMapper object.  
     PropertyGets or sets a value indicating whether the local computer "echoes" typed characters directly to the screen.  
     PropertyGets or sets a value indicating whether data logged by the terminal is sent to the currently configured serial device.  
     PropertyGets the Macro object.  
     PropertyGets or sets a value indicating whether macrograph reporting is enabled.  
     PropertyGets or sets how InfoConnect responds to a NUM LOCK key press on the PC when it is mapped to emulate the action of a terminal key.  
     PropertyGets the MouseMapper object.  
     PropertyGets or sets the appearance of the mouse pointer in the terminal window.  
     PropertyGets or sets the name of the control. (Inherited from Attachmate.Reflection.Framework.IControl)
     PropertyGets or sets the set of character translations that occur between the local computer and the host in 7-bit mode.  
     PropertyGets or sets a value indicating whether the translations specified by the NationalReplacementSet property are performed.  
     PropertyGets or sets a value indicating whether InfoConnect is in remote mode or local mode.  
     PropertyGets or sets a value indicating whether Digital terminals reset national replacement mode when a soft reset occurs.  
     PropertyGets or sets a value indicating whether InfoConnect processes incoming characters between calls to InfoConnect methods.  
     PropertyGets or sets how InfoConnect handles invalid keystrokes.  
     PropertyGets the Productivity object.  
     PropertyGets or sets a value indicating whether QuickPad controls display tooltips.  
     PropertyGets or sets ReGIS Graphics mode.  
     PropertyGets or sets the size of the buffer reserved for caching ReGIS graphics.  
     PropertyGets or sets how ReGIS graphics are handled.  
     PropertyGets or sets a value indicating whether the ConnectAction sequence is re-run after a session is reconnected.  
     PropertyGets or sets a save state for the scrolling region.  
     PropertyGets or sets whether InfoConnect saves the user name when you save your settings files or record a connection macro.  
     PropertyGets or sets a close option, which indicates how to handle the save action when closing the control.  
     PropertyGets the Screen object.  
     PropertyGets or sets a value indicating whether a SHIFT, CTRL, or ALT key press sends an escape sequence and, if the key is pressed in conjunction with other keys, prefixes the escape sequence to outbound data, in VT-UTF8 emulations.  
     PropertyGets or sets the serial port on the PC that is used as the terminal serial device port.  
     PropertyGets or sets the configuration parameters for the currently configured serial printer port.  
     PropertyGets or sets a value indicating whether data received from the currently configured serial device port is sent to the host.  
     PropertyGets the session document file path. (Control properties are saved in session document files.) (Inherited from Attachmate.Reflection.Framework.IControl)
     PropertyGets or sets the maximum allowable number of simultaneous VT-MGR sessions.  
     PropertyGets or sets the maximum allowable number of simultaneous Rlogin sessions.  
     PropertyGets or sets the maximum allowable number of simultaneous SecureShell sessions.  
     PropertyGets or sets the maximum allowable number of simultaneous Telnet sessions.  
     PropertyGets or sets the visibility of the status bar. This setting is only relevant when the workspace user interface mode is set to Classic. (This setting does not apply to Classic MDI mode.) The default is true.  
     PropertyGets or sets the visibility of the menu and toolbar. This setting is only relevant when the workspace user interface mode is set to Classic. (This setting does not apply to Classic MDI mode.) The default is true.  
     PropertyGets or sets which Digital UPS character set that is used when SET HOST-CHARACTER-SET is set to a double-byte character set.  
     PropertyGets or sets the saved connection that is used when the StartupAction property is set to UseSavedConnection.  
     PropertyGets or sets the text displayed on the status bar.  
     PropertyGets or sets the current status line text.  
     PropertyGets or sets the Telephony Application Programming Interface (TAPI) that InfoConnect uses to connect the PC to telephone services.  
     PropertyGets or sets how beeps sound.  
     PropertyGets or sets the terminal that InfoConnect is to emulate.  
     PropertyThis is an internal property used to determine the context of this terminal object usage. This is set to true if this terminal object is being used in a Terminal User Control context.  
     PropertyGets or sets whether InfoConnect uses the ASCII or ANSI character set.  
     PropertyGets the Theme object.  
     PropertyGets the time (in seconds) during which you have been connected.  
     PropertyGets or sets the string that appears in the title bar. This string is only relevant when the workspace user interface mode is set to Classic SDI. The caption length maximum value is 260 characters. The default is &f - &n  
     PropertyGets or sets a value indicating the name of the trace file that is created when Trace Session Start is true.  
     PropertyGets or sets the location of the folder where InfoConnect saves trace files that are created when Trace Session Start is true.  
     PropertyGets or sets a value indicating whether the InfoConnect Trace utility to begin tracing the moment InfoConnect starts.  
     PropertyGets the object used to map actions to the user interface control and to retrieve the action sequence from the user interface control.  
     PropertyGets or sets how InfoConnect communicates with a host using the IPv6 and older IPv4 protocols.  
     PropertyGets or sets which modem dialer is used to make modem connections.  
     PropertyGets or sets data for the duration of the current InfoConnect session.  
     PropertyGets or sets a value indicating whether the host can alter the definitions of the user-defined keys.  
     PropertyGets or sets a value indicating whether certain features can be changed by the host.  
     PropertyGets the Common VB Project (VBA use only)  
     PropertyGets the VB Project (VBA use only)  
     PropertyGets the version of the terminal session control.  
     PropertyGets or sets a value indicating whether the vertical scroll bar is visible.  
     PropertyGets or sets a value indicating whether InfoConnect switches back and forth automatically between Tektronix and VT terminal emulation when it receives VT640-compatible control characters from the host.  
     PropertyGets or sets VT340 Tektronix state.  
     PropertyGets or sets the device control string state.  
     PropertyGets or sets the number of lines displayed on screen.  
     PropertyGets the IP address returned by Windows Terminal Server (WTS).  
     PropertyGets the PC name returned by Windows Terminal Server (WTS).  
     PropertyGets the user name returned by Windows Terminal Server (WTS).  
     PropertyGets or sets a value indicating whether the terminal accepts nulls from the host(for Wyse terminal emulation only).  
    Top
    Public Methods
     NameDescription
     MethodAdds a reference to a session file that contains macros you want to share with the current session to the VBA References settings. After you add the reference, the macros in that file are available to the current session. When you save your session, the macros are saved in your current session document file and updated each time you reopen your session.  
     MethodCloses the terminal session with the close option.  
     MethodCloses all connections established by the current instance of the emulator.  
     MethodConnects to the host. It is ignored if a connection already exists.  
     MethodOverloaded. Dials a modem. This method is only valid if InfoConnect is set to use the old modem dialer (UseModemDialerV5 = true).  
     MethodDisconnects from the host. If no connection currently exists, this method is ignored.  
     MethodExecute a given action. Actions possible is defined in InputMapActionID.  
     MethodIssues a request to the Management and Security Server for a DASO pass ticket. On success, the DASOUserID and DASOPassTicket properties will be valid and can be used for automated sign on to the host. The application ID can be preset using the DASOApplicationID property in which case the ApplicationID parameter on this call may be empty.  
     MethodReturns a statistic for a serial connection.  
     MethodRetrieves a list of the session documents referenced by the current session from the VBA References settings. The macros in these session documents are available to the current session.  
     MethodHangs up the modem by sending the Hayes "+++" command to get the modem's attention, followed by the "ATH" hangup command.  
     MethodOpens a setting file.  
     MethodProcess a tracefile created by StartTrace()/StopTrace().  
     Method

    Removes a reference to a session document file from the VBA References settings. After you remove this file name, the macros in that file are no longer available in the current session. To make this change permanent, you'll need to save your session document file.

     
     MethodExecutes a terminal reset.  
     MethodRestores the session settings to the default settings as specified by the restore option value.  
     MethodResumes a previously suspended connection (suspend connections with the SuspendConnection method).  
     MethodSaves all settings.  
     MethodSaves all settings to the specified file.  
     MethodSaves a session as a compound session document.  
     MethodStart logging terminal activity.  
     MethodStarts capturing data coming from the host to a disk file.  
     MethodStop logging terminal activity.  
     MethodFor internal use. Used when a Terminal User Control is being shut down.  
     MethodStops capturing incoming host data to a file and closes the trace file.  
     MethodSuspends the current host connection (so that it can be resumed later with ResumeConnection).  
     MethodOverloaded. Initializes the modem to automatically answer an incoming call and opens a status dialog box until a connection is established.  
    Top
    Public Events
     NameDescription
     EventThis event occurs before the session closes.  
     EventThis event occurs when the request to close the session has been made.  
     EventThe event occurs after the connection to the host has been made.  
     EventThis event is triggered immediately before a connection is made.  
     EventThis event is triggered when the suspended connection to the host has been resumed.  
     EventThis event is triggered when the connection to the host has been suspended.  
     Event

    This event occurs when an unredacted Primary Account Number (PAN) is copied from the terminal (for example, when the PAN is copied to the clipboard).

    This event is enabled by configuring settings on the Setup Information Privacy dialog box. For more information, see "Monitor Credit Card Access" in the InfoConnect .NET API Guide.

     
     EventThe event occurs after the connection to the host has been disconnected.  
     EventThis event is triggered immediately after a settings file is opened.  
     EventThis event is triggered immediately before a settings file is opened.  
     EventThis event is triggered before InfoConnect disconnects from the host.  
    Top
    See Also