Rocket® InfoConnect Desktop (formerly a product of Micro Focus or formerly a product of Open Text) documentation, created before Rocket Software acquired certain products from OpenText, may include outdated references to "Micro Focus" or "OpenText", both of which are trademarks of OpenText or its affiliates. Rocket Software is not affiliated with Micro Focus or OpenText and has since rebranded these products as Rocket® products. You may also encounter outdated links in this documentation. If you do, please contact Rocket Support (support@rocketsoftware.com) for assistance.
Terminal Object Members
In This Topic
The following tables list the members exposed by Terminal.
Public Properties
| Name | Description | |
|---|---|---|
 |
AllowColorTableChanges | Gets or sets whether InfoConnect responds to host commands that are related to color table changes. |
|
AllowJIS | Gets or sets whether JIS escape sequences are allowed when other host character sets are selected. |
|
AnswerBack | Gets or sets a string that is sent to the host when InfoConnect receives an Enq character from the host. |
|
AutoAnswerback | Gets or sets whether the answerback message (set with the AnswerBack property) is automatically sent to the host after a communications line connection. |
|
AutoConnect | Gets or sets a value that specifes whether to attempt a host connection as soon as the current settings file is loaded. |
|
BeforeConnectStartupAction | Gets or sets a sequence of action(s), such as running a macro, to run automatically before a connection is established. |
|
BellEnabled | Gets or sets whether a bell sounds when the ASCII bell character (decimal 7) is transmitted from the keyboard or received from the host. |
|
BlockTerminator | Gets or sets a block terminator character to be transmitted at the end of each block data transmission. |
|
CacheSecureShellUserName | Gets or sets whether InfoConnect caches the user name entered for a Secure Shell session. |
|
CharacterSetTranslationEnabled | Gets or sets the character set translation state. |
|
CitrixIPAddress | Gets the IP address for a connection to a Citrix host. |
|
CitrixPCName | Gets the PC name returned by a Citrix host. |
|
CitrixUserName | Gets the Username value for a Citrix connection type. |
|
ClearDisplayOnDisconnect | Gets or sets how InfoConnect handles the display memory when you disconnect from the host. |
|
CodePage | Gets the current DOS code page. |
|
ConnectAction | Gets or sets a sequence of action(s), such as running a macro, to run automatically after a connection is established. |
|
ConnectingSettingsBestNetwork | Gets the _ConnectingSettingsBestNetwork object. |
|
ConnectionError | Gets the error number that describes the specific cause of the most recent general connection failure (if the last returned error has the value ErrConnectionError). |
|
ConnectionErrorMessage | Gets the text string that describes the specific cause of the most recent general connection failure (if the last returned error has the value ErrConnectionError). |
|
ConnectionID | Gets the Long value that uniquely identifies the current connection. |
|
ConnectionSettingsComSerialPort | Gets the _ConnectionSettingsComSerialPort object. |
|
ConnectionSettingsModem | Gets the _ConnectionSettingsModem object. |
|
ConnectionSettingsRLogin | Gets the _ConnectionSettingsRLogin object. |
|
ConnectionSettingsSecureShell | Gets the _ConnectionSettingsSecureShell object. |
|
ConnectionSettingsTelnet | Gets the _ConnectionSettingsTelnet object. |
|
ConnectionSettingsVTMgr | Gets the _ConnectionSettingsVTMgr object. |
|
ConnectionTimeVisible | Gets or sets whether the InfoConnect status bar displays the amount of time you are connected to a host. |
|
ConnectionType | Gets or sets the connection type. |
|
ContextMenus | Gets the ContextMenus object. |
|
DASOApplicationID | Retrieves or assigns the application ID to use for DASO (Digital Certificate Access Server Automated Sign On) support. |
|
DASOPassTicket | Retrieves 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. |
|
DASOSessionName | Retrieves 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. |
|
DASOUserID | Retrieves 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. |
|
DataStreamTranslation | Gets or sets whether InfoConnect translates characters from the host to the PC, and vice versa, using the current translation table. |
|
DefaultHostSettings | Gets or sets whether InfoConnect uses default settings appropriate to a UNIX or OpenVMS host. |
|
DefaultPrinter | Gets or sets the default printer for printer output. |
|
DeviceResponse | Gets or sets how InfoConnect responds to a primary device attribute request from the host (usually when logging on). |
|
ElfAtochemEmulation | Gets or sets whether Elf Autochem terminal emulation is enabled. |
|
EnquireAcknowledge | Gets or sets whether InfoConnect uses a form of handshaking called Enquire Acknowledge. |
|
EnterKeyConnects | Gets or sets how InfoConnect responds if the ENTER key is pressed when not connected to a host. |
|
FileTransfer | Gets the FileTransfer object. |
|
ForceC1Controls | Gets or sets whether InfoConnect interprets characters from certain host character sets as control codes. |
|
GraphicsDestination | Gets or sets the destination of graphics when you print using the ReGIS hard copy command. |
|
GraphicsFixScreen | Gets or sets whether the onscreen graphic is periodically updated from the offscreen graphic. |
|
GraphicsLevel | Use 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. |
|
GraphicsOutputCursor | Gets or sets whether the graphics output cursor is displayed. |
|
GraphicsPrintMode | Gets or sets how graphics print. |
|
GraphicsScrolling | Gets or sets whether sixel images are scrolled. |
|
GraphicsTerminalType | Gets or sets which terminal is emulated, and how many shades or colors are available in ReGIS. |
|
HorizontalCoupling | Gets or sets 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. |
|
HorizontalScrollBarVisible | Gets or sets whether the horizontal scroll bar is visible. |
|
HostCharacterSet | Gets or sets the host character set InfoConnect uses when transmitting and receiving characters. |
|
HostDescriptionFileName | Gets or sets the name and location of the host description file that is used by the GetHostElement method. |
|
HostsFile | Gets 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. |
|
HostStatusLine | Gets or sets the current host status line display. |
|
HostTriggerCharacter | Gets or sets the host trigger character value. |
|
IsConnected | Gets the value that indicates whether InfoConnect is connected. |
|
IsDataCarrierHigh | Gets whether the data carrier signal is high. |
|
IsGraphicsSupported | Gets a "graphics supported" flag. |
|
IsWinMASSSupported | Gets or sets whether WinMASS software support is enabled. |
|
KeyboardMapper | Gets the KeyboardMapper object. |
|
LocalEcho | Gets or sets whether the local computer should "echo" typed characters directly to the screen. |
|
LogToSerialDevice | Gets or sets whether data logged by the terminal is sent to the currently configured serial device. |
|
Macro | Gets the Macro object. |
|
MacrographReportsEnabled | Gets or sets whether macrograph reporting is enabled. |
|
MappedNumLockPreservesNumLock | Gets or sets how InfoConnect responds to a NUM LOCK key press on the PC after the key has been mapped to emulate the action of a terminal key. |
|
MouseMapper | Gets the MouseMapper object. |
|
MouseShape | Gets or sets the appearance of the mouse pointer in the terminal window. |
|
NationalReplacementSet | Gets or sets the set of character translations that occur between the local computer and the host in 7-bit mode. |
|
NRCEnabled | Gets or sets whether the translations specified by the NationalReplacementSet property should be performed. |
|
OnLine | Gets or sets whether InfoConnect is in remote mode or local mode. |
|
PreserveNRC | Gets or sets Digital terminals reset national replacement mode when a soft reset occurs. |
|
ProcessDataComm | Gets or sets whether InfoConnect processes incoming characters between calls to InfoConnect methods. |
|
ProcessInvalidKeystrokes | Gets or sets how InfoConnect handles invalid keystrokes. |
|
Productivity | Gets the Productivity object. |
|
QuickPadsShowToolTips | Gets or sets a value indicating whether QuickPad controls display tooltips. |
|
ReGISAlwaysGraphicsMode | Gets or sets ReGIS Graphics mode. |
|
ReGISBufferSize | Gets or sets the size of the buffer reserved for caching ReGIS graphics. |
|
ReGISV6 | Gets or sets how ReGIS graphics images are handled. |
|
RunMacroAtReconnect | Gets or sets a value indicating whether the ConnectAction sequence is re-run after a session is reconnected. |
|
SaveScrollingRegion | Gets or sets a save state for the scrolling region. |
|
SaveSecureShellUserName | Gets or sets whether InfoConnect saves the user name when you save your settings files or record a connection macro. |
|
SaveSessionOnClose | Gets or sets the close option, which indicates how to handle the save action when closing the control. |
|
Screen | Gets the Screen object. |
|
SendKeyboardModifierPrefix | Gets or sets 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. |
|
SerialDevicePort | Gets or sets the serial port on the PC that is used as the terminal serial device port. |
|
SerialDeviceSettings | Gets or sets the configuration parameters for the currently configured serial printer port. |
|
SerialDeviceToHost | Gets or sets whether data received from the currently configured serial device port is sent to the host. |
|
SessionFilePath |
Gets the session file path. |
|
SessionLimitsNSVT | Gets or sets the maximum allowable number of simultaneous VT-MGR sessions. |
|
SessionLimitsRlogin | Gets or sets the maximum allowable number of simultaneous Rlogin sessions. |
|
SessionLimitsSecureShell | Gets or sets the maximum allowable number of simultaneous SecureShell sessions. |
|
SessionLimitsTelnet | Gets or sets the maximum allowable number of simultaneous Telnet sessions. |
|
ShowClassicStatusBar | Gets 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. |
|
ShowMenuBar | Gets 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. |
|
SingleByteUPSS | Gets or sets which Digital UPS character set is used when SET HOST-CHARACTER-SET is set to a double-byte character set. |
|
StartupConnection | Gets or sets the saved connection that is used when the StartupAction property is set to UseSavedConnection. |
|
StatusBarText | Gets or sets the text displayed on the status bar. |
|
StatusLineText | Gets or sets the current status line text. |
|
TAPIVersion | Gets or sets the Telephony Application Programming Interface (TAPI) that InfoConnect uses to connect the PC to telephone services. |
|
TerminalSound | Gets or sets how beeps sound. |
|
TerminalType | Gets or sets the terminal that InfoConnect is to emulate. |
|
TextFileCharacterSet | Gets or sets whether InfoConnect uses the ASCII or ANSI character set. |
|
Theme | Gets the Theme object. |
|
TimeSinceConnected | Gets the time (in seconds) during which you have been connected. |
|
TitleBarCaption | Gets 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. |
|
TraceFileName | Gets or sets the name of the trace file that is created when Trace Session Start is true. |
|
TraceFolder | Gets or sets the location of the folder where InfoConnect saves trace files created when Trace Session Start is true. |
|
TraceSessionStart | Gets or sets the InfoConnect Trace utility to begin tracing the moment InfoConnect starts. |
|
UiControlActionMapper | Gets the object used to map actions to the user interface control and to retrieve the action sequence from the user interface control. |
|
UseIPv6 | Gets or sets how InfoConnect communicates with a host using the IPv6 and older IPv4 protocols. |
|
UseModemDialerV5 | Gets or sets the modem dialer that is used to make modem connections. |
|
UserData | Gets or sets data for the duration of the current InfoConnect session. |
|
UserDefinedKeysLocked | Gets or sets whether the host can alter the definitions of the user-defined keys. |
|
UserFeaturesLocked | Gets or sets whether certain features can be changed by the host. |
|
VBCommonProject | VB common project from VBA |
|
VBProject | VB project from VBA |
|
Version | Gets the version of the terminal session control. |
|
VerticalScrollBarVisible | Gets or sets whether the vertical scroll bar is visible. |
|
VT640Compatible | Gets or sets whether InfoConnect switches back and forth automatically between Tektronix and VT terminal emulation when it receives VT640-compatible control characters from the host. |
|
VTTek | Gets or sets the VT340 Tektronix state. |
|
WeakDeviceControlString | Gets or sets the device control string state. |
|
WindowRows | Gets or sets the number of lines displayed on screen. |
|
WTSIPAddress | Gets the IP address returned by Windows Terminal Server (WTS). |
|
WTSPCName | Gets the PC name returned by Windows Terminal Server (WTS). |
|
WTSUserName | Gets the user name returned by Windows Terminal Server (WTS). |
|
WyseAcceptNulls | Gets or sets whether the terminal will accept nulls from the host (for Wyse terminal emulation only). |
Public Methods
| Name | Description | |
|---|---|---|
 |
AddVBAReference | Adds 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. |
|
Close | Closes the terminal session with the close option. |
|
CloseAllConnections | Closes all connections established by the current instance of the emulator. |
|
Connect | Connects to the host. It is ignored if a connection already exists. |
|
Dial | Dials a modem. This method is only valid if InfoConnect is set to use the old modem dialer (UseModemDialerV5 = true). |
|
Dial2 | Dials a modem. This method is only valid if InfoConnect is set to use the old modem dialer (UseModemDialerV5 = true). |
|
Disconnect | Disconnects from the host. If no connection currently exists, this method is ignored. |
|
Execute | Execute a given action. Actions possible is defined in InputMapActionID. |
|
GetDASOPassTicket | Issues 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. |
|
GetSerialConnectionStatistics | Returns a statistic for a serial connection. |
|
GetVBAReferences | Retrieves 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. |
|
HangUp | Hangs up the modem by sending the Hayes "+++" command to get the modem's attention, followed by the "ATH" hangup command. |
|
OpenSettings | Opens a setting file. |
|
ProcessTrace | Process a trace file created by StartTrace()/StopTrace(). |
|
RemoveVBAReference |
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. |
|
ResetTerminal | Executes a terminal reset. |
|
RestoreDefault | Restores the session settings to the default settings, as specified by the restore option value. |
|
ResumeConnection | Resumes a previously suspended connection (suspend connections with the SuspendConnection method). |
|
Save | This method saves all settings. |
|
SaveAs | Saves all settings to the specified file. |
|
SaveAsCompound | Saves a session as a compound session document. |
|
StartLogging | Start logging terminal activity. |
|
StartTrace | Starts capturing data coming from the host to a disk file. |
|
StopLogging | Stop logging terminal activity. |
|
StopTrace | Stops capturing incoming host data to a file and closes the trace file. |
|
SuspendCurrentConnection | Suspends the current host connection (so that it can be resumed later with ResumeConnection). |
|
WaitForCall | Initializes the modem to automatically answer an incoming call and opens a status dialog box until a connection has been established. |
|
WaitForCall2 | Initializes the modem to automatically answer an incoming call and opens a status dialog box until a connection has been established. |
|
WaitForCall3 | Initializes the modem to automatically answer an incoming call and opens a status dialog box until a connection has been established. |
Public Events
| Name | Description | |
|---|---|---|
 |
Closed | This event occurs before the session closes. |
|
Closing | This event occurs when the request to close the session has been made. |
|
Connected | The event occurs after the connection to the host has been made. |
|
Connecting | This event is triggered immediately before a connection is made. |
|
ConnectionResumed | This event is triggered when the suspended connection to the host has been resumed. |
|
ConnectionSuspended | This event is triggered when the connection to the host has been suspended. |
|
CreditCardRecognized |
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 "Logging Credit Card Access" in the InfoConnect VBA Guide. |
|
Disconnected | The event occurs after the connection to the host has been disconnected. |
|
SettingsLoaded | This event is triggered immediately after a settings file is opened. |
|
SettingsLoading | This event is triggered immediately before a settings file is opened. |
|
UserDisconnecting | This event is triggered before InfoConnect disconnects from the host. |
See Also