InfoConnect API Guide
Attachmate.Reflection.Emulation.IbmHosts Namespace / IIbmTerminal Interface
Properties Methods Events

In This Topic
    IIbmTerminal Interface Members
    In This Topic

    The following tables list the members exposed by IIbmTerminal.

    Public Properties
     NameDescription
    PropertyAidFieldExitGets or sets a value indicating whether to prevent or allow unrestricted sending of aid key values (F1-F24 only) to the host from restricted input fields.  
    PropertyAllowDBCSinSBCSField5250Gets or sets a value indicating whether double-byte character sets in single-byte character set fields are allowed.  
    PropertyAllowUnpairedSIGets or sets a value indicating whether to allow an unpaired shift in (SI) with a matching shift out (SO) sequence.  
    PropertyAplGets or sets a value indicating whether APL mode is on (true) or off (false).  
    PropertyAsyncTransportEnabledGets or sets a value indicating whether the terminal reverts to polling mode for host interactions.  
    PropertyAutoConnectGets or sets a value indicating whether to attempt to establish a host connection as soon as the current settings file is loaded.  
    PropertyAutoImeGets or sets a value indicating whether IME (Input Method Editor) turns on or off automatically as the cursor moves.  
    PropertyAutoReconnectGets or sets a value indicating whether to attempt to reconnect after a disconnection that is not initiated by the emulator.  
    PropertyAutoSignOnGets or sets a value indicating whether InfoConnect tells the transport protocol to automatically log you on to the host as soon as you establish a connection.  
    PropertyBDTIgnoreScrollLockGets or sets a value indicating whether the terminal ignores the scroll lock state.  
    PropertyBeforeConnectStartupActionGets or sets a sequence of action(s), such as running a macro, to run automatically before a connection is established.  
    PropertyBlinkRateGets or sets a value that specifies the blinking attribute for text that the host displays in the terminal window.  
    PropertyC370CharSetGets or sets a value indicating whether to use the C/370 code page, which provides support for square brackets ("[" and "]").  
    PropertyCegcGets or sets a value indicating whether additional characters (above character 128) in the configured National Character Set are available.  
    PropertyCmdPromptGets or sets the character or characters in the terminal window.  
    PropertyCmsFileListCommandGets or sets the file list command to issue on the CMS host to list files.  
    PropertyColumnSeparatorStyleGets or sets the character to use as the column separator in 5250 terminal sessions.  
    PropertyCommandLineEnabledGets or sets a value indicating whether the terminal command line can be activated (for example, with the Alt-L keystroke).  
    PropertyConnectActionGets or sets a sequence of action(s), such as running a macro, to run automatically after a connection is established.  
    PropertyConnectionErrorGets the error number that describes the cause of the most recent connection failure (when the last returned error has the value ErrConnectionError).  
    PropertyConnectionErrorMessageGets the text string that describes the cause of the most recent connection failure (when the last returned error has the value ErrConnectionError).  
    PropertyConnectMacro

    Gets or sets the name of a macro that is run automatically after a connection is established.

    Note: This property is deprecated. Please use the ConnectAction Property instead.

     
    PropertyConnectMacroData

    Gets or sets a string that passes information to a connect macro.

    Note: This property is deprecated. Please use the ConnectAction Property instead.

     
    PropertyConnectScriptGets or sets a Reflection Basic script that runs automatically after a connection is established.  
    PropertyConnectScriptArgumentsGets or sets a parameter string to be passed to the connect script after a connection is established.  
    PropertyContextMenusGets the ContextMenus object.  
    PropertyCursorMovementStyleGets or sets a value that specifies how the cursor moves between composed Thai characters.  
    PropertyCursorProgressionIndicatorGets or sets a value that specifies how the terminal responds to a host query to determine if the terminal supports End User Interface (EUI) enhancement.  
    PropertyCustomColumnsGets or sets the number of columns in the terminal window display when the terminal is configured to use the custom terminal model.  
    PropertyCustomRowsGets or sets the number of rows in the terminal window display when the terminal is configured to use the custom terminal model.  
    PropertyDASOApplicationIDRetrieves or assigns the application ID to use for DASO (Digital Certificate Access Server Automated Sign On) support.  
    PropertyDASOPassTicketRetrieves 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.  
    PropertyDASOSessionNameRetrieves 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.  
    PropertyDASOUserIDRetrieves 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.  
    PropertyDbcsUnmappedCharGets or sets a value that specifies how the terminal translates double-byte host characters that are not available in the Shift-JIS double-byte character translation table.  
    PropertyDbcsUserDefinedCharacterSourceGets or sets whether user-defined character fonts are located on the host (HostImages) or on the PC (PCEndUserDefinedImages).  
    PropertyDefaultPortsGets or sets a value indicating whether the terminal attempts to communicate with the host transaction programs using the default port numbers (as defined by IBM).  
    PropertyDeviceNameGets or sets the device to connect to.  
    PropertyDisableKeystrokeProductivityGets or sets a value indicating whether all keystroke Productivity functionality (such as Spell Check and Auto Complete) is disabled.  
    PropertyDisableScreenHistoryGets or sets a value indicating whether Screen History is disabled.  
    PropertyDisplayMarginsGets or sets a value indicating whether to display margins around the terminal window.  
    PropertyEnableHostAlarmGets or sets a value indicating whether to sound alarms (beeps) sent by the host. The default is true.  
    PropertyEnableTelnetEncryptionGets or sets a value indicating whether InfoConnect uses Secure Sockets Layer/Transport Layer Security (SSL/TLS) datastream encryption.  
    PropertyEnableTelnetEncryptionUseStartTlsGets or sets a value indicating whether InfoConnect uses Secure Sockets Layer/Transport via Telnet STARTTLS option  
    PropertyEnterKeyRepeatGets or sets a value indicating whether holding down the Enter key is equivalent to pressing it multiple times.  
    PropertyExpressLogonFeatureApplidGets or sets the application ID to use for Express Logon Feature (ELF) support.  
    PropertyFileSystemGets or sets a value indicating whether the terminal uses the ANSI character set or the ASCII character set for ASCII transfers from the host.  
    PropertyFileTransferGets the FileTransfer object.  
    PropertyGenerateDeviceNamesGets or sets a value indicating whether the terminal automatically generates device name values based on values you specify for the DeviceName property.  
    PropertyGraphicsDeviceGets or sets the type of graphics device the terminal emulates for 3179G terminal sessions.  
    PropertyGraphicsEnabledGets or sets a value indicating whether the terminal is configured for a 3179G terminal session with the host.  
    PropertyGraphicsExtendedColorsGets or sets a value indicating whether the terminal uses the set of extended graphics colors (black, white, dark blue, orange, purple, dark green, dark turquoise, mustard, gray, and brown).  
    PropertyHllapiLongNameGets or sets the HLLAPI application associated with a particular InfoConnect session.  
    PropertyHllapiShortNameGets or sets an identifier that a HLLAPI application uses to link to an InfoConnect session.  
    PropertyHllapiStyleGets or sets the InfoConnect HLLAPI configuration. This is a numeric value.  
    PropertyHostAddressGets or sets the host address.  
    PropertyHostCodePageGets or sets the character set InfoConnect that uses for character translations.  
    PropertyHostCommTimeoutGets or sets how many seconds the terminal waits for a host connection response.  
    PropertyHostControlsOutlineColorGets or sets a value indicating whether the host determines the color of field outline characters.  
    PropertyHostCursorBlinkControlGets or sets a value indicating whether the host controls the cursor blink rate.  
    PropertyHostKeyboardTypeGets or sets a value that specifies which keys can be used in numeric fields.  
    PropertyHostNumlockControlGets or sets a value indicating whether the host can enable Num Lock mode.  
    PropertyHostTypeAheadControlGets or sets a value indicating whether the terminal honors the keyboard buffering control setting in the AS/400 user profile.  
    PropertyIDMCriteriaGets or sets ID Management criteria flags. The default is 0.  
    PropertyIDMPoolNameGets or sets ID Management pool name. The default is "".  
    PropertyIDMServerURLGets or sets ID Management server URL. The default is "".  
    PropertyIgnoreEUICmdErrGets or sets a value indicating whether Enhanced User Interface command errors are ignored.  
    PropertyIgnoreHostPrintReqGets or sets a value indicating whether a print command in a host data stream is accepted.  
    PropertyInputFieldUnderlinesGets or sets a value that specifies how the terminal underlines input fields on host screens.  
    PropertyInsertArenaGets or sets a value that specifies the extent to which the terminal applies the logic for character insertion as described for the InsertProtocol property.  
    PropertyInsertProtocolGets or sets a value that specifies what the terminal does if you attempt to insert a character.  
    PropertyInstanceIdGets the instance ID of the control. (Inherited from Attachmate.Reflection.Framework.IControl)
    PropertyIsConnectedGets a value indicating whether the session is connected.  
    PropertyKeyboardErrorAlarmGets or sets a value indicating whether to sound the alarm (a beep) when a keyboard error is detected.  
    PropertyKeyboardErrorResetGets or sets a value that specifies how keyboard errors are processed.  
    PropertyKeyboardMapperGets the KeyboardMapper object.  
    PropertyKeysDuringWaitGets or sets a value indicating whether the user can use the keyboard during a synchronous command.  
    PropertyKoreanEUCCIMEBehaviorGets or sets a value indicating whether to mimic Korean EUCC IME behavior. The default is false.  
    PropertyMacroGets the Macro object.  
    PropertyMappedNumlockPreservesNumlockGets or sets a value that specifies how the terminal behaves when a user presses a PC NUM LOCK key that is mapped to emulate the action of a terminal key.  
    PropertyModelGets or sets the terminal model. This property causes an error when InfoConnect is connected to a host. Use the Connected property to determine if a connection already exists.  
    PropertyModifiedGets a value indicating whether the session configuration has changed.  
    PropertyMouseMapperGets the MouseMapper object.  
    PropertyMouseShapeGets or sets the appearance of the mouse pointer in the terminal window.  
    PropertyNameGets or sets the name of the control. (Inherited from Attachmate.Reflection.Framework.IControl)
    PropertyPortGets or sets the TCP port to connect to.  
    PropertyProductivityGets the Productivity object.  
    PropertyQuickPadsShowToolTipsGets or sets a value indicating whether QuickPad controls display tooltips.  
    PropertyRcTLSFipsModeGets or sets a value indicating whether to use the FIPS cipher suite.  
    PropertyRunMacroAtReconnectGets or sets a value indicating whether the ConnectAction sequence is re-run after a session is reconnected.  
    PropertyScreenGets the Screen object.  
    PropertySessionFilePathGets the session document file path. (Control properties are saved in session document files.) (Inherited from Attachmate.Reflection.Framework.IControl)
    PropertyShowClassicStatusBarGets 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.  
    PropertyShowMenuBarGets 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.  
    PropertySingleSignOnGets or sets a value indicating whether InfoConnect enables the use of a single user name and password for multiple logon procedures.  
    PropertySSLValidateCertChainGets or sets a value indicating whether certificates presented for host authentication are checked to determine if they are valid and signed by a trusted CA.  
    PropertyStatusBarTextGets or sets the text displayed on the status bar.  
    PropertySubstituteDisplayCharactersGets or sets a value indicating whether zeros in a 3270 or a 5250 display are shown with a slash through them.  
    PropertySupport3270PartitionsGets or sets a value indicating whether to send partition-related information from the terminal to the host in response to a host query request.  
    PropertySupportDbcsFeaturesGets or sets a value indicating whether double-byte character support is enabled.  
    PropertyTelnetAttnGets or sets a value that specifies what happens when you transmit the ATTN host key (the default keystroke for this function is CTRL+F1).  
    PropertyTelnetEncryptionDisableCRLCheckGets or sets a value that indicates whether InfoConnect checks for certificate revocation when validating host certificates in SSL/TLS Telnet sessions.  
    PropertyTelnetEncryptionStrengthGets or sets the encryption strength for Secure Sockets Layer/Transport Layer Security (SSL/TLS) datastream encryption.  
    PropertyTelnetEncryptionUseOCSPGets or sets a value indicating whether your client session checks for certificate revocation using OCSP (Online Certificate Status Protocol) responders when validating host certificates. The default is false.  
    PropertyTelnetEncryptionVerifyHostNameGets or sets how InfoConnect handles SSL/TLS Telnet connections when the host name in the certificate does not match the host being contacted.  
    PropertyTelnetEnvironmentGets or sets a string that is passed to an "Exit program" on an AS/400 host when InfoConnect makes a Telnet connection.  
    PropertyTelnetKeepAliveGets or sets a value indicating whether to periodically poll the host to determine if Telnet connections remain active during intervals when you are not sending data to the host.  
    PropertyTelnetKeepAliveTimeoutGets or sets the interval (in seconds) between keep alive requests.  
    PropertyTelnetSysReqGets or sets a value that specifies what happens when you transmit the SysReq function (mapped to the ALT-PRINT SCREEN keystroke by default).  
    PropertyTelnetTerminalIDGets or sets the Telnet terminal ID string that InfoConnect generates and sends to the Telnet gateway, based on the Model ID you select in the session settings.  
    PropertyTelnetUseReflectionSecurityProxyGets or sets a value indicating whether Reflection makes makes secure SSL connections through the Reflection for the Web Security Proxy when EnableTelnetEncryption is true.  
    PropertyTelnetXSystemGets or sets a value indicating whether X SYSTEM is supported in 3270 sessions.  
    PropertyTerminalTypeGets or sets the type of the terminal session.  
    PropertyTerminalUserControlContextGets or sets a value indicating whether this terminal object is being used in a Terminal User Control context. This is an internal property used to determine the context of this terminal object usage. This is set to true  
    PropertyThemeGets the theme object.  
    PropertyTitleBarCaptionGets 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 - &r - &s  
    PropertyTLS_SSLVersionGets or sets a value indicating which SSL or TLS version to use.  
    PropertyTNAssociationGets or sets a string that identifies a 3270 terminal session on the host.  
    PropertyTsoFileListCommandGets or sets the name of the host exec to run when the Show Host Files button in the Transfer dialog box is clicked.  
    PropertyTsoMemberListCommandGets or sets the name of the host exec to run when a member in the Transfer dialog box is expanded.  
    PropertyTypeAheadGets or sets a value indicating whether InfoConnect buffers characters that you type in the terminal window.  
    PropertyUiControlActionMapperGets the object used to map actions to the user interface control and to retrieve the action sequence from the user interface control.  
    PropertyUseIDManagementGets or sets a value indicating whether InfoConnect uses ID Management to obtain a device name.  
    PropertyUseIPV6Gets or sets a value indicating whether InfoConnect uses version 6 of the Internet Protocol.  
    PropertyVBCommonProjectGets the Common VB Project (VBA use only)  
    PropertyVBProjectGets the VB Project (VBA use only)  
    PropertyVersionGets the version of the terminal session control.  
    PropertyWordWrap3270Gets or sets a value indicating whether text wraps to the next available field when entered text is too long to fit in a text entry field.  
    PropertyWordWrap3270MinimumFieldLengthGets or sets the minimum field length required for word wrap in 3270 terminal sessions.  
    PropertyWordWrap5250Gets or sets a value indicating whether text is truncated at the end of the current field or wrapped to the next available field, and whether the host controls this behavior.  
    Top
    Public Methods
     NameDescription
    MethodAddVBAReferenceAdds 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.  
    MethodCloseCloses the terminal session with the close option.  
    MethodConnectConnects to the host.  
    MethodDisconnectDisconnects from the host.  
    MethodExecuteExecute a given action. Actions possible is defined in InputMapActionID.  
    MethodGetDASOPassTicketIssues 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.  
    MethodGetVBAReferencesRetrieves 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.  
    MethodRemoveVBAReference

    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.

     
    MethodSaveSaves all settings.  
    MethodSaveAsSaves all settings to the specified file.  
    MethodSaveAsCompoundSaves a session as a compound session document.  
    Top
    Public Events
     NameDescription
    EventAfterConnectOccurs after InfoConnect connects to the host.  
    EventAfterDisconnectOccurs after InfoConnect disconnects from the host.  
    EventBeforeConnectOccurs before InfoConnect connects to the host.  
    EventBeforeDisconnectOccurs before InfoConnect disconnects from the host.  
    EventClosedOccurs before the session closes.  
    EventCreditCardRecognized

    This event occurs when an unredacted Primary Account Number (PAN) is displayed on the screen or in productivity features, such as Screen History. It also occurs when an unredacted PAN is copied from the terminal (for example, when the PAN is copied to a text file or a Microsoft Office application).

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

     
    Top
    See Also

    Reference

    IIbmTerminal Interface
    Attachmate.Reflection.Emulation.IbmHosts Namespace

    Send Feedback