Reflection Desktop VBA Guide
Attachmate.Reflection.Objects.Emulation.IbmHosts Library / Attachmate.Reflection.Objects.Emulation.IbmHosts Library / IbmTerminal Object
Properties Methods Events

In This Topic
    IbmTerminal Object Members
    In This Topic

    The following tables list the members exposed by IbmTerminal.

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

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

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

     
    Public PropertyConnectMacroData

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

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

     
    Public PropertyConnectScriptGets or sets a Reflection Basic script that is run automatically after a connection is established.  
    Public PropertyConnectScriptArgumentsGets or sets a parameter string to be passed to the connect script after a connection is established. Use the ConnectScript property to specify a connect script.  
    Public PropertyContextMenusGets the ContextMenus object.  
    Public PropertyCursorMovementStyleGets or sets a value that specifies how the cursor moves between composed Thai characters.  
    Public PropertyCursorProgressionIndicatorGets or sets a value that specifies how the terminal responds when the host queries to determine if End User Interface (EUI) enhancements are supported by the terminal.  
    Public PropertyCustomColumnsGets or sets the number of columns in the terminal window display when the terminal is configured to use the custom terminal model.  
    Public PropertyCustomRowsGets or sets the number of rows in the terminal window display when the terminal is configured to use the custom terminal model.  
    Public PropertyDASOApplicationIDRetrieves or assigns the application ID to use for DASO (Digital Certificate Access Server Automated Sign On) support.  
    Public 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.  
    Public 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.  
    Public 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.  
    Public 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.  
    Public PropertyDbcsUserDefinedCharacterSourceGets or sets whether user-defined character fonts are located on the host (HostImages) or on the PC (PCEndUserDefinedImages).  
    Public PropertyDefaultPortsGets or sets a value indicating whether the terminal should attempt to communicate with the host transaction programs using the default port numbers (as defined by IBM).  
    Public PropertyDeviceNameGets or sets the device to connect to.  
    Public PropertyDisableKeystrokeProductivityGets or sets a value indicating whether all keystroke functionality for Productivity features (such as Spell Check and Auto Complete) is disabled.  
    Public PropertyDisableScreenHistoryGets or sets a value indicating whether recording of Screen History is disabled.  
    Public PropertyDisplayMarginsGets or sets a value indicating whether to display margins around the terminal window.  
    Public PropertyEnableHostAlarmGets or sets a value indicating whether alarms (beeps) sent by the host are sounded. The default is true.  
    Public PropertyEnableTelnetEncryptionGets or sets a value indicating whether Reflection uses Secure Sockets Layer/Transport Layer Security (SSL/TLS) datastream encryption.  
    Public PropertyEnableTelnetEncryptionUseStartTlsGets or sets a value indicating whether Reflection uses SSL/TLS for Telnet encryption via the STARTTLS mechanism.  
    Public PropertyEnterKeyRepeatGets or sets a value indicating whether holding down the ENTER key is equivalent to pressing it multiple times.  
    Public PropertyExpressLogonFeatureApplidGets or sets the application ID to use for Express Logon Feature (ELF) support.  
    Public 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.  
    Public PropertyFileTransferGets the FileTransfer object.  
    Public PropertyGenerateDeviceNamesGets or sets a value indicating whether the terminal automatically generates device name values based on values you specify for the DeviceName property.  
    Public PropertyGraphicsDeviceGets or sets the type of graphics device the terminal emulates for 3179G terminal sessions.  
    Public PropertyGraphicsEnabledGets or sets a value indicating whether the terminal is configured for a 3179G terminal session with the host.  
    Public 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).  
    Public PropertyHllapiLongNameGets or sets the HLLAPI application associated with a particular Reflection session. This string is not used by the HLLAPI application.  
    Public PropertyHllapiShortNameGets or sets an identifier that a HLLAPI application uses to link to a Reflection session.  
    Public PropertyHllapiStyleGets or sets Reflection's HLLAPI configuration. This is a numeric value.  
    Public PropertyHostAddressGets or sets the host address.  
    Public PropertyHostCodePageGets or sets the character set that Reflection uses for character translations.  
    Public PropertyHostCommTimeoutGets or sets how many seconds the terminal should wait for a host connection response.  
    Public PropertyHostControlsOutlineColorGets or sets a value indicating whether the host determines the color of field outline characters.  
    Public PropertyHostCursorBlinkControlGets or sets a value indicating whether the host controls the cursor blink rate.  
    Public PropertyHostKeyboardTypeGets or sets a value that specifies which keys can be used in numeric fields.  
    Public PropertyHostNumlockControlGets or sets a value indicating whether the host can enable Num Lock mode. The default is false.  
    Public PropertyHostTypeAheadControlGets or sets a value indicating whether the terminal honors the keyboard buffering control setting in the AS/400 user profile.  
    Public PropertyIDMCriteriaGets or sets ID Management criteria flags.  
    Public PropertyIDMPoolNameGets or sets ID Management pool name.  
    Public PropertyIDMServerURLGets or sets ID Management server URL.  
    Public PropertyInstanceId

    Gets the InstanceId of the session.

     
    Public PropertyIgnoreEUICmdErrGets or sets a value indicating whether Enhanced User Interface command errors are ignored.  
    Public PropertyIgnoreHostPrintReqGets or sets a value indicating whether a print command in a host data stream is accepted.  
    Public PropertyInputFieldUnderlinesGets or sets a value that specifies how the terminal underlines input fields on host screens.  
    Public 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.  
    Public PropertyInsertProtocolGets or sets a value that specifies what the terminal does if you attempt to insert a character.  
    Public PropertyIsConnectedGets a value indicating whether the session is connected.  
    Public PropertyKeyboardErrorResetGets or sets a value that specifies how keyboard errors are processed.  
    Public PropertyKeyboardMapperGets the KeyboardMapper object.  
    Public PropertyKeysDuringWaitGets or sets a value indicating whether the user can use the keyboard during a synchronous command.  
    Public PropertyKoreanEUCCIMEBehaviorGets or sets a value indicating whether to mimic Korean EUCC IME behavior. The default is false.  
    Public PropertyMacroGets the Macro object.  
    Public PropertyMappedNumlockPreservesNumlockGets or sets a value that specifies how the terminal responds when the user presses the PC NUM LOCK key when the key is mapped to emulate the action of a terminal key.  
    Public PropertyModelGets or sets the terminal model. This property causes an error when Reflection is connected to a host. Use the Connected property to determine if a connection already exists.  
    Public PropertyModifiedGets a value indicating whether the session configuration has changed.  
    Public PropertyMouseMapperGets the MouseMapper object.  
    Public PropertyMouseShapeGets or sets the appearance of the mouse pointer in the terminal window.  
    Public PropertyName

    Gets or sets the control name.

     
    Public PropertyPortGets or sets the TCP port to connect to.  
    Public PropertyProductivityGets the Productivity object.  
    Public PropertyQuickPadsShowToolTipsGets or sets a value indicating whether QuickPad controls display tooltips.  
    Public PropertyRunMacroAtReconnectGets or sets a value indicating whether the ConnectAction sequence is re-run after a session is reconnected.  
    Public PropertyScreenGets the Screen object.  
    Public PropertySessionFilePath

    Gets the session file path.

     
    Public 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.  
    Public 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.  
    Public PropertySingleSignOnGets or sets a value indicating whether Reflection enables the use of a single user name and password for multiple logon procedures.  
    Public 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.  
    Public PropertyStatusBarTextGets or sets the text displayed on the status bar.  
    Public PropertySubstituteDisplayCharactersGets or sets a value indicating whether zeros in the 3270 or 5250 display are shown with a slash through them.  
    Public 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.  
    Public PropertySupportDbcsFeaturesGets or sets a value indicating whether double-byte character support is enabled.  
    Public 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).  
    Public PropertyTelnetEncryptionDisableCRLCheckGets or sets a value that determines whether Reflection checks for certificate revocation when validating host certificates in SSL/TLS Telnet sessions.  
    Public PropertyTelnetEncryptionStrengthGets or sets the encryption strength for Secure Sockets Layer/Transport Layer Security (SSL/TLS) datastream encryption.  
    Public 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.  
    Public PropertyTelnetEncryptionVerifyHostNameGets or sets how Reflection handles SSL/TLS Telnet connections when the host name in the certificate does not match the host being contacted.  
    Public PropertyTelnetEnvironmentGets or sets a string that is passed to an "Exit program" on an AS/400 host when Reflection makes a Telnet connection.  
    Public 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.  
    Public PropertyTelnetKeepAliveTimeoutGets or sets the interval (in seconds) between keep alive requests sent by the emulator.  
    Public PropertyTelnetSysReqGets or sets a value that specifies what happens when you transmit the SysReq function (mapped to the ALT-PRINT SCREEN keystroke by default).  
    Public PropertyTelnetUseReflectionSecurityProxyGets or sets whether Reflection makes makes secure SSL connections through the Reflection for the Web Security Proxy when EnableTelnetEncryption is true.  
    Public PropertyTelnetXSystemGets or sets whether X SYSTEM is supported in 3270 sessions.  
    Public PropertyTerminalTypeGets or sets the type of the terminal session.  
    Public PropertyThemeGets the Theme object.  
    Public 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  
    Public PropertyTLS_SSLVersionGets or sets a value indicating which SSL or TLS version to use.  
    Public PropertyTNAssociationGets or sets a string that identifies a 3270 terminal session on the host.  
    Public PropertyTsoFileListCommandGets or sets the name of the host exec to run when the Show Host Files button in the Transfer dialog box is clicked.  
    Public PropertyTsoMemberListCommandGets or sets the name of the host exec to run when a member in the Transfer dialog box is expanded.  
    Public PropertyTypeAheadGets or sets a value indicating whether Reflection buffers characters that you type in the terminal window.  
    Public PropertyUiControlActionMapperGets the object used to map actions to the user interface control and to retrieve the action sequence from the user interface control.  
    Public PropertyUseIDManagementGets or sets a value indicating whether Reflection uses ID Management to obtain a device name.  
    Public PropertyUseIPV6Gets or sets whether Reflection uses version 6 of the Internet Protocol.  
    Public PropertyVBCommonProjectGets the VB common project from VBA  
    Public PropertyVBProjectGets the VB project from VBA  
    Public PropertyVersionGets the version of the terminal session control.  
    Public PropertyWordWrap3270Gets or sets whether text wraps to the next available field when entered text is too long to fit in a text entry field.  
    Public PropertyWordWrap3270MinimumFieldLengthGets or sets the minimum field length required for word wrap in 3270 terminal sessions.  
    Public 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
    Public 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.  
    Public MethodCloseCloses the terminal session with the close option.  
    Public MethodConnectConnects to the host.  
    Public MethodDisconnectDisconnects from the host. If no connection currently exists, this method is ignored. Use the IsConnected property to determine if a connection already exists.  
    Public MethodExecuteExecute a given action. Actions possible is defined in InputMapActionID.  
    Public 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.  
    Public 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.  
    Public 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.

     
    Public MethodSaveSaves all settings.  
    Public MethodSaveAsSaves all settings to the specified file.  
    Public MethodSaveAsCompoundSaves a session as a compound session document.  
    Top
    Public Events
     NameDescription
    Public EventAfterConnectOccurs after Reflection connects to the host.  
    Public EventAfterDisconnectOccurs after Reflection disconnects from the host.  
    Public EventBeforeConnectOccurs before Reflection connects to the host.  
    Public EventBeforeDisconnectOccurs before Reflection disconnects from the host.  
    Public EventClosedOccurs before the session closes.  
    Public 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 by configuring settings on the Setup Information Privacy dialog box. For more information, see "Logging Credit Card Access" in the Reflection VBA Guide.

     
    Top
    See Also

    Reference

    IbmTerminal Object
    Attachmate.Reflection.Objects.Emulation.IbmHosts Library

    Send Feedback