Object Reference. AccuSoft 7
Anúncio
Anúncio
AccuTerm 7 Automation 85
2.2.4.1.29 Word function
Syntax:
Word(
text$, first, last )
Description:
Returns a String containing a single word or a group of words between
first
and
last
.
2.2.4.1.30 WordCount function
Syntax:
WordCount(
text$ )
Description:
Returns an Integer representing the number of words in
text$
. Words are separated by spaces, tabs, and end-of-lines.
2.3
Object Reference
AccuTerm 7 exposes a rich COM/OLE/ActiveX object structure. This allows AccuTerm to act as an
Automation Server to any number of client applications. AccuTerm’s objects are arranged in a hierarchy, with the
AccuTerm
application object at the top. The object hierarchy is shown in diagram below.
Properties
To reference a property, simply append a period (.) followed by the property name to an object variable of the appropriate type. To get the value of a property, assign the property reference to a variable of the appropriate type; to set the value, assign an appropriate expression, constant or variable to the property reference.
Methods
A method is a subroutine or function call. To reference a method, simply append a period (.) followed by the method name to an object variable of the appropriate type. Function methods return a value; for these methods, assign the result to a variable of the appropriate type. Some methods accept one or more arguments separated by commas. If the method also returns a value, enclose the argument list in
Copyright 2010-2013 Schellenbach & Assoc., Inc.
86 AccuTerm 7 Help
parentheses. Optional arguments are shown enclosed in brackets [ ]; the brackets are not part of the syntax.
Events
Certain of AccuTerm’s objects have the ability to fire events. To use events, the client application must be capable of responding to events. For example, to use the
Session
object’s
DataReady
event, the following declaration is required in a VB form or class:
Dim WithEvents objSession As AccuTermClasses.Session
Type Library
AccuTerm 7 includes a type library, ATWIN71.TLB, which contains information about AccuTerm’s public objects, including their properties, methods, events, arguments and constants. When specifying the object type in a declaration, always use the type library as a reference. This will ensure compatibility with future versions of AccuTerm. For example, to declare a VB object variable as type “AccuTerm”, use the following declaration:
Dim obj As AccuTermClasses.AccuTerm
See also:
2.3.1
The AccuTerm Object
The
AccuTerm
object is AccuTerm’s top-level application object. To access the
AccuTerm
object of a running instance of AccuTerm, use the following syntax:
Dim obj as Object
Set obj = GetObject(, "ATWin32.AccuTerm")
To create a new instance of AccuTerm, use:
Dim obj as Object
Set obj = CreateObject("ATWin32.AccuTerm")
The properties and methods of the
AccuTerm
object are described in the following pages. Use these properties and methods to control the overall application. The
AccuTerm
object contains the
Sessions collection, which has one element for each open session. The
ActiveSession
property may be used to obtain a reference to the
Session
object which is currently active.
AccuTerm properties
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 87
NoConnectWizard property
NoWelcomePage property
AccuTerm methods
2.3.1.1
AccuTerm properties
2.3.1.1.1 ActiveSession property
Syntax:
Set
object = AccuTerm.ActiveSession
Data type: Session object
Description:
The
ActiveSession
object is an object of type
Session
, which refers to the currently active session.
The currently active session is the session whose title bar is highlighted.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
88 AccuTerm 7 Help
2.3.1.1.2 AutoClose property
Syntax:
AccuTerm.AutoClose
Data type: boolean
Description:
If non-zero, then when the last open session is closed, AccuTerm will terminate.
See also:
2.3.1.1.3 Common property
Syntax:
AccuTerm.Common
Data type: collection object
Description:
Returns a reference to the
Common
collection may be used to save global variables so that they may be shared between different instances of scripts and OLE clients.
2.3.1.1.3.1 Common collection
Syntax:
Common.Clear
Common(
key) = value
variable = Common(key)
Description:
The
Common
collection is used to store values which may be saved between script executions, or shared with between several running scripts. That is, one session can set a value in the
Common
collection, which another session can retrieve it. Items stored in the
Common
collection are referenced by "keys".
The
key
is a string argument. The values stored in the
Common
collection are variants, and thus can contain any data type. The
Common
collection can be reset by using the
Clear
method.
2.3.1.1.4 CustomMouseTable property
Syntax:
AccuTerm.CustomMouseTable
Data type: string
Description:
This is the file name of the global mouse table file. See Mouse Pattern Matching for more information on using a custom mouse table.
See also:
Session CustomMouseTable property
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 89
2.3.1.1.5 FuncBarPos property
Syntax:
AccuTerm.FuncBarPos
Data type: integer
Description:
Set to zero to show the function key bar at the bottom of the window, or 1 to show the bar at the top of the window.
2.3.1.1.6 FuncBarStyle property
Syntax:
AccuTerm.FuncBarStyle
Data type: integer
Description:
Set to 1 to display the function key number as a tiny number in the corner of the function key buttons, or
0 to not display the key number.
2.3.1.1.7 FuncBarVisible property
Syntax:
AccuTerm.FuncBarVisible
Data type: boolean
Description:
Set to True (non-zero) to display AccuTerm’s function key bar, otherwise set to False (zero).
2.3.1.1.8 Height property
Syntax:
AccuTerm.Height
Data type: long
Description:
This is the application window height in pixels.
2.3.1.1.9 LargeIcons property
Syntax:
AccuTerm.LargeIcons
Data type: boolean
Description:
Set to True (non-zero) to show large icons in the toolbar, otherwise small icons are used.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
90 AccuTerm 7 Help
2.3.1.1.10 LayoutFilename property
Syntax:
AccuTerm.LayoutFilename
Data type: string
Description:
This is the file name of the currently open layout file, or null if no layout is open. This property is readonly.
2.3.1.1.11 Left property
Syntax:
AccuTerm.Left
Data type: long
Description:
This is the horizontal position of the application window in pixels.
2.3.1.1.12 Menu property
Syntax:
Set
menu_object = AccuTerm.Menu
Data type: menu object
Description:
This returns a reference to the application
Menu
object, which may be used to customize AccuTerm’s menus and toolbars.
See also:
2.3.1.1.13 NoCloseWarning property
Syntax:
AccuTerm.NoCloseWarning
Data type: integer
Description:
Set to True (non-zero) to suppress the disconnect warning when closing a session.
2.3.1.1.14 PhoneBookName property
Syntax:
AccuTerm.PhoneBookName
Data type: string
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 91
Description:
This is the file name of the Auto Dialer phone directory.
2.3.1.1.15 ProductLicenseType property
Syntax:
AccuTerm.ProductLicenseType
Data type: integer
Description:
This read-only property returns the product license type: 1=single user, 2=site license, 3=enterprise license, 9=demonstration version.
2.3.1.1.16 ProductName property
Syntax:
AccuTerm.ProductName
Data type: string
Description:
This read-only property returns the string “ACCUTERM/WIN32”.
2.3.1.1.17 ProductRelease property
Syntax:
AccuTerm.ProductRelease
Data type: string
Description:
This read-only property returns the current release of AccuTerm 7.
2.3.1.1.18 ProductSerialNumber property
Syntax:
AccuTerm.ProductSerialNumber
Data type: long
Description:
This read-only property returns the serial number of AccuTerm 7.
2.3.1.1.19 RecentListSize property
Syntax:
AccuTerm.RecentListSize
Data type: integer
Copyright 2010-2013 Schellenbach & Assoc., Inc.
92 AccuTerm 7 Help
Description:
Specifies the number of entries in the recent file list.
2.3.1.1.20 RegisteredCompany property
Syntax:
AccuTerm.RegisteredCompany
Data type: string
Description:
This read-only property returns the registered company name.
2.3.1.1.21 RegisteredLocation property
Syntax:
AccuTerm.RegisteredLocation
Data type: string
Description:
This read-only property returns the registered location.
2.3.1.1.22 RegisteredUser property
Syntax:
AccuTerm.RegisteredUser
Data type: string
Description:
This read-only property returns the registered user name.
2.3.1.1.23 SessionBarVisible property
Syntax:
AccuTerm.SessionBarVisible
Data type: integer
Description:
Set to True (non-zero) to display AccuTerm’s session bar, otherwise set to False (zero).
2.3.1.1.24 Sessions property
Syntax:
AccuTerm.Sessions
Data type: collection of session objects
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 93
Returns a reference to the
Sessions
collection. This collection has one member for each open session.
The first session is
Sessions(0)
.
2.3.1.1.25 SingleInstance property
Syntax:
AccuTerm.SingleInstance
Data type: integer
Description:
Set to True (non-zero) to allow only one instance of AccuTerm. To allow multiple instances, set to False
(zero).
2.3.1.1.26 StatusLineVisible property
Syntax:
AccuTerm.StatusLineVisible
Data type: integer
Description:
Set to True (non-zero) to display AccuTerm’s status line, otherwise set to False (zero).
2.3.1.1.27 ToolbarVisible property
Syntax:
AccuTerm.ToolbarVisible
Data type: integer
Description:
Set to True (non-zero) to display AccuTerm’s tool bar, otherwise set to False (zero).
2.3.1.1.28 Top property
Syntax:
AccuTerm.Top
Data type: long
Description:
This is the vertical position of the application window in pixels.
2.3.1.1.29 TrackKeyboardState property
Syntax:
AccuTerm.TrackKeyboardState
Data type: integer
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
94 AccuTerm 7 Help
If this property is True, AccuTerm tracks the state of the CapsLock and ScrollLock keys. When tracking is enabled, the state of these keys is saved and restored when the user switches to and from the
AccuTerm application.
2.3.1.1.30 Visible property
Syntax:
AccuTerm.Visible
Data type: boolean
Description:
Set to True (non-zero) to make AccuTerm’s main window visible. Set to False to hide AccuTerm’s main window.
2.3.1.1.31 Width property
Syntax:
AccuTerm.Width
Data type: long
Description:
This is the application window width in pixels.
2.3.1.1.32 WindowState property
Syntax:
AccuTerm.WindowState
Data type: integer
Description:
This is the state of AccuTerm’s main window. Set to 0 for normal, 1 for minimized or 2 for maximized.
See also:
2.3.1.2
AccuTerm methods
2.3.1.2.1 Activate method
Syntax:
AccuTerm.Activate
Description:
Makes AccuTerm the active application.
See also:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 95
2.3.1.2.2 Arrange method
Syntax:
AccuTerm.Arrange
[
style
]
Description:
Arranges AccuTerm session windows. Set
style
to 0 for cascade, 1 for tile horizontal, 2 for tile vertical and 3 to arrange icons.
2.3.1.2.3 Close method
Syntax:
AccuTerm.Close
[
prompt
]
Description:
Closes AccuTerm. If
prompt
is True (non-zero) and any changes have been made to session configuration settings, the user will be prompted save the changed settings.
This method is the same as the Terminate method, but is not available when using late binding.
See also:
2.3.1.2.4 Hide method
Syntax:
AccuTerm.Hide
Description:
This method makes AccuTerm’s main window invisible.
See also:
2.3.1.2.5 Move method
Syntax:
AccuTerm.Move
left
[
,
top
[
,
width
[
,
height
]]]
Description:
Repositions and resizes AccuTerm’s main window. The positions and dimensions are specified in pixels.
See also:
2.3.1.2.6 OpenLayout method
Syntax:
AccuTerm.OpenLayout
filename
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
96 AccuTerm 7 Help
This method opens the specified layout file. When using this method to open a layout file, any script attached to the layout file is ignored.
2.3.1.2.7 Resize method
Syntax:
AccuTerm.Resize
width,height
Description:
Resizes AccuTerm’s main window. The dimensions are specified in pixels.
See also:
2.3.1.2.8 SaveLayout method
Syntax:
AccuTerm.SaveLayout [
filename]
Description:
This method saves the current layout in the specified layout file. If
filename
is not specified, the currently open layout file is used. If there is no currently open layout file, the user is prompted for a file name.
2.3.1.2.9 SettingsDialog method
Syntax:
AccuTerm.SettingsDialog
[
InitSel
, [
Categories
]]
Description:
This method displays AccuTerm's Settings dialog box. You can specify the initially selected item
InitSel
(see table below), and a list of
Categories
to show in the categories tree. The
Categories
list is a string with a single letter for each main category to display. Letters which may be used for
InitSel
or
Categories
are:
Category code
O
A
D
D5
D7
T
S
D1
D2
D3
D4
C
C0
C1
Tab code
(2K2)
Category
G
G
D
General Options
Files & Folders
Connection
T
S
C
Serial
PicLan
Telnet
Modem
SSH
SSL
Term Type
Screen
Colors & Palette
Color Theme
Attribute Colors
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 97
Category code
C2
B
K
Q
H
E
X
F
P
P1
P2
W
R
Tab code
(2K2)
Category
C
K
F
P
Color Palette
Background
Keyboard
Font & Character Set
Printer
Screen Printer
Slave Printer
M
M
M
X
G
R
Clipboard
Mouse
Sound
File Transfer
Windows
TCL Rules
For compatibility with AccuTerm 2K2, you can use the alternative Tab code in place of the new
Category code, as shown in the table above. If you do not specify a value for
InitSel
, the previously active category is initially selected. If you do not specify a value for
Categories
, all available categories are displayed.
2.3.1.2.10 Show method
Syntax:
AccuTerm.Show
Description:
Makes AccuTerm’s main window visible.
See also:
2.3.1.2.11 Terminate method
Syntax:
AccuTerm.Terminate
[
prompt
]
Description:
Closes AccuTerm. If
prompt
is True (non-zero) and any changes have been made to session configuration settings, the user will be prompted save the changed settings.
This method is the same as the Close method, and is available when using late binding.
See also:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
98 AccuTerm 7 Help
2.3.2
The Menu Object
Both the
AccuTerm
object and each session object contain a
Menu
object. The menu object is the root object of AccuTerm’s menu structure. When no sessions are open, the menu object member of the
AccuTerm object is the operational menu. When any session is open, the menu object member of the active session is the operational menu. The menu object contains a number of
contain
Menu properties
See also:
2.3.2.1
Menu properties
2.3.2.1.1 Count property
Syntax:
menu
.
Count
Data type: integer
Description:
This read-only property is the number of
MnuBand objects contained in the menu.
2.3.2.1.2 Item property
Syntax:
menu
.
Item
(
toolID
)
Data type:
MnuTool
object
Description:
This array property returns a reference to a
MnuTool object for the specified
toolID
. Each menu item, toolbar button, and status bar field has a
toolID
that identifies the tool (see
2.3.2.1.3 MnuBands property
Syntax:
menu.MnuBands
(
index
)
Data type: array of
MnuBand
objects
Description:
This read-only property array returns a
MnuBand object corresponding to the specified one-based index.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 99
2.3.2.2
The MnuBand Object
A
Menu object contains zero or more
MnuBand objects. Examples of
MnuBand
objects are the main menu, the toolbar, the status bar and popup menus. A
MnuBand
object contains zero or more
objects.
MnuBand properties
2.3.2.2.1 MnuBand properties
2.3.2.2.1.1 BandType property
Syntax:
mnuband.BandType
Data type: integer
Description:
This property is the type of band: 0 = toolbar, 1 = main menu, 2 = popup menu, 3 = status bar, 4 = session bar.
2.3.2.2.1.2 Caption property (MnuBand)
Syntax:
mnuband
.
Caption
Data type: string
Description:
This property is the type of band: 0 = toolbar or status bar, 1 = main menu, 2 = popup menu or submenu.
2.3.2.2.1.3 Count property (MnuBand)
Syntax:
mnuband
.
Count
Data type: integer
Description:
This read-only property is the number of
MnuTool objects contained in the band.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
100 AccuTerm 7 Help
2.3.2.2.1.4 DockingArea property
Syntax:
mnuband
.
DockingArea
Data type: integer
Description:
This property specifies the position of the toolbar or status bar: 1 = top, 2 = bottom, 4 = left, 8 = right.
2.3.2.2.1.5 MnuTools property
Syntax:
mnuband
.
MnuTools
(
index
)
Data type: array of
MnuTool
objects
Description:
This read-only property array returns a
MnuTool object corresponding to the specified one-based index.
2.3.2.2.1.6 Name property
Syntax:
mnuband
.
Name
Data type: string
Description:
This read-only property is the name of the
MnuBand object.
2.3.2.2.1.7 Visible property (MnuBand)
Syntax:
mnuband
.
Visible
Data type: boolean
Description:
This property is True if the band is visible.
2.3.2.3
The MnuTool Object
The
MnuTool
object is at the lowest level of the
Menu object hierarchy, and contains properties for the
caption, icon, state and action of a menu item, toolbar button or status bar field.
MnuTool properties
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 101
2.3.2.3.1 MnuTool properties
2.3.2.3.1.1 Action property
Syntax:
mnutool
.
Action
Data type: string
Description:
This property contains the action to perform when the menu item or button is clicked. All built-in menu items have a default action associated with them, but an optional action can be specified by setting this property. Set this property to null to perform the default action. Otherwise, to execute a macro, enclose the macro statement in square brackets (
[ ]
). To transmit a character sequence to the host, set this property to the desired sequence.
2.3.2.3.1.2 Caption property (MnuTool)
Syntax:
mnutool
.
Caption
Data type: string
Description:
This property is the caption displayed in the higher-level menu item. The caption is not displayed in a toolbar.
2.3.2.3.1.3 Checked property
Syntax:
mnutool
.
Checked
Data type: boolean
Description:
Set this property to True to display a checked box next to the caption in popup menus or sub-menus.
2.3.2.3.1.4 Enabled property
Syntax:
mnutool
.
Enabled
Data type: integer
Description:
Set this property to True to enable a menu item. If this property is False, the item is disabled and is displayed in a gray color.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
102 AccuTerm 7 Help
2.3.2.3.1.5 ToolID property
Syntax:
mnutool
.
ToolID
Data type: long
Description:
This property is the tool ID.
2.3.2.3.1.6 ToolTipText property
Syntax:
mnutool
.
ToolTipText
Data type: string
Description:
This property is the text which is displayed in a floating window when the cursor is paused over a menu item or toolbar button.
2.3.2.3.1.7 Visible property (MnuTool)
Syntax:
mnutool
.
Visible
Data type: boolean
Description:
This property is True if the tool (menu item or toolbar button) is visible.
2.3.3
The ScreenBlock Object
The
ScreenBlock
object is created by the
method, and is used to preserve and
restore the contents of a portion of the terminal screen. The
contents of the
ScreenBlock
object back onto the terminal screen.
See also:
2.3.4
The Server Object
The Server object, in conjunction with the FTSERVER host program, provides a simple method for performing common host database operations, including reading and writing files, executing commands, calling BASIC subroutines and converting data. The Server object can be used in any ActiveX enabled client application, such as Microsoft Word, Excel, and Visual Basic.
Server methods
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 103
Server properties
2.3.4.1
Server properties
2.3.4.1.1 AccountName property
Syntax:
Server.AccountName
Data type: string
Description:
Returns the name of the account the server object is connected to.
2.3.4.1.2 ErrorMode property
Syntax:
Server.ErrorMode
Data type: integer
Description:
Set to 0 to ignore errors, 1 to raise an error to the calling application, 2 to display error message dialog box
Copyright 2010-2013 Schellenbach & Assoc., Inc.
104 AccuTerm 7 Help
2.3.4.1.3 LastError property
Syntax:
Server.LastError
Data type: integer
Description:
Returns any error number from the previous operation, or zero if no error.
2.3.4.1.4 LastErrorMessage property
Syntax:
Server.LastErrorMessage
Data type: string
Description:
Returns any error message from the previous operation, or null if no error.
2.3.4.1.5 MDName property
Syntax:
Server.MDName
Data type: string
Description:
Returns the file name of the master dictionary (MD or VOC).
2.3.4.1.6 ServerID property
Syntax:
Server.ServerID
Data type: string
Description:
Returns a unique identifier for the server object.
2.3.4.1.7 ServerName property
Syntax:
Server.ServerName
Data type: string
Description:
Returns the server name assigned using FTSETUP.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 105
2.3.4.1.8 UnicodeDelimiters property
Syntax:
Server.UnicodeDelimiters
Data type: integer
Description:
Set to 1 to convert system delimiter characters to Unicode, or 0 to use traditional character values for system delimiters. When Unicode delimiters are specified, AM is U+F8FE, VM is U+F8FD and SVM is
U+F8FC.
2.3.4.1.9 UserName property
Syntax:
Server.UserName
Data type: string
Description:
Returns the name of the user logged on to the host.
2.3.4.2
Server methods
2.3.4.2.1 AddItem Method
Syntax:
Server.AddItem
file, ID, data
Description:
Writes a new item to the Pick database. If the item already exists, error 223 is returned.
2.3.4.2.2 CallSub method
Syntax:
Result = Server.CallSub (
SubName
[
,
function
[
,
data
]]
)
Data type: string
Description:
Calls a BASIC subroutine (
SubName
) passing
function
and
data
as arguments. The BASIC subroutine must accept 4 arguments: Function, Data, ErrorCode, ErrorMessage. The returned value is stored in the
Data argument before the subroutine returns. If an error occurs, the subroutine must set the ErrorCode argument to a non-zero value, and place the error message text in the ErrorMessage argument.
2.3.4.2.3 Connect method
Syntax:
Result = Server.Connect(
[
ServerName
]
)
Data type: boolean
Copyright 2010-2013 Schellenbach & Assoc., Inc.
106 AccuTerm 7 Help
Description:
Connects the server object to an AccuTerm session in server mode. If the optional
ServerName
is specified, then the object is connected to the specified server; otherwise, the first session which is in server mode is used.
2.3.4.2.4 DeleteItem method
Syntax:
Server.DeleteItem
file, ID
Description:
Deletes an item from the Pick database. If the item is locked by another process, error 235 is returned.
2.3.4.2.5 Disconnect method
Syntax:
Server.Disconnect
Description:
Disconnects the server object.
2.3.4.2.6 Download method (Server)
Syntax:
Server.Download
SourceFile, SourceIDs, TargetFolder
[
,
Protocol
[
,
Binary
[
,
Overwrite
]]]
Description:
Uses the AccuTerm FT program to download files from the host to the PC.
SourceFile
is the host file name;
SourceIDs
is a list of item-IDs, an asterisk (*) for all items, or an open parenthesis followed by the name of a saved list. Separate IDs with
CR LF
;
TargetFolder
is the destination directory.
Protocol is 1 for
Kermit (default) or 0 for ASCII protocol. If
Binary is zero (default) attribute marks are translated into
CR LF
.
Overwrite is non-zero to allow existing files to be overwritten (default is no overwrite).
2.3.4.2.7 Execute method
Syntax:
Result = Server.Execute(
command
[
,
data
[
,
capture
]]
)
Data type: string
Description:
Executes a TCL
command
on the host system.
Data
is passed as “stacked input” to the command. If
capture is non-zero, the result of the command is returned, otherwise, the return value is empty.
2.3.4.2.8 Export method
Syntax:
Server.Export
SourceFile, SourceIDs, TargetFile, TargetFields [
,
Header [
,
Explode [
,
Protocol
[
,
Delimiter [
,
Overwrite ]]]]]
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 107
Description:
This method uses the AccuTerm FTD program to download a file from the MultiValue host to the PC.
SourceFile
is the host file name.
SourceIDs
is a list of item-IDs, an asterisk (*) for all items, or an open parenthesis followed by the name of a saved list. Separate IDs with
CR LF
;
TargetFile
is the destination file. If the destination file has a supported extension (.XLS, .WK1, .WKS, .WB1, .SYM, .DB2, .DBF), the resulting file will be exported in the native format for that file extension.
TargetFields
is a list of fields to include in the destination file; use asterisk (*) for all fields. Separate field names with
CR LF
. If
Header is non-zero, the first line of the exported file will be a “header”. If
Explode is non-zero, single values are repeated for items with multiple values.
Protocol is 1 for Kermit (default) or 0 for ASCII protocol. If the destination file does not have a supported extension, then
delimiter is used to specify Tab (0, default) or
Comma (1) delimited ASCII file.
Overwrite is non-zero to allow existing files to be overwritten (default is no overwrite).
2.3.4.2.9 FileExists method
Syntax:
Result = Server.
FileExists(
file )
Data type: integer
Description:
Returns 1 if file exists on the host account, or 0 if it does not exist.
2.3.4.2.10 IConv method
Syntax:
Result = Server.IConv(
data, code)
Data type: string
Description:
Performs an “input conversion” on
data
. Conversion to be performed is
code
.
2.3.4.2.11 Import method
Syntax:
Server.Import
SourceFile, TargetFile, Reserved1, Fields
[
,
Header
[
,
Skip
[
,
AutoID
[
,
AutoIDPrefix
[
,
AutoIDStart
[
,
Protocol
[
,
Delimiter
[
,
Overwrite
]]]]]]]]
Description:
This method uses the AccuTerm FTD program to upload a file from the PC to the MultiValue host.
SourceFile
is the PC file name.
TargetFile
is the destination file name. If the source file has a supported extension (.XLS, .WK1, .WKS, .WB1, .SYM, .DB2, .DBF), the file will be imported from the native format for that file extension.
Reserved1
is reserved for future use and should be passed as a null string.
Fields
is a list of fields to be imported (dictionary names or attribute numbers, or asterisk (*) for all fields). Separate field names with
CR LF
. If
Header is non-zero, the first line of the imported file is treated as a “header”.
Skip is the number of “header” lines in the source file to skip. If
AutoID is non-zero, then the target item-IDs will be generated by concatenating
AutoIDPrefix to the item sequence starting with
AutoIDStart
.
Protocol is 1 for Kermit (default) or 0 for ASCII protocol. If the source file does not have a supported extension, then
delimiter is used to specify Tab (0, default) or Comma (1) delimited ASCII file.
Overwrite is non-zero to allow existing items to be overwritten (default is no overwrite).
Copyright 2010-2013 Schellenbach & Assoc., Inc.
108 AccuTerm 7 Help
2.3.4.2.12 IsConnected method
Syntax:
Result = Server.IsConnected(
)
Data type: boolean
Description:
Returns TRUE if server object is connected to the host and the host is running the server application; otherwise returns FALSE.
2.3.4.2.13 ItemExists function
Syntax:
Result = Server.
ItemExists(
file , ID )
Data type: integer
Description:
Returns 1 if item exists in the specified file, or 0 if it does not exist or the file cannot be opened.
2.3.4.2.14 OConv method
Syntax:
Result = Server.OConv(
data, code)
Data type: string
Description:
Performs an “output conversion” on
data
. Conversion to be performed is
code
.
2.3.4.2.15 ReadItem method
Syntax:
Result = Server.ReadItem(
file, ID [
,
attr [
,
value [
,
subvalue [
,
locked ]]]]
)
Data type: string
Description:
Reads an item from the MultiValue database and returns the item, attribute, value or sub-value. If the optional
locked
parameter is non-zero, the item is left locked after the read (same as MV/BASIC READU statement). Error 260 is returned if the item was already locked by another process.
2.3.4.2.16 Readnext method
Syntax:
Result = Server.Readnext(
file, attr
[
,
value
[
,
subvalue
]]
)
Data type: string
Description:
Reads the next item from the Pick database using the current select list and returns the specified
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 109
attribute, value or sub-value. If the list is exhausted,
LastError
will be set to –1.
2.3.4.2.17 Upload method (Server)
Syntax:
Server.Upload
SourceFolder, SourceFiles, TargetFile
[
,
Protocol
[
,
Binary
[
,
Overwrite
]]]
Description:
Uses the AccuTerm FT program to upload files from the PC to the host.
SourceFolder
is the PC directory where the files are uploaded from;
SourceFiles
is a list of file names separated by
CR LF
.
TargetFile
is the destination file.
Protocol is 1 for Kermit (default) or 0 for ASCII protocol. If
Binary is zero (default) attribute marks are translated into
CR LF
.
Overwrite is non-zero to allow existing files to be overwritten (default is no overwrite).
2.3.4.2.18 UnlockItem method
Syntax:
Server.UnlockItem
[
file,
[
,
ID
]]
Description:
Unlocks an item locked by the
ReadItem
function. If
file
and
ID
are null, unlocks all items locked by the process.
2.3.4.2.19 WriteItem method
Syntax:
Server.WriteItem
file, ID, data
[
,
attr
[
,
value
[
,
subvalue
[
,
KeepLocked
]]]]
Description:
Writes an item, attribute, value or sub-value to the Pick database. If the optional
KeepLocked
parameter is non-zero, the item is left locked after the writing (same as MV/BASIC WRITEU statement).
2.3.5
The Session Object
When you use AccuTerm, you create "sessions" to communicate with host computer systems.
AccuTerm’s multiple document interface (MDI) allows you to create as many sessions as you desire, all connected to different host systems (or more than one session to a single host). AccuTerm’s
Session object gives you access to session properties such as port, font, screen colors, etc.) and allows you to invoke session methods (create, delete, input, output, etc.)
Predefined Session Objects
The currently active session may be accessed using the
ActiveSession
object. When a script is invoked from a function key, menu, toolbar button, the host computer system, or from DDE, you can access the session which invoked the script by referencing the
InitSession
object. The
InitSession
object is only valid in the context of a script running in the AccuTerm application.
Creating a New Session
There are two ways to create a new session. First, you can declare a
Session
object variable, and use the
New
keyword with the
Set
statement to create the new session:
Dim S as Session
Set S = New Session
Copyright 2010-2013 Schellenbach & Assoc., Inc.
110 AccuTerm 7 Help
These statements will create a new session. All session properties will be set to their default values.You
access the properties and methods of the session using the
Session
object variable
S
.
An alternate way of creating a new session is to use the
Add
method of the
Sessions
collection object as described above.
Session properties
BackgroundPictureFile property
BackgroundPictureMode property
BackgroundTransparency property
Copyright 2010-2013 Schellenbach & Assoc., Inc.
HostCertificateValidation property
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 111
112 AccuTerm 7 Help
PrintScreenBackground property
ScreenPrintAdapterScript property
ScreenPrintOrientation property
ScreenPrintPaperSource property
SlavePrintAdapterScript property
SSHUseOnlyPreferredCipher property
Session methods
Copyright 2010-2013 Schellenbach & Assoc., Inc.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 113
114 AccuTerm 7 Help
Session events
2.3.5.1
Session properties
2.3.5.1.1 Ansi8Bit property
Syntax:
session.Ansi8Bit
Data type: boolean
Description:
If this setting is non-zero, AccuTerm sends 8 bit control codes. Othewise the eqivalent 7-bit escape sequence is sent. This property is only effective when AccuTerm is emulating one of the VT terminals.
2.3.5.1.2 AnsiAppCursor property
Syntax:
session.AnsiAppCursor
Data type: boolean
Description:
If this setting is non-zero, AccuTerm sends "application codes" instead of "cursor codes" when cursor keys are pressed. This property is only effective when AccuTerm is emulating one of the VT terminals.
2.3.5.1.3 AnsiAppKeypad property
Syntax:
session.AnsiAppKeypad
Data type: boolean
Description:
If this setting is non-zero, AccuTerm sends "application codes" instead of numeric characters when key on the numeric keypad are pressed. This property is only effective when AccuTerm is emulating one of the VT terminals.
2.3.5.1.4 Answerback property
Syntax:
session.Answerback
Data type: string
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 115
This is the string that AccuTerm returns to the host system when the host requests the "answerback message".
2.3.5.1.5 AsciiDelay property
Syntax:
session
.AsciiDelay
Data type: integer
Description:
Specifies the interline delay used for ASCII file uploads in milliseconds.
2.3.5.1.6 AsciiEOL property
Syntax:
session
.AsciiEOL
Data type: integer
Description:
Specifies the line ending sequence for ASCII file uploads. Set to 0 for
CR
, 1 for
LF
or 2 for
CR
+
LF
.
2.3.5.1.7 AutoAnswer property
Syntax:
session.AutoAnswer
Data type: boolean
Description:
If this setting is non-zero, AccuTerm will answer incoming calls when the session is connected to a modem.
2.3.5.1.8 AutoClose property (Session)
Syntax:
session.AutoClose
Data type: boolean
Description:
If this setting is non-zero, AccuTerm will close the session when it becomes "disconnected" (modem disconnects or host system drops network connection).
2.3.5.1.9 BackgroundPictureFile property
Syntax:
session.BackgroundPictureFile
Data type: string
Copyright 2010-2013 Schellenbach & Assoc., Inc.
116 AccuTerm 7 Help
Description:
This is the name of an image file that is used for the session background.
See also:
BackgroundPictureMode property
BackgroundTransparency property
2.3.5.1.10 BackgroundPictureMode property
Syntax:
session.BackgroundPictureMode
Data type: integer
Description:
This property controls how the background picture is scaled: 0 - picture is stretched to fit screen size.
This may alter the picture's aspect ratio; 1 - picture is scaled so that its longest dimension fills the screen. The area not filled by the picture is black; 2 - picture is scaled so that its shortest dimension fills the screen. The longer dimension is cropped.
See also:
BackgroundPictureFile property
BackgroundTransparency property
2.3.5.1.11 BackgroundTransparency property
Syntax:
session.BackgroundTransparency
Data type: integer
Description:
The BackgroundTransparency property specifies the transparency of the background color or the opacity of the background picture, as a percentage. 100% means that the picture is used as the background,
0% means that the background color is used. Values in between blend the background picture and background color.
See also:
BackgroundPictureFile property
BackgroundPictureMode property
2.3.5.1.12 Baud property
Syntax:
session.Baud
Data type: integer
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 117
Description:
This is the baud rate used by the serial port attached to the session. This property is only meaningful when the communication device type is "Serial Port". Acceptable baud rates are atBaud300
, atBaud1200
,
atBaud2400
,
atBaud9600
,
atBaud14400
,
atBaud19200
,
atBaud38400
,
atBaud57600 and atBaud115200
.
2.3.5.1.13 BkspSendsDel property
Syntax:
session.BkspSendsDel
Data type: boolean
Description:
If this setting is True (non-zero), pressing the Backspace key causes AccuTerm to send the
DEL
control code. Otherwise, AccuTerm sends the
BS
control code.
2.3.5.1.14 BoldFont property
Syntax:
session.BoldFont
Data type: boolean
Description:
Set to True (non-zero) if terminal font is bold, False (zero) if font is normal.
2.3.5.1.15 BreakKeyAction property
Syntax:
session
.
BreakKeyAction
Data type: integer
Description:
This property specifies the action to take when the
CTRL+BREAK
key is pressed. The exact interpretation of this property depends on the connection type.
0 - default action - send normal BREAK signal or character
1 - no break key
2 - send normal break (telnet BREAK command or SSH BREAK command)
3 - send alternate break (telnet IP command or SSH SIGINT signal)
256+
break_char
- send
break_char
character (ASCII code)
2.3.5.1.16 BytesIn property
Syntax:
session.BytesIn
Data type: long
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
118 AccuTerm 7 Help
This read-only property returns the number of bytes received from the host since the session was opened.
2.3.5.1.17 BytesOut property
Syntax:
session.BytesOut
Data type: long
Description:
This read-only property returns the number of bytes transmitted to the host since the session was opened.
2.3.5.1.18 CapsLock property
Syntax:
session
.CapsLock
Data type: boolean
Description:
Set to True (non-zero) to set the state of the CapsLock key; set to False (zero) to reset the CapsLock key state.
2.3.5.1.19 Caption property
Syntax:
session.Caption
Data type: string
Description:
Set or returns the session caption (title).
2.3.5.1.20 CaptureFileName property
Syntax:
session.CaptureFileName
Data type: string
Description:
The name of the file name used in the last capture operation. This property is read-only.
2.3.5.1.21 CaptureMode property
Syntax:
session.CaptureMode
Data type: integer
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 119
Description:
The current capture mode (0 to create a new file, 1 to overwrite an existing file, 2 to append to existing file, or 3 to capture to the clipboard instead of a file). If capture mode has 128 added to it, this indicates that control characters are being filtered from the captured data. This property is read-only.
2.3.5.1.22 CaptureSource property
Syntax:
session.CaptureSource
Data type: integer
Description:
The current capture source (1 to capture received data, 2 to capture printed data). This property is readonly.
2.3.5.1.23 Changed property
Syntax:
session.Changed
Data type: integer
Description:
Non-zero if the settings for the session have been modified. Changing this property to zero prevents the warning about saving changes when the session is closed.
2.3.5.1.24 Charset property
Syntax:
session.Charset
Data type: string
Description:
The character set used by the host. The only valid values are NULL for the default character set for the selected terminal emulation, or "NATIVE" if the host uses the current 8-bit (non-Unicode) Windows character set.
2.3.5.1.25 ClientCertificateID property
Syntax:
session.ClientCertificateID
Data type: string
Description:
If an SSL/Telnet host requires the client to authenticate using a certificate, this property contains the name and/or hash of the desired client certificate. The client certificate must be installed in the current user's "MY" certificate store.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
120 AccuTerm 7 Help
2.3.5.1.26 Col & Row properties
Syntax:
session.Col
session.Row
Data type: integer
Description:
The current cursor column or row. The leftmost column is zero and the topmost row is zero. Also see the
2.3.5.1.27 Color property
Syntax:
session.Color
Data type: integer
Description:
This is the foreground/background color index used when text is displayed using the
SetText
method.
To determine the color index, select the foreground and background colors from the following table, and add the indices of each to form the correct color index:
Color
Black
Dark Blue
Dark Green
Turquoise
Dark Red
Purple
Olive
Light Grey
Dark Grey
Blue
Green
Cyan
Red
Magenta
Yellow
White
8
9
10
5
6
7
11
12
13
14
15
Foreground Background
0
1
2
3
4
0
16
32
48
64
80
96
112
128
144
160
176
192
208
224
240
Note: the actual colors may be different if the palette has been modified!
2.3.5.1.28 Colors() property
Syntax:
session.Colors( index )
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 121
Data type: integer
Description:
This array maps foreground and background colors (using the color
index
described above) to visual attribute combinations. The
index
to the
Colors()
array is the attribute code shown in the following table:
16
18
20
10
12
14
2
4
5
6
8
Index Attribute Description
0 normal
1 blank blink reverse reverse blank reverse blink undereline underline blink underline reverse underline reverse blink dim dim blink dim reverse
32
34
42
44
46
36
38
40
26
28
30
Index Attribute Description
22 dim reverse blink
24 dim underline dim underline blink dim underline reverse dim underline reverse blink bright bright blink bright reverse bright reverse blink bright underline bright underline blink bright underline reverse bright underline reverse blink
The value of this property may include a border effect style which is associated with the visual attribute.
The border effect styles are combined with the foreground and background color as follows: none = fg + bg inset = fb + bg + 16384 raised = fg + bg - 32768 flat = fg + bg - 16384
2.3.5.1.29 Cols & Rows properties
Syntax:
session.Cols
session.Rows
Data type: integer
Description:
The current number of columns or rows. These are read-only properties. Changing the screen mode between normal or extended mode (see
ExtMode
,
NormMode
methods and
ScrMode
property), or changing the value of the
ExtCols
,
ExtRows
,
NormCols
or
NormRows
properties may affect the
Cols
and
Rows
properties.
2.3.5.1.30 Connected property
Syntax:
session.Connected
Copyright 2010-2013 Schellenbach & Assoc., Inc.
122 AccuTerm 7 Help
Data type: boolean
Description:
This read-only property reflects the connection status of the session. For serial connections, it reflects the state of the CD signal; for network connections, it is non-zero if the network connection is OK.
2.3.5.1.31 ConnectTimeout property
Syntax:
session.ConnectTimeout
Data type: integer
Description:
This property is the number of seconds to wait when attempting to make a connection before a timeout error occurs.
2.3.5.1.32 CopyPasteShortcut property
Syntax:
session
.
CopyPasteShortcut
Data type: integer
Description:
Set to 0 for no shortcut, 1 to use
CTRL+INS
/
SHIFT+INS
, or 2 to use
CTRL+C
/
CTRL+V
for Copy / Paste shortcuts.
2.3.5.1.33 CopySelMode property
Syntax:
session
.
CopySelMode
Data type: integer
Description:
Set to 1 to clear the selection rectangle after copying the screen selection to the clipboard. Set to 0 to retain selection rectangle.
2.3.5.1.34 CursorType property
Syntax:
session.CursorType
Data type: boolean
Description:
Set to True (non-zero) if cursor shown as a block, False (zero) if cursor shown as an underline.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 123
2.3.5.1.35 CustomMouseTable property (Session)
Syntax:
session
.CustomMouseTable
Data type: string
Description:
This is the file name of the custom mouse table file for the session. The initial value of this property is the global mouse table file.See Mouse Pattern Matching for more information on using a custom mouse table.
2.3.5.1.36 DataBits property
Syntax:
session.DataBits
Data type: integer
Description:
This is the number of data bits used by the serial port attached to the session. This property is only meaningful when the communication device type is atDevSERIAL
or atDevMODEM
. Acceptable values are
7 or 8. After changing this property, use the
Reset
method for the change to take effect.
2.3.5.1.37 DefaultCaptureDir property
Syntax:
session
.
DefaultCaptureDir
Data type: string
Description:
This is the default destination directory used for file capture operations which do not specify a directory.
2.3.5.1.38 DefaultXferDir property
Syntax:
session.DefaultXferDir
Data type: string
Description:
This is the default destination directory used for file transfer operations which do not specify a directory.
2.3.5.1.39 DefaultXferMode property
Syntax:
session.DefaultXferMode
Data type: integer
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
124 AccuTerm 7 Help
This is default transfer mode: 0 for text, 1 for binary.
2.3.5.1.40 DefaultXferOverwrite property
Syntax:
session.DefaultXferOverwrite
Data type: integer
Description:
This is default overwrite setting for received files. Set to True (non-zero) to allow overwrites, else set to
False (zero). This property only applies to ASCII and Xmodem downloads.
2.3.5.1.41 Device property
Syntax:
session.Device
Data type: integer
Description:
The communications device type attached to the session. The device type may be atDevNONE
for no device (disconnects session), atDevSERIAL
,
atDevTELNET
,
atDevSSH
or atDevMODEM
.
2.3.5.1.42 DeviceLicenseMode property
Syntax:
session
.
DeviceLicenseMode
Data type: integer
Description:
If this setting is non-zero, "device licensing" negotiation between AccuTerm and the host system is enabled. When device licensing has been successfully negotiated, multiple AccuTerm connections
(sessions) to the host system consume only one user license.
To enable device license negotiation, set this value to 1 if the device license response requires a
LF
termination character, or 3 if the response requires no termination character.
Device licensing is supported for UniVerse, UniData and QM host systems. The host system must have device licensing enabled (this is often an extra-charge item).
2.3.5.1.43 DialStatus property
Syntax:
session.DialStatus
Data type: integer
Description:
This read-only property reflects the status of the last
Dial
or
HangUp
method. Status codes are described in the following table:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 125
7
8
9
10
2
3
4
5
6
Status Description
0 Not connected (successful hang-up).
1 Connected (successful dial).
Unable to initialize modem.
Requested number is busy.
Requested number did not answer.
Unable to connect.
Unable to hang-up.
Modem is in use.
Invalid phone number.
Billing rejected.
No dial tone.
2.3.5.1.44 DisableAppMode property
Syntax:
session.DisableAppMode
Data type: boolean
Description:
Setting this property to True (non-zero) prevents AccuTerm from entering "keypad application mode" or
"cursor application mode" when running one of the VT emulations. Set to False to allow application mode.
2.3.5.1.45 Duplex property
Syntax:
session.Duplex
Data type: integer
Description:
This property sets the communications duplex mode to local (no communication to or from host: atDuplexLOCAL)
, full (remote echo: atDuplexFULL
) or half (local echo: atDuplexHALF
).
2.3.5.1.46 ExtCols & ExtRows properties
Syntax:
session.ExtCols
session.ExtRows
Data type: integer
Description:
These properties define the terminal screen dimensions when the terminal is placed into "extended mode", also known as "132 column mode".
Copyright 2010-2013 Schellenbach & Assoc., Inc.
126 AccuTerm 7 Help
2.3.5.1.47 ExtMode method
Syntax:
session.ExtMode
Description:
Causes the session to switch to extended (132 column) mode.
2.3.5.1.48 FileName property
Syntax:
session.FileName
Data type: string
Description:
This is the name of the configuration file opened by the session. If there is no configuration file, then this property is NULL. If you assign a new name to this property, the session will be re-initialized with the settings from the new file.
2.3.5.1.49 FKeys() property
Syntax:
session.FKeys( index )
Data type: string
Description:
This array contains the programmed function and editing key strings. The
index
is formed by combining
(adding) the modifier value with the virtual key number. The special modifier for the function key button bar caption can be combined with one of the standard modifiers to retrieve or store the caption & tooltip text.
The string value of the programmed key is binary, and might not contain printable characters.
Modifier Shift Ctrl Alt
0 no no no
1000
2000 yes no no yes no no
3000
10000
Modifier Shift Ctrl Alt
4000
5000
6000 no yes no no no yes yes yes yes yes yes no 7000 yes yes yes retrieve the function key caption and tip string
Virtual Key Number
F1
F2
112
113
F3
F4
F5
F6
F7
F8
F9
114
115
116
117
118
119
120
Virtual Key Number
Backspace 8
Tab 9
Insert
Delete
Home
End
Page Up 33
Page Down 34
Left 37
45
46
36
35
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 127
Virtual Key Number
F10
F11
F12
121
122
123
F13
F14
F15
F16
124
125
126
127
Virtual Key
Right
Up
Down
Escape
Enter
Number
39
38
40
27
13
Keypad Enter 253
See also:
2.3.5.1.50 FontName property
Syntax:
session.FontName
Data type: string
Description:
This is the name of the terminal font used by the session.
2.3.5.1.51 FontSize property
Syntax:
session.FontSize
Data type: integer
Description:
This is the size of the terminal font in points.
2.3.5.1.52 GmodeEnable property
Syntax:
session.GmodeEnable
Data type: boolean
Description:
Set to True (non-zero) if Tektronix graphics mode is enabled for the session; otherwise set to False
(zero).
2.3.5.1.53 Handshake property
Syntax:
session.Handshake
Data type: integer
Copyright 2010-2013 Schellenbach & Assoc., Inc.
128 AccuTerm 7 Help
Description:
This is the handshake (flow control) method used by the serial port attached to the session. This property is only meaningful when the communications device type is atDevSERIAL
or atDevMODEM
.
Acceptable handshake settings are atHandshakeNONE
,
atHandshakeXON
,
atHandshakeXIO
, atHandshakeRTS
or atHandshakeDTR
.
2.3.5.1.54 Height property (Session)
Syntax:
session.Height
Data type: long
Description:
This is the session window height in pixels.
2.3.5.1.55 HistoryRows property
Syntax:
session.HistoryRows
Data type: integer
Description:
This is the number of rows allocated for the session history buffer. If a buffer is allocated, each time a line is scrolled off the screen, the line is placed in the history buffer. Likewise, whenever the screen is cleared, the contents of the screen before clearing is copied to the history buffer.
2.3.5.1.56 HostCertificateValidation property
Syntax:
session.HostCertificateValidation
Data type: long
Description:
This property determines how the host certificate is validated when connecting using SSL/Telnet. Set this value to 0 if no validation is desired or -1 for strict validation. Otherwise, this is a bit mask with the following values:
1 = host certificate must be signed by a trusted certificate authority
2 = host certificate name must match host name
4 = host certificate must not be expired
8 = host certificate must not be revoked
16 = certificate must be valid for server authentication
2.3.5.1.57 HostKeyFingerprint property
Syntax:
session.HostKeyFingerprint
Data type: string
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 129
Description:
This property contains the hash (fingerprint) of the SSH host key.
2.3.5.1.58 HostKeyValidation property
Syntax:
session.HostKeyValidation
Data type: long
Description:
When using an SSH connection, set this property to 0 to ignore the host's public key, 1 if the host key should be trusted if it has not yet been set, 2 to confirm any change in the host key, or 3 if the key must match the key fingerprint specified in the
HostKeyFingerprint
property.
2.3.5.1.59 HostName property
Syntax:
session.HostName
Data type: string
Description:
This is the name of the host computer system which a session is connected to. This property is only meaningful when the communications device type is Telnet or Secure Shell. You can use the host IP address in place of the host name. After changing this property, use the
Reset
method for the change to take effect.
2.3.5.1.60 HostPort property
Syntax:
session.HostPort
Data type: string
Description:
For Telnet connections, this is the host TCP/IP port number assigned for Telnet services (default port is
23). For Secure Shell connections, it is the TCP/IP port assigned for SSH services (default port is 22).
2.3.5.1.61 HostTermType property
Syntax:
session.HostTermType
Data type: string
Description:
For Telnet and Secure Shell connections, this is the terminal type sent to the host when initiating the connection. This setting is only needed if AccuTerm’s default terminal type is not compatible with the host terminal names.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
130 AccuTerm 7 Help
2.3.5.1.62 hWnd property
Syntax:
session.hWnd
Data type: long
Description:
This read-only value is the window handle for the session’s terminal screen. This handle may be used in
Windows API calls in conjunction with the
Declare
statement.
2.3.5.1.63 Icon property
Syntax:
session.Icon
Data type: string
Description:
This is the name of the icon file used for the session.
2.3.5.1.64 ID property
Syntax:
session.ID
Data type: string
Description:
This is the unique session ID.
2.3.5.1.65 InputMode property
Syntax:
session.InputMode
Data type: integer
Description:
This specifies how received data is processed by the terminal session. If the
InputMode
property is set to 0 (normal), any received data is immediately processed by the terminal emulator. Use this mode when the script is not concerned with the data stream. Setting the mode to 1 (synchronous) allows the terminal emulator to process all data which the script has processed. That is, all received data examined by a
WaitFor
method or
Input
method is also processed by the emulator. Finally, setting the mode to 2
(disconnected) disconnects the terminal emulator from the received data stream. It is up to the script to pass any data to the emulator using the
Emulate
method. If a session was created with the
Sessions.
Add
method, the initial
InputMode
setting may be specified as an argument.
2.3.5.1.66 KeepaliveInterval property
Syntax:
session
.
KeepaliveInterval
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 131
Data type: long
Description:
If this setting is non-zero, AccuTerm will send a special "keepalive" message periodically to maintain the connection (some hosts and routers automatically disconnect when they detect an idle connection.)
This setting is in seconds. Note: enabling k eepalives when connecting to older versions of D3/NT may
cause the error log on the host to fill up.)
2.3.5.1.67 KermitCRC property
Syntax:
session.KermitCRC
Data type: integer
Description:
Set to True (non-zero) to enable CRC block checking, else set to False (zero) to use checksum block checking. If this option is enabled, and the host Kermit supports this option, then a 16 bit CRC is used to verify packet integrity.
2.3.5.1.68 KermitEOL property
Syntax:
session.KermitEOL
Data type: integer
Description:
Specifies the ASCII character to be sent at the end of each Kermit packet. Usually 13 (
CR
), but may be
10 (
LF
) for some hosts.
2.3.5.1.69 KermitErrRetry property
Syntax:
session.KermitErrRetry
Data type: integer
Description:
Specifies the number of times Kermit will retry during a file transfer before the transfer is aborted.
2.3.5.1.70 KermitInitRetry property
Syntax:
session.KermitInitRetry
Data type: integer
Description:
Specifies the number of times Kermit will retry when initiating a file transfer before the transfer is aborted.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
132 AccuTerm 7 Help
2.3.5.1.71 KermitQuote property
Syntax:
session.KermitQuote
Data type: integer
Description:
Set to True (non-zero) to enable the "eighth bit quoting" option, else set to False (zero). If this option is enabled, and the host Kermit supports this option, then any characters which have the eighth bit set are
"quoted" using a sequence of characters which do not have the eighth bit set. This option is useful for connections which do not support eight bit data.
2.3.5.1.72 KermitRept property
Syntax:
session.KermitRept
Data type: integer
Description:
Set to True (non-zero) to enable the run length encoding data compression option, else set to False
(zero). If this option is enabled, and the host Kermit supports this option, then repeated sequences of any character are encoded to compress the data.
2.3.5.1.73 KermitTimeout property
Syntax:
session.KermitTimeout
Data type: integer
Description:
Specifies the number of seconds before Kermit file transfer operations time out.
2.3.5.1.74 Left property (Session)
Syntax:
session.Left
Data type: long
Description:
This is the horizontal position of the session window relative to the upper-left corner of the inside of
AccuTerm’s main window. This value is in pixels.
2.3.5.1.75 LegibleFont property
Syntax:
session.LegibleFont
Data type: boolean
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 133
Description:
Set to True (non-zero) to keep fonts legible when scaling fonts to fit screen; otherwise set to False
(zero).
2.3.5.1.76 LockBaudRate property
Syntax:
session.LockBaudRate
Data type: boolean
Description:
Set to True (non-zero) to lock the modem to the specified baud rate; otherwise set to False (zero). Note: not all modems support this setting.
2.3.5.1.77 LockFKeys property
Syntax:
session
.
LockFKeys
Data type: integer
Description:
Set to 0 for unlocked function keys (host can reset or reprogram keys), 1 to lock from reset (host can reprogram keys, but not reset them) or 2 to lock from programming (host cannot reset or reprogram function keys).
2.3.5.1.78 LockKeyboard property
Syntax:
session.LockKeyboard
Data type: boolean
Description:
Set to True (non-zero) to prevent keystrokes from being sent to the host system; otherwise set to False
(zero).
2.3.5.1.79 MapUpperFKeys property
Syntax:
session.MapUpperFKeys
Data type: boolean
Description:
Setting this property to True (non-zero) causes AccuTerm to map
Ctrl+F1
through
Ctrl+F10
as
F11
to
F20
.
This is the default behavior, since the PC keyboard does not have keys
F13
to
F20
.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
134 AccuTerm 7 Help
2.3.5.1.80 Menu property (Session)
Syntax:
Set
menu_object = session.Menu
Data type: menu object
Description:
This returns a reference to the session
Menu
object, which may be used to customize AccuTerm’s menus and toolbars.
See also:
2.3.5.1.81 MessageRows property
Syntax:
session.MessageRows
Data type: integer
Description:
This property sets the number of message rows and status lines for the session. The value must be between 0 and 3. Note that some emulations do not support any status or message rows, and some only support a single status line. Others support up to 3 lines. For more information, see
2.3.5.1.82 MouseEnable property
Syntax:
session.MouseEnable
Data type: boolean
Description:
Set to True (non-zero) to enable the ESC STX "1" / ESC STX "2"AccuTerm mouse-on command; otherwise set to False (zero).
2.3.5.1.83 NoAutoWrap property
Syntax:
session
.
NoAutoWrap
Data type: boolean
Description:
Set to True (non-zero) to disable automatic line wrap at end of line.
2.3.5.1.84 NormCols & NormRows properties
Syntax:
session.NormCols
session.NormRows
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 135
Data type: integer
Description:
These properties define the terminal screen dimensions when the terminal is placed into "normal mode", also known as "80 column mode".
2.3.5.1.85 NormMode method
Syntax:
session.NormMode
Description:
Causes the session to switch to normal (80 column) mode.
2.3.5.1.86 OnLine property
Syntax:
session.OnLine
Data type: integer
Description:
Setting this property to True (non-zero) initiates the connection to the host. Setting it to False terminates the connection.
2.3.5.1.87 OverrideModemConfig property
Syntax:
session.OverrideModemConfig
Data type: boolean
Description:
Set to True (non-zero) to override modem Control Panel settings for baud rate, data bits, stop bits, parity and handshake with current session settings for these properties; otherwise set to False (zero).
2.3.5.1.88 Page property
Syntax:
session.Page
Data type: integer
Description:
This specifies the number of the current video page for the session. The value must be between 0 and the number of pages allocated for the session minus 1 (see
2.3.5.1.89 Pages property
Syntax:
session.Pages
Copyright 2010-2013 Schellenbach & Assoc., Inc.
136 AccuTerm 7 Help
Data type: integer
Description:
This specifies the number of video pages for the session. The value must be between 1 and 25.
2.3.5.1.90 Palette() property
Syntax:
session.Palette( index )
Data type: OLE_COLOR
Description:
This array contains the color values for the 16 palette entries used to display text on the terminal screen.
The
Color property assigns foreground (text) and background colors based on these 16 colors. You can
use the
RGB()
function to produce an OLE_COLOR from separate red, green and blue values. The red, green and blue values must be in the range of 0 to 255.
11
12
13
8
9
10
14
15
3
4
5
6
7
Palette entry
0
1
2
Color
Black
Dark Blue
Dark Green
Turquoise
Dark Red
Purple
Olive
Light Grey
Dark Grey
Blue
Green
Cyan
Red
Magenta
Yellow
White
An additional 6 palette entries exist for drawing borders (see
). These are:
Palette entry
16
17
18
19
20
21
Used for flat outer border flat inner border shadow outer border shadow inner border highlight outer border highlight inner border
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 137
2.3.5.1.91 Parity property
Syntax:
session.Parity
Data type: integer
Description:
This is the parity setting used by the serial port attached to the session. This property is only meaningful when the communication device type is atDevSERIAL
or atDevMODEM
. Acceptable values are atParityNONE
, atParityEVEN
, atParityODD
, atParityMARK
and atParitySPACE
. After changing this property, use the
Reset
method for the change to take effect.
2.3.5.1.92 PasteEOFChar property
Syntax:
session.PasteEOFChar
Data type: integer
Description:
This is the ASCII character which is transmitted to the host at the end of paste operation. If this value is zero, no character will be transmitted.
2.3.5.1.93 PasteEOFMode property
Syntax:
session.PasteEOFMode
Data type: integer
Description:
Set to 0 if no character is transmitted at the end of a paste operation. Set to 1 if a
SUB
control code is transmitted. Set to 2 to use the character defined by the
PasteEOFChar
property.
2.3.5.1.94 PasteEOLChar property
Syntax:
session.PasteEOLChar
Data type: integer
Description:
This is the ASCII character which is transmitted to the host at the end of each line in a paste operaton. If this value is zero, no character will be transmitted.
2.3.5.1.95 PasteEOLMode property
Syntax:
session.PasteEOLMode
Data type: integer
Copyright 2010-2013 Schellenbach & Assoc., Inc.
138 AccuTerm 7 Help
Description:
Set to 0 if a
CR
is transmitted at the end of each line of a paste operation. Set to 1 if a
LF
is transmitted.
Set to 2 if a
CR+ LF
is transmitted. Set to 3 if a
TAB
is transmitted. Set to 4 if no character is transmitted.
Set to 5 to use the character defined by the
PasteEOLChar
property. If you want to suppress the end-ofline character after the last line, add 128 to this value.
2.3.5.1.96 Port property
Syntax:
session.Port
Data type: integer
Description:
Specifies the COM port number attached to the session. This property is only meaningful when the communication device type is atDevSERIAL
. Acceptable values are from 1 to 127. After changing this property, use the
Reset
method for the change to take effect.
2.3.5.1.97 PrinterColorMode property
Syntax:
session
.
PrinterColorMode
Data type: integer
Description:
If this property is non-zero and the
ScreenPrintMode
property is non-zero (Graphics mode), the screen is printed in color; otherwise the screen is printed in black and white. This property has no effect when the
ScreenPrintMode
property is zero (Text mode).
2.3.5.1.98 PrinterFontBold property
Syntax:
session
.
PrinterFontBold
Data type: boolean
Description:
Set this property to True (non-zero) to print using boldface. This property affects slave (or Aux) print jobs when the
SlavePrintMode
property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero (Text mode).
2.3.5.1.99 PrinterFontItalic property
Syntax:
session
.
PrinterFontItalic
Data type: boolean
Description:
Set this property to True (non-zero) to print using italics. This property affects slave (or Aux) print jobs
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 139
when the
SlavePrintMode
property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero (Text mode).
2.3.5.1.100 PrinterFontName property
Syntax:
session
.
PrinterFontName
Data type: string
Description:
Set this property to the name of the font to use for slave (or Aux) print jobs when the
SlavePrintMode property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero
(Text mode).
2.3.5.1.101 PrinterFontSize property
Syntax:
session
.
PrinterFontSize
Data type: integer
Description:
Set this property to the size (in points) of the font to use for slave (or Aux) print jobs when the
SlavePrintMode
property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode property is zero (Text mode).
2.3.5.1.102 PrinterMode property
Syntax:
session
.
PrinterMode
Data type: integer
Description:
This is the state of the auxiliary printer: 0 if printer is off ( atPrinterOff
), 1 if printer is auto-print mode ( atPrinterOn
), 2 if the printer is in transparent print mode ( atPrinterTransparent
).
2.3.5.1.103 PrinterName property
Syntax:
session
.
PrinterName
session
.
SlavePrinterName
Data type: string
Description:
This is the name of the printer used by the session for slave (or Aux) printer output. It may be set to null
("") to indicate the current Windows default printer, or "no printer" to disable slave printing.
See also:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
140 AccuTerm 7 Help
2.3.5.1.104 PrinterOrientation property
Syntax:
session
.
PrinterOrientation
Data type: integer
Description:
Set this property to 0 use the default page orientation, 1 for portrait or 2 for landscape. This property applies only to slave (or Aux) print jobs and only when the
SlavePrintMode
property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero (Text mode).
2.3.5.1.105 PrinterPaperSize property
Syntax:
session
.
PrinterPaperSize
Data type: integer
Description:
Set this property to 0 use the default paper size for the printer. Otherwise use a paper size from the table below. This property applies only to slave (or Aux) print jobs and only when the
property is non-zero (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero (Text mode).
1 Letter 8 1/2 x 11 in
3 Tabloid 11 x 17 in
5 Legal 8 1/2 x 14 in
7 Executive 7 1/4 x 10 1/2 in
9 A4 210 x 297 mm
11 A5 148 x 210 mm
13 B5 (JIS) 182 x 257 mm
15 Quarto 215 x 275 mm
17 11x17 in
19 Envelope #9 3 7/8 x 8 7/8
21 Envelope #11 4 1/2 x 10 3/8
23 Envelope #14 5 x 11 1/2
25 D size sheet
27 Envelope DL 110 x 220mm
29 Envelope C3 324 x 458 mm
31 Envelope C6 114 x 162 mm
33 Envelope B4 250 x 353 mm
35 Envelope B6 176 x 125 mm
37 Envelope Monarch 3.875 x 7.5 in
39 US Std Fanfold 14 7/8 x 11 in
2 Letter Small 8 1/2 x 11 in
4 Ledger 17 x 11 in
6 Statement 5 1/2 x 8 1/2 in
8 A3 297 x 420 mm
10 A4 Small 210 x 297 mm
12 B4 (JIS) 250 x 354
14 Folio 8 1/2 x 13 in
16 10x14 in
18 Note 8 1/2 x 11 in
20 Envelope #10 4 1/8 x 9 1/2
22 Envelope #12 4 \276 x 11
24 C size sheet
26 E size sheet
28 Envelope C5 162 x 229 mm
30 Envelope C4 229 x 324 mm
32 Envelope C65 114 x 229 mm
34 Envelope B5 176 x 250 mm
36 Envelope 110 x 230 mm
38 6 3/4 Envelope 3 5/8 x 6 1/2 in
40 German Std Fanfold 8 1/2 x 12 in
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 141
41 German Legal Fanfold 8 1/2 x 13 in
2.3.5.1.106 PrinterPaperSource property
Syntax:
session
.
PrinterPaperSource
Data type: integer
Description:
Set this property to 0 use the default paper source for the printer. Otherwise use a paper source from the table below. This property applies only to slave (or Aux) print jobs and only when the
SlavePrintMode property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero
(Text mode).
4
5
6
7
8
1
2
3
Upper tray
Lower tray
Middle tray
Manual feed
Envelope feeder
Envelope manual
Auto
Tractor
2.3.5.1.107 PrinterTimeout property
Syntax:
session
.
PrinterTimeout
Data type: integer
Description:
This property specifies the number of seconds of inactivity before a print job is closed.
2.3.5.1.108 PrintJobEject property
Syntax:
session
.
PrintJobEject
Data type: integer
Description:
This property specifies if a page is ejected before or after a print job. Set this property to 0 for no page ejects, 1 to eject page before print job, 2 to eject page after print job or 3 to eject page before and after print job.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
142 AccuTerm 7 Help
2.3.5.1.109 PrintScreenBackground property
Syntax:
session
.
PrintScreenBackground
Data type: boolean
Description:
Set to True (non-zero) to print the screen background when using the Print Screen command and the
ScreenPrintMode
property is non-zero (Graphics mode); otherwise set to False (zero). This property has no effect when the
ScreenPrintMode
property is zero (Text mode).
2.3.5.1.110 PrintScreenEject property
Syntax:
session
.
PrintScreenEject
Data type: integer
Description:
This property specifies if a page is ejected before or after a print screen. Set this property to 0 for no page ejects, 1 to eject page before print screen, 2 to eject page after print screen or 3 to eject page before and after print screen.
2.3.5.1.111 ProtectAttr property
Syntax:
session
.
ProtectAttr
Data type: integer
Description:
Visual attribute number assigned to "protected fields" under Wyse/ADDS emulation. See
() property for a list of attribute numbers.
2.3.5.1.112 Settings method
Syntax:
With
session.Settings
. . . statements
End With
Data type: settings object
Description:
This object is used to set session settings as a block. It is intended to be used in a
With
Settings . . . End With
structure. When used in this manner, all of the settings which are modified are applied to the session when the
End With
statement is executed. This prevents errors when certain settings depend on others (such as
Port
and
Baud
) and also improves performance. Most of the
Session
properties may be set using this object.
Note: when using the
Settings
object from a .NET language, call the
Apply
method just before
End
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 143
With
due to the due to the way objects are freed in the .NET environment.
2.3.5.1.113 ScaleFont property
Syntax:
session
.
ScaleFont
Data type: boolean
Description:
Set to True (non-zero) to enable automatic font scaling; otherwise set to False (zero).
2.3.5.1.114 ScreenPrintAdapterScript property
Syntax:
session
.
ScreenPrintAdapterScript
Data type: string
Description:
This is the name of the print adapter script file to use for screen printing. Print adapter scripts are used to process the print job using an external program, such as Print Wizard. To use the print adapter script, the
property must be set to 2. See
Screen Printer Settings for more information on
print adapters.
2.3.5.1.115 ScreenPrinterName property
Syntax:
session
.
ScreenPrinterName
Data type: string
Description:
This is the name of the printer used by the session for screen printing. It may be set to null ("") to indicate the current Windows default printer, or "no printer" to disable screen printing.
See also:
2.3.5.1.116 ScreenPrintMode property
Syntax:
session
.
ScreenPrintMode
Data type: integer
Description:
Set to 0 for text mode, 1 for graphics mode or 2 to use the print adapter script specified by the
property. When this property is 1, the
properties affect how the screen is printed.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
144 AccuTerm 7 Help
2.3.5.1.117 ScreenPrintOrientation property
Syntax:
session
.
ScreenPrintOrientation
Data type: integer
Description:
Set this property to 0 use the default page orientation, 1 for portrait or 2 for landscape. This property applies only to screen printing and only when the
property is 1 (Graphics mode). This
property has no effect when the
ScreenPrintMode
property is zero (Text mode).
2.3.5.1.118 ScreenPrintPaperSize property
Syntax:
session
.
ScreenPrintPaperSize
Data type: integer
Description:
Set this property to 0 use the default paper size for the printer. Otherwise use a paper size from the table shown in the
property. This property applies only when the
property is non-zero (Graphics mode). This property has no effect when the
ScreenPrintMode
property is zero (Text mode).
2.3.5.1.119 ScreenPrintPaperSource property
Syntax:
session
.
ScreenPrintPaperSource
Data type: integer
Description:
Set this property to 0 use the default paper source for the printer. Otherwise use a paper source from the table shown in the
property. This property applies only to screen printing and only when the
property is 1 (Graphics mode). This property has no effect when the
ScreenPrintMode
property is zero (Text mode).
2.3.5.1.120 ScrMode property
Syntax:
session
.
ScrMode
Data type: integer
Description:
Set to zero for normal (80 column) mode, 1 for extended (132 column) mode.
2.3.5.1.121 ScrollMode property
Syntax:
session
.
ScrollMode
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 145
Data type: integer
Description:
This controls the appearance of the vertical scroll bar: 0=no scroll bar (scroll bar is only visible if the current number of Rows will not fit in the current window size), 1=always show scroll bar, and
2=automatically show scroll bar when cursor is positioned near right border of window.
2.3.5.1.122 Selection property
Syntax:
session
.
Selection
Data type: string
Description:
Returns the current selection, if any. Lines are separated by
CR LF
. If there is no current selection, returns null ("").
See also:
2.3.5.1.123 ShowErrs property
Syntax:
session
.
ShowErrs
Data type: boolean
Description:
Set to True (non-zero) to enable notification of communications errors; otherwise set to False (zero).
2.3.5.1.124 SlavePrintAdapterScript property
Syntax:
session
.
SlavePrintAdapterScript
Data type: string
Description:
This is the name of the print adapter script file to use for slave (Aux) print jobs. Print adapter scripts are used to process the print job using an external program, such as Print Wizard. To use the print adapter script, the
property must be set to 2. See
for more information on print adapters.
2.3.5.1.125 SlavePrinterName property
Syntax:
session
.
PrinterName
session
.
SlavePrinterName
Copyright 2010-2013 Schellenbach & Assoc., Inc.
146 AccuTerm 7 Help
Data type: string
Description:
This is the name of the printer used by the session for slave (or Aux) printer output. It may be set to null
("") to indicate the current Windows default printer, or "no printer" to disable slave printing.
See also:
2.3.5.1.126 SlavePrintMode property
Syntax:
session
.
SlavePrintMode
Data type: integer
Description:
Set to 0 for text mode, 1 for graphics mode or 2 to use the print adapter script specified in the
property. When this property is 1, the
PrinterFont…
,
PrinterOrientation
,
PrinterPaperSize
and
PrinterPaperSource
properties affect how the slave (Aux) print job is printed.
Print adapter scripts are used to process the print job using an external program, such as PrintWizard.
See
Slave Printer Settings for more information on print adapters.
2.3.5.1.127 Sound property
Syntax:
session
.
Sound
Data type: string
Description:
This property may be used to specify a custom sound for the terminal beep. Set this property to null to use the default sound. Set to a valid WAVE, MP3 or MIDI file name to play the specified wave file. Set to
“SystemDefault”, “SystemHand”, “SystemExclamation” or “SystemAsterisk” to use the sound associated with a system event (as defined in the Control Panel Sounds applet). Set to frequency,
duration to use a true “beep” at the specified frequency (Hz) and duration (ms).
2.3.5.1.128 SSHAuth property
Syntax:
session
.
SSHAuth
Data type: integer
Description:
This property may be used to select the authentication method which will be used by a Secure Shell
(ssh) session to authenticate a user to the host. Available authentication methods are: public key (2), password (3) and interactive (7). Use zero (0) for the default authentication method (password).
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 147
2.3.5.1.129 SSHCipher property
Syntax:
session
.
SSHCipher
Data type: integer
Description:
This property may be used to select a cipher to be used to encrypt a Secure Shell (ssh) session.
Available ciphers are: Triple DES (3), Blowfish (6), 128 bit AES (7) and 256 bit AES (8). Use zero (0) for the default cipher (Triple DES for SSH1 or 128 bit AES for SSH2).
2.3.5.1.130 SSHKey property
Syntax:
session
.
SSHKey
Data type: string
Description:
This property contains the name of the SSH private key file. If no path is included, AccuTerm's default key folder will be used to read the key file.
2.3.5.1.131 SSHUseOnlyPreferredCipher property
Syntax:
session
.
SSHUseOnlyPreferredCipher
Data type: boolean
Description:
Set to True (non-zero) to require that the cipher used for an SSH connection is the cipher specified by the
property. If the host system does not accept the preferred cipher, the connection is
aborted.
2.3.5.1.132 SSHVersion property
Syntax:
session
.
SSHVersion
Data type: integer
Description:
This property may be used to select the desired SSH protocol version. Set this property to zero (0) for automatic protocol selection. Set to 1 for SSH version 1 or set to 2 for SSH version 2. When automatic protocol selection is used, AccuTerm selects the highest protocol version supported by the host.
2.3.5.1.133 StopBits property
Syntax:
session
.
StopBits
Copyright 2010-2013 Schellenbach & Assoc., Inc.
148 AccuTerm 7 Help
Data type: integer
Description:
This is the number of stop bits used by the serial port attached to the session. This property is only meaningful when the communication device type is atDevSERIAL
or atDevMODEM
. Acceptable values are
1 or 2. After changing this property, use the
Reset
method for the change to take effect.
2.3.5.1.134 Strip8th property
Syntax:
session
.
Strip8th
Data type: boolean
Description:
Set to True (non-zero) to cause AccuTerm to truncate received data to 7 bits; otherwise set to False
(zero).
2.3.5.1.135 TcpIdn property
Syntax:
session
.
TcpIdn
Data type: boolean
Description:
Set this property to True (non-zero) to enable Internationalized Domain Names (IDN) for the host name. I
DN relies upon a standardized mechanism known as "Punycode" for encoding Unicode domain names using only the ASCII characters that are permitted by the global DNS system.
2.3.5.1.136 TcpNoDelay property
Syntax:
session
.
TcpNoDelay
Data type: boolean
Description:
Normally, the TCP network stack delays outbound network messages for a short time in order to
"coalesce" multiple small messages into a single packet. When this setting is True (non-zero),
AccuTerm will send each message as soon as possible. Setting this option may improve throughput, especially when running in AccuTerm's GUI environment and during file transfers, at the expense of increased network traffic.
2.3.5.1.137 TelnetBinary property
Syntax:
session
.
TelnetBinary
Data type: boolean
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 149
Set to True (non-zero) to enable Telnet binary communication mode; otherwise set to False (zero) for text communication mode.
2.3.5.1.138 TelnetBypass property
Syntax:
session
.
TelnetBypass
Data type: boolean
Description:
Set to True (non-zero) to bypass initial option negotiation; otherwise set to False (zero) for normal negotiation. This is required for certain hosts like D3 which do not implement the complete Telnet protocol.
2.3.5.1.139 TelnetKeepaliveIsNOP property
Syntax:
session
.
TelnetKeepaliveIsNOP
Data type: boolean
Description:
Set to True (non-zero) to send Telnet NOP command for keepalives; otherwise, sends Telnet DMARK command for keepalives.
2.3.5.1.140 TermType property
Syntax:
session
.
TermType
Data type: integer
Description:
This is the terminal emulation setting for the session. Possible values are: atTermTTY atTermVPA2 atTermVP60 atTermP60 atTermA2E atTermWY50 atTermWY60 atTermVT52 atTermVT100 atTermVT220 atTermVT320 atTermVT420 atTermLinux atTermSCO basic TTY
ADDS Viewpoint A2
ADDS Viewpoint 60
ProComm Viewpoint 60
ADDS Viewpoint A2 Enhanced
Wyse 50
Wyse 60
DEC VT-52
DEC VT-100
DEC VT-220
DEC VT-320
DEC VT-420
Linux console
SCO console
Copyright 2010-2013 Schellenbach & Assoc., Inc.
150 AccuTerm 7 Help
atTermANSI atTermPICKMON atTermP30 atTermTEK atTermTEK4100
ANSI BBS
Pick PC Monitor
MDIS P30
Tektronix 4014
Tektronix 4100
2.3.5.1.141 TextFileEncoding property
TextFileEncoding property
Syntax:
session.TextFileEncoding
Data type: integer
Description:
Sets the encoding to use for dow nloaded or captured text files. Set to 1 for ANSI, 2 for Unicode, 3 for UTF-8 or 0 for raw
(no encoding).
2.3.5.1.142 Top property (Session)
Syntax:
session
.
Top
Data type: long
Description:
This is the vertical position of the session window relative to the upper-left corner of the workspace area of AccuTerm’s main window. This value is in pixels.
2.3.5.1.143 Visible property (Session)
Syntax:
session
.
Visible
Data type: boolean
Description:
Set to True (non-zero) to make the session window visible. Set to False to hide the session window.
2.3.5.1.144 Width property (Session)
Syntax:
session
.
Width
Data type: long
Description:
This is the session window width in pixels.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 151
2.3.5.1.145 WindowState property (Session)
Syntax:
session
.
WindowState
Data type: integer
Description:
This is the state of the session window. Set to 0 for normal, 1 for minimized or 2 for maximized.
2.3.5.1.146 XferBytes property
Syntax:
session
.
XferBytes
Data type: long
Description:
This read-only property is the number of bytes transferred as a result of the last file transfer operation.
2.3.5.1.147 XferFiles property
Syntax:
session
.
XferFiles
Data type: long
Description:
This read-only property is the number of files transferred as a result of the last file transfer operation.
2.3.5.1.148 XferStatus property
Syntax:
session
.
XferStatus
Data type: integer
Description:
This read-only property reflects the status of the last
Upload
or
Download
method. Status codes are described in the following table:
Status
4
7
2
3
-1
0
1
Description
File transfer in progress.
File transfer successful.
Invalid source file or invalid destination directory.
File transfer aborted by user.
Destination file already exists.
File transfer timed out.
File transfer protocol failure.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
152 AccuTerm 7 Help
Status
8
9
10
Description
X/Y/ZModem require 8 data bits.
X/YModem require hardware flow control.
Destination file is write protected.
2.3.5.1.149 XmodemTimeout property
Syntax:
session.XmodemTimeout
Data type: integer
Description:
Specifies the number of seconds before Xmodem file transfer operations time out.
2.3.5.1.150 YmodemTimeout property
Syntax:
session.YmodemTimeout
Data type: integer
Description:
Specifies the number of seconds before Ymodem file transfer operations time out.
2.3.5.1.151 ZmodemAuto property
Syntax:
session.ZmodemAuto
Data type: integer
Description:
Set to True (non-zero) to enable automatic Zmodem downloads, otherwise set to False (zero).
2.3.5.1.152 ZmodemTimeout property
Syntax:
session.ZmodemTimeout
Data type: integer
Description:
Specifies the number of seconds before Zmodem file transfer operations time out.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 153
2.3.5.2
Session methods
2.3.5.2.1 Activate method (Session)
Syntax:
session.Activate
Description:
Makes the session the "active" session. There is no return value.
2.3.5.2.2 Break method
Syntax:
session.Break
Description:
Sends a "break" signal to the host connected to the session. There is no return value.
2.3.5.2.3 Capture method
Syntax:
session.Capture filename , source , mode
Description:
Initiates or terminates data capture mode. If
source
is zero, capture mode for session is terminated. Set
source
to 1 to initiate capture of received data, 2 to initiate capture of printed data. Set
mode
to 0 to create a new file, 1 to overwrite an existing file, 2 to append to existing file, or 3 to capture to the clipboard instead of a file. Add 128 to
mode
to capture text only (filters out control characters). If
source
is zero or
mode
is 3 or 131, then
filename
is ignored, otherwise it is the name of the file where captured data is saved.
2.3.5.2.4 CaptureEnd method
Syntax:
session.CaptureEnd
Description:
Terminates any capture operation and closes the capture file.
2.3.5.2.5 Clear method
Syntax:
session.Clear
[
left
[
,
top
[
,
right
[
,
bottom
[
,
color
]]]]]
Description:
Clears block of text from session screen to specified background color. Default coordinates are the upper left and lower right corners of the screen. To specify
color
, use the color index described under
Copyright 2010-2013 Schellenbach & Assoc., Inc.
154 AccuTerm 7 Help
2.3.5.2.6 ClearSelection method
Syntax:
session.ClearSelection
Description:
This removes any selection rectangle from the session screen. There is no return value.
This method is the same as the Deselect method.
2.3.5.2.7 Close method (Session)
Syntax:
session.Close
[
prompt
]
Description:
This closes the session. If
prompt
= 1 or 3, and If any session settings have been modified subsequent to loading or saving the session, the user will be prompted whether to save the settings. If
prompt
= 2 or
3, and the session is connected via a network or dialup connection, the user will be prompted to disconnect. If
prompt
is zero, the session is closed without prompting.
This method is the same as the Terminate method, but is not available when using late binding.
2.3.5.2.8 Copy method
Syntax:
session.Copy
[
left
[
,
top
[
,
right
[
,
bottom
]]]]
Description:
Copies a block of text from session screen to the clipboard. Default coordinates are the upper left and lower right corners of the screen or the current selection if one is present. Negative row numbers will copy from the history buffer; row –1 is the last history row, etc.
2.3.5.2.9 CopyHistory method
Syntax:
session.CopyHistory
[
left
[
,
top
[
,
right
[
,
bottom
]]]]
Description:
Copies a block of text from session history screen to the clipboard. Default coordinates are the upper left and lower right corners of the history screen.
2.3.5.2.10 Delete method
Syntax:
session.Delete
Description:
This deletes (closes) the session. There is no return value.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 155
2.3.5.2.11 Deselect method
Syntax:
session.Deselect
Description:
This removes any selection rectangle from the session screen. There is no return value.
This method is the same as the ClearSelection method.
2.3.5.2.12 Dial method
Syntax:
result = session.Dial( PhoneNumber )
Description:
Uses the Auto-Dialer to dial a specified phone number. The return value specifies the result of the dialing operation. See the
DialStatus
property for a description of the return codes. This method only works if the
Device
property is atDevModem
.
2.3.5.2.13 Download method
Syntax:
result = session.Download(target , protocol ,
binary
[
,
overwrite
]
)
Description:
Downloads a file from a host system to the user’s PC.
Target
is the name of the destination file (ASCII or XModem protocol), or the name of the destination directory (Kermit, YModem or ZModem protocol).
Protocol
is atProtocolASCII, atProtocolKermit, atProtocolXmodem, atProtocolYmodem
or atProtocolZmodem
.
Binary
is True (non-zero) for binary transfer mode, False (zero) for text transfer mode.
Overwrite
must be atProtect
or atOverwrite
, and is only meaningful for ASCII and Xmodem downloads.
2.3.5.2.14 Emulate method
Syntax:
session.Emulate text
Description:
Causes the terminal emulator to process the specified text, including control codes and escape sequences.
2.3.5.2.15 GetBlock method
Syntax:
Set
scrblk = session.GetBlock (left , top , right ,
bottom ,
[
page
]
)
Description:
Creates a
ScreenBlock
object containing the contents of the specified block. The returned object contains all text, attribute, color, protect and character set information contained within the block.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
156 AccuTerm 7 Help
Default
page
is the current page. This method, when used with the
SetBlock
method, may be used to effect "windowing". The return value of this method must be assigned to a variable which has been declared as type
ScreenBlock
.
See also:
2.3.5.2.16 GetSelection method
Syntax:
sel = session.GetSelection ( left , top , right , bottom )
Description:
Gets the coordinates of the selection rectangle on the session screen. The return value
sel
is True (nonzero) if a selection is present; otherwise it is False (zero).
See also:
2.3.5.2.17 GetText method
Syntax:
text = session.GetText ( [ col [
,
row [
,
cols [
,
mode ]]]]
)
Description:
Returns the text contents of a row on the terminal screen. Default col and row is the current cursor location. Default number of columns is to the end of the row. Use zero for mode to return all normal characters on the row, including protected characters. Use 1 to return non-protected characters only.
Add 2 to include line-drawing character and special symbols (Unicode). Non-negative row numbers refer to the active (non-history) area of the terminal screen (zero is the first data row of the active screen).
Negative row numbers refer to history rows (row -1 is the last history row).
2.3.5.2.18 Hangup method
Syntax:
result = session.Hangup()
Description:
Uses the Auto-Dialer to disconnect (hangup) a modem call. The return value specifies the result of the hangup operation. See the
DialStatus
property for a description of the return codes.
2.3.5.2.19 Hide method (Session)
Syntax:
session.Hide
Description:
This method makes the session window invisible.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 157
2.3.5.2.20 Input method
Syntax:
result = session.Input( [ mode [
,
maxlen [
,
timeout
]]]
)
Description:
This method accepts input from the communications device attached to the session. If
mode
is 0
(default), raw data is returned, up to
maxlen
characters or until
timeout
seconds have passed. If
mode
is
1, a "line" of data is returned, up to
maxlen
characters or until
timeout
seconds have passed. A "line" is terminated by a
CR
,
LF
,
CR+ LF
or
LF+ CR
. The terminator is not returned as part of the input. Default values for
maxlen
and
timeout
are 80 and 30 respectively.
This method is not available when using late binding; use the ReadText method instead.
2.3.5.2.21 LoadImage method
Syntax:
session.LoadImage filename , col , row
[
,
width
[
,
height
[
,
preserveaspect
[
,
borderstyle
] ] ] ]
Description:
Creates an image on the terminal screen at the location specified by
col
and
row
.
Filename
specifies the name or URL of the image file. Image file formats supported are BMP, JPEG, GIF, PCD, PCX, PICT,
PNG, PSD, TARGA, TIFF, WBMP, XBM, XPM and Windows Metafile. If
width
and
height
are specified, then the image is scaled to fit the specified area; otherwise the image is displayed in its actual dimensions. If
preserveaspect
is non-zero, then the aspect ratio of the original image is preserved by reducing either width or height. To enclose the image in a border, specify
borderstyle
of 0 for none, 1 for simple, 2 for raised or 3 for inset. Multiple images may be loaded on the terminal screen. Images are considered "protected" data; a "clear un-protected characters" command will not clear images from the terminal screen.
2.3.5.2.22 Locate method
Syntax:
session.Locate col , row
[
,
page
]
Description:
Moves the cursor to the specified screen location and optionally changes pages.
2.3.5.2.23 MouseTableAdd method
Syntax:
session.MouseTableAdd button
[
,
pattern
[
,
click
[
,
dblclk
]]]
Description:
Adds an entry to the mouse pattern table for the session. The mouse pattern table is used to associate patterns on the screen with responses to be sent to the host when the mouse is clicked.
Button
is 1 for left button, 2 for right button and 3 for middle button.
Pattern
is a string containing a "regular expression" describing the pattern to be matched.
Click
is a string, and is sent to the host when the specified button
Copyright 2010-2013 Schellenbach & Assoc., Inc.
158 AccuTerm 7 Help
is clicked over the pattern.
Dblclk
is the response if the button is double-clicked over the pattern. See
Mouse Pattern Matching for more information on using a custom mouse table.
2.3.5.2.24 MouseTableLoad method
Syntax:
session.MouseTableLoad filename
Description:
Loads a mouse pattern table from a file. See Mouse Pattern Matching for more information on using a custom mouse table.
2.3.5.2.25 MouseTableReset method
Syntax:
session.MouseTableReset
Description:
Clears the mouse pattern table.
2.3.5.2.26 Move method (Session)
Syntax:
session.Move left
[
,
top
[
,
width
[
,
height
]]]
Description:
Repositions and resizes the session window. The positions and dimensions are specified in pixels, and are relative to the upper-left corner of the workspace area in AccuTerm’s main window.
2.3.5.2.27 Output method
Syntax:
session.Output expr
Description:
This method transmits data to the host using the communications device attached to the session.
Transmits
expr
(a string expression) to the connected host computer.
This method is the same as the WriteText method.
2.3.5.2.28 Paste method
Syntax:
session.Paste
[
filename
]
Description:
Copies the text contents of the clipboard (or file if
filename
is specified) to the host.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 159
2.3.5.2.29 PlayMidi method
Syntax:
session.PlayMidi filename
Description:
Plays the media file specified by
filename
.
Filename
may specify a local file or a URL. WAVE, MP3 and
MIDI media files are supported.
2.3.5.2.30 PlayWave method
Syntax:
session.PlayWave filename
Description:
Plays the media file specified by
filename
.
Filename
may specify a local file or a URL. WAVE, MP3 and
MIDI media files are supported.
2.3.5.2.31 PrinterClose method
Syntax:
session
.
PrinterClose
Description:
Closes the current print job.
2.3.5.2.32 PrinterOff method
Syntax:
session
.
PrinterOff
Description:
Turns off the slave (or Aux) printer.
2.3.5.2.33 PrinterOn method
Syntax:
session
.
PrinterOn
[
mode
]
Description:
Turns on the slave (or Aux) printer. If
mode
is zero (default), printer is in "copy" mode (data is displayed on both the screen and printer). Otherwise, printer is in "transparent" mode (data is sent to the printer only, not the screen).
2.3.5.2.34 PrintScreen method
Syntax:
session
.
PrintScreen
Description:
Prints the text screen to the printer.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
160 AccuTerm 7 Help
2.3.5.2.35 ReadText method
Syntax:
result = session.ReadText( [ mode [
,
maxlen [
,
timeout
]]]
)
Description:
This method accepts input from the communications device attached to the session. If
mode
is 0
(default), raw data is returned, up to
maxlen
characters or until
timeout
seconds have passed. If
mode
is
1, a "line" of data is returned, up to
maxlen
characters or until
timeout
seconds have passed. A "line" is terminated by a
CR
,
LF
,
CR+ LF
or
LF+ CR
. The terminator is not returned as part of the input. Default values for
maxlen
and
timeout
are 80 and 30 respectively.
This method is the same as the Input method, and is available when using late binding.
2.3.5.2.36 Reset method
Syntax:
session.Reset
[
mode
]
Description:
Resets the terminal (
mode
= 1 or atResetTerminal
), the communication device (
mode
= 2 or atResetComm
), both (default,
mode
= 0 or atResetAll
) or closes the connection (
mode
= 3 or atCloseComm
). Note: you may need to reset the communication device after changing certain device related properties in order for the changes to take effect.
2.3.5.2.37 ResetComm method
Syntax:
session.ResetComm
Description:
Resets the communication device. Note: you may need to reset the communication device after
changing certain device related properties in order for the changes to tak e effect.
2.3.5.2.38 ResetTerm method
Syntax:
session.ResetTerm
Description:
Resets the terminal emulator for session (clears screen, resets protect mode, unlocks keyboard, etc.)
2.3.5.2.39 Resize method (Session)
Syntax:
session.Resize width,height
Description:
Resizes a session window. The dimensions are specified in pixels.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 161
2.3.5.2.40 Save method
Syntax:
session
.
Save
[
filename
]
Description:
Saves the session configuration. If
filename
is not specified, the original file name is used. If there is no file name for the session, the user will be prompted for a file name.
2.3.5.2.41 SaveAs method
Syntax:
session
.
SaveAs
Description:
Saves the session configuration prompting for file name.
2.3.5.2.42 ScrollHistory method
Syntax:
session
.
ScrollHistory
cmd
Description:
This method manipulates the history scroll position.
Cmd
= atScrlHistLineUp
(0) to scroll the history up one line; atScrlHistLineDown
(1) to scroll the history down one line, atScrlHistPageUp
(2) to scroll up one page, atScrlHistPageDown
(3) to scroll down one page, atScrlHistTop
(6) to scroll to the top
(first line) of the history, atScrlHistBottom
(7) to scroll to the bottom (live screen).
2.3.5.2.43 Select method
Syntax:
session.Select
[
left
[
,
top
[
,
right
[
,
bottom
]]]]
Description:
Places a selection rectangle on the session screen. Defaults are upper left corner and lower right corner of screen.
This is the same as the SetSelection method, but is not available when using late binding.
See also:
2.3.5.2.44 SetBlock method
Syntax:
session.SetBlock ScreenBlock , left , top ,
[
page
]
Description:
Copies the contents of
ScreenBlock
object
ScreenBlock
to the specified location on the screen. The copied block contains all text, attribute, color, protect and character set information. Default
page
is the current page. This method must be used with the
GetBlock
method, and may be used to effect
"windowing".
Copyright 2010-2013 Schellenbach & Assoc., Inc.
162 AccuTerm 7 Help
See also:
2.3.5.2.45 SetExtension method
Syntax:
session.SetExtension leadin, terminator
Description:
If
leadin
is not NULL, then this method enables the session
Extension
event. This event may be used to extend the functionality of AccuTerm’s emulation engine. The
leadin
string specifies one or more "leadin" character codes, which, when preceded by the
ESC
control code, signal the start of an "extended" function. Receipt of one of the characters in the
terminator
string signals the end of the "extended" function. If
terminator
is NULL, then the next character after one of the
leadin
characters signals the end of the "extended" function. When the
Extension
event is fired, the string beginning with the
leadin
character and ending with the
terminator
character is passed to the event handler. If leadin is NULL, then the
Extension
event is disabled. Note: only characters which form invalid terminal escape
sequences should be used for
leadin
, otherwise the extension will not function.
2.3.5.2.46 SetSelection method
Syntax:
session.SetSelection [ left [
,
top [
,
right [
,
bottom
]]]]
Description:
Places a selection rectangle on the session screen. Defaults are upper left corner and lower right corner of screen.
This is the same as the Select method, and is available when using late binding.
See also:
2.3.5.2.47 SetText method
Syntax:
session.SetText text
[
,
col
[
,
row
[
,
color
]]]
)
Description:
Copies
text
(a string expression) to the specified location on the session screen. Default location is the current cursor location. Default color is last color used, or value assigned to the
Color
property. The cursor location is updated by this method.
2.3.5.2.48 Show method (Session)
Syntax:
session
.
Show
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 163
Makes the session window visible.
2.3.5.2.49 Terminate method (Session)
Syntax:
session.Terminate
[
prompt
]
Description:
This closes the session. If
prompt
= 1 or 3, and If any session settings have been modified subsequent to loading or saving the session, the user will be prompted whether to save the settings. If
prompt
= 2 or
3, and the session is connected via a network or dialup connection, the user will be prompted to disconnect.
This method is the same as the Close method, and is available when using late binding.
2.3.5.2.50 UnloadImage method
Syntax:
session.UnloadImage
[
filename
]
Description:
Removes an image created with the
LoadImage
method from the terminal screen. The image to be removed is identified by
filename
. If
filename
is not specified, the all images are removed.
2.3.5.2.51 Upload method
Syntax:
result = session.Upload(source , protocol , binary
[
,
overwrite
]
)
Description:
Uploads a file from the user’s PC to the connected host system.
Source
is the name of the source file(s)
(Kermit, Ymodem and Zmodem may use wild-card characters in
source
).
Protocol
is atProtocolASCII
, atProtocolKermit
,
atProtocolXmodem
,
atProtocolYmodem
or atProtocolZmodem
.
Binary
is True
(non-zero) for binary transfer mode, False (zero) for text transfer mode.
Overwrite
is meaningful for
Zmodem only and must be atProtect
,
atOverwrite
,
atAppend
,
atNewer
,
atUpdate
or atResume
.
2.3.5.2.52 WaitFor method
Syntax:
result = session.WaitFor(mode, timeout, string1
[ , ... ,
string10])
Description:
This method causes AccuTerm to wait for one or more strings to be received from the host system.
Returns the index of the string first matched, or zero (0) if no string matched within
timeout
seconds. If
mode
is zero, a case-sensitive comparison is performed, otherwise the comparison is case-insensitive.
Up to ten target strings may be specified.
For the
WaitFor
method to work properly, the session
InputMode
property should be set to 1 or 2.
Otherwise, the terminal emulation process may process characters received from the host before the
WaitFor
function has a chance to examine them.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
164 AccuTerm 7 Help
2.3.5.2.53 WriteText method
Syntax:
session.WriteText expr
Description:
This method transmits data to the host using the communications device attached to the session.
Transmits
expr
(a string expression) to the connected host computer.
This method is the same as the Output method.
2.3.5.3
Session events
2.3.5.3.1 DataReady event
Syntax:
object_DataReady()
Description:
This event is fired when the session’s
InputMode
property is non-zero, and data has been received from the host and is ready to be read using the
Input
method.
2.3.5.3.2 Extension event
Syntax:
object_Extension(text as String)
Description:
This event is fired when one of the extension prefix and suffix characters have been received by the emulation engine. This event is used to extend the functionality of the emulation engine. Use the
SetExtension
method to specify the prefix and suffix characters.
2.3.6
The Sessions Collection
You can create (open) a new
session , and you can access any opened session by using the
Sessions collection. The
Sessions
collection acts like an array of
Session
objects with one element for each open session.
The
Sessions
collection is used to access any open session by using an array reference:
Set obj = Sessions(
index) returns a
Session
object for session
index
. Session indexes are numbered from zero; the first open session is
Sessions(0)
. The last session is
Sessions(Sessions.Count() – 1)
.
Sessions methods
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 165
2.3.6.1
Sessions methods
2.3.6.1.1 Add method
Syntax:
Set
object = Sessions.Add
(
[
filename
[
,
state
[
,
mode
[
,
hidden
]]]]
)
Description:
The
Sessions.Add
method creates and initializes a new session. The return value is a
Session
object:
All arguments are optional:
filename
configuration file name used to initialize session.
state mode hidden object
initial window state (0 = normal, 1 = minimized, 2 = maximized) input mode (0 = normal, 1 = synchronous, 2 = disconnected)
0 if new session is initially visible, 1 if hidden session object created by this method
2.3.6.1.2 AddClone method
Syntax:
Set
object = Sessions.AddClone
(
session
[
,
state
[
,
mode
[
,
hidden
]]]]
)
Description:
The
Sessions.AddClone
method creates and initializes a new session from an existing session. The return value is a
Session
object. Except for the
session
argument, arguments are optional:
session
source session from which the clone is made.
state mode hidden object
initial window state (0 = normal, 1 = minimized, 2 = maximized) input mode (0 = normal, 1 = synchronous, 2 = disconnected)
0 if new session is initially visible, 1 if hidden session object created by this method
2.3.6.1.3 Count method
Syntax:
count = Sessions.Count()
Description:
The
Sessions.Count
method returns the number of open sessions.
2.3.7
The Settings Object
The
Settings
method of the
Session
object returns a reference to a temporary
Settings
object. This temporary object is used to retrieve or modify a number of properties as a group. When changing multiple properties, using the
Settings
object improves efficiency.
Nearly all of the properties of the
Settings
object are identical to properties of the
Session
object or to properties of the
AccuTerm
object. Certain properties of the
Settings
object (and all methods of this object) should not be used in scripts or in automation. These properties and methods are noted, and they should only be used when using the AccuTerm Emulator Control in another (custom) application.
The recommended way to use the
Settings
object is in a
With Session.Settings … End With
Copyright 2010-2013 Schellenbach & Assoc., Inc.
166 AccuTerm 7 Help
construct.
Note: when using the
Settings
object from a .NET language, call the
Apply
method just before
End
With
due to the way objects are freed in the .NET environment.
Settings properties
BackgroundPictureFile property
BackgroundPictureMode property
BackgroundTransparency property
(do not use in scripts)
HostCertificateValidation property
Copyright 2010-2013 Schellenbach & Assoc., Inc.
PrintScreenBackground property
ScreenPrintAdapterScript property
ScreenPrintOrientation property
ScreenPrintPaperSource property
SlavePrintAdapterScript property
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 167
168 AccuTerm 7 Help
SSHUseOnlyPreferredCipher property
Settings methods (do not use in scripts)
2.3.7.1
Settings methods
2.3.7.1.1 Apply method
do not use in scripts
Syntax:
settings.Apply
Description:
The Apply method applies any changed properties to the emulator.
2.3.7.1.2 Dialog method
do not use in scripts
Syntax:
settings.Dialog
[
Title
, [
InitSel
, [
Categories
]]]
Description:
This method displays the emulator settings dialog box which will allow the user to modify most settings.
You can specify an optional
Title
for the dialog, as well as the initially selected item
InitSel
, and a list of
Categories
which are displayed. The
Categories
list is a string with a single letter for each category to show in the dialog. If the
categories
argument is null, all categories are shown. Sub-categories for
Connection (D1...D7), Colors (C0...C2) and Printer (P1...P2) are also possible, if only a specific settings panel is desired.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 169
Category code
O
A
D
P
Q
K
F
T
S
C
B
H
E
X
W
R
Initial selection
Category
3
General Options
Files & Folders
Connection
4
5
7
8
6
1
Term Type
Screen
Colors & Palette
Background
Keyboard
Font & Character Set
Printer
Clipboard
2
Mouse
Sound
File Transfer
Windows
TCL Rules
See also:
Using the Settings dialog
2.3.7.1.3 Initialize method
do not use in scripts
Syntax:
settings.Initialize
Description:
This method returns all emulator settings to their default values.
2.3.7.1.4 Load method
do not use in scripts
Syntax:
settings.Load filename
Description:
This method loads all of the emulator settings from the specified file.
2.3.7.1.5 ReadProperties method
do not use in scripts
Syntax:
settings.ReadProperties propbag
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
170 AccuTerm 7 Help
This method loads all of the emulator settings from the specified PropertyBag object.
2.3.7.1.6 Save method (Settings)
do not use in scripts
Syntax:
settings.Save filename
Description:
This method saves all of the emulator settings in the specified INI file.
2.3.7.1.7 WriteProperties method
do not use in scripts
Syntax:
settings.WriteProperties propbag
Description:
This method saves all of the emulator settings into the specified PropertyBag object.
2.3.7.2
Settings properties
2.3.7.2.1 Ansi8Bit property
Syntax:
session.Ansi8Bit
Data type: boolean
Description:
If this setting is non-zero, AccuTerm sends 8 bit control codes. Othewise the eqivalent 7-bit escape sequence is sent. This property is only effective when AccuTerm is emulating one of the VT terminals.
2.3.7.2.2 AnsiAppCursor property
Syntax:
session.AnsiAppCursor
Data type: boolean
Description:
If this setting is non-zero, AccuTerm sends "application codes" instead of "cursor codes" when cursor keys are pressed. This property is only effective when AccuTerm is emulating one of the VT terminals.
2.3.7.2.3 AnsiAppKeypad property
Syntax:
session.AnsiAppKeypad
Data type: boolean
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 171
Description:
If this setting is non-zero, AccuTerm sends "application codes" instead of numeric characters when key on the numeric keypad are pressed. This property is only effective when AccuTerm is emulating one of the VT terminals.
2.3.7.2.4 AnsiAutoprint property
Syntax:
session.AnsiAutoprint
Data type: boolean
Description:
When this setting is True (non-zero), the "auto print" slave printer function works the same as a real VT terminal. That is, when AccuTerm is in "auto print" mode, the entire screen line that the cursor is on is printed when AccuTerm receives a CR, LF or FF control code. If this option is False (zero), then text is printed as it is received from the host (similar to Wyse auto-print mode).
2.3.7.2.5 Answerback property
Syntax:
session.Answerback
Data type: string
Description:
This is the string that AccuTerm returns to the host system when the host requests the "answerback message".
2.3.7.2.6 AsciiDelay property
Syntax:
session
.AsciiDelay
Data type: integer
Description:
Specifies the interline delay used for ASCII file uploads in milliseconds.
2.3.7.2.7 AsciiEOL property
Syntax:
session
.AsciiEOL
Data type: integer
Description:
Specifies the line ending sequence for ASCII file uploads. Set to 0 for
CR
, 1 for
LF
or 2 for
CR
+
LF
.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
172 AccuTerm 7 Help
2.3.7.2.8 AttributeMask property
Syntax:
settings.AttributeMask
Data type: integer
Description:
The AttributeMask property indicates which visual effects are to be displayed. Use 2 for blink, 8 for underline, 10 for both blink and underline or zero to disable both blinking and underline. The
AttributeMask property also controls whether border effects are available, as well as the border size. To enable border effects, add 64 for thin internal borders, 128 for thick internal borders, 576 for thin external borders and 640 for thick external borders. When internal borders are selected, the vertical border lines are drawn inside the character cell; when external borders are selected, the vertical border lines are drawn in adjacent cells.
2.3.7.2.9 AutoAnswer property
Syntax:
session.AutoAnswer
Data type: boolean
Description:
If this setting is non-zero, AccuTerm will answer incoming calls when the session is connected to a modem.
2.3.7.2.10 BackgroundPictureFile property
Syntax:
session.BackgroundPictureFile
Data type: string
Description:
This is the name of an image file that is used for the session background.
See also:
BackgroundPictureMode property
BackgroundTransparency property
2.3.7.2.11 BackgroundPictureMode property
Syntax:
session.BackgroundPictureMode
Data type: integer
Description:
This property controls how the background picture is scaled: 0 - picture is stretched to fit screen size.
This may alter the picture's aspect ratio; 1 - picture is scaled so that its longest dimension fills the
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 173
screen. The area not filled by the picture is black; 2 - picture is scaled so that its shortest dimension fills the screen. The longer dimension is cropped.
See also:
BackgroundPictureFile property
BackgroundTransparency property
2.3.7.2.12 BackgroundTransparency property
Syntax:
session.BackgroundTransparency
Data type: integer
Description:
The BackgroundTransparency property specifies the transparency of the background color or the opacity of the background picture, as a percentage. 100% means that the picture is used as the background,
0% means that the background color is used. Values in between blend the background picture and background color.
See also:
BackgroundPictureFile property
BackgroundPictureMode property
2.3.7.2.13 Baud property
Syntax:
session.Baud
Data type: integer
Description:
This is the baud rate used by the serial port attached to the session. This property is only meaningful when the communication device type is "Serial Port". Acceptable baud rates are atBaud300
, atBaud1200
,
atBaud2400
,
atBaud9600
,
atBaud14400
,
atBaud19200
,
atBaud38400
,
atBaud57600 and atBaud115200
.
2.3.7.2.14 BkspSendsDel property
Syntax:
session.BkspSendsDel
Data type: boolean
Description:
If this setting is True (non-zero), pressing the Backspace key causes AccuTerm to send the
DEL
control code. Otherwise, AccuTerm sends the
BS
control code.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
174 AccuTerm 7 Help
2.3.7.2.15 BoldFont property
Syntax:
session.BoldFont
Data type: boolean
Description:
Set to True (non-zero) if terminal font is bold, False (zero) if font is normal.
2.3.7.2.16 BreakKeyAction property
Syntax:
session
.
BreakKeyAction
Data type: integer
Description:
This property specifies the action to take when the
CTRL+BREAK
key is pressed. The exact interpretation of this property depends on the connection type.
0 - default action - send normal BREAK signal or character
1 - no break key
2 - send normal break (telnet BREAK command or SSH BREAK command)
3 - send alternate break (telnet IP command or SSH SIGINT signal)
256+
break_char
- send
break_char
character (ASCII code)
2.3.7.2.17 Changed property (Settings)
do not use in scripts
Syntax:
settings.Changed
Data type: integer
Description:
Non-zero if the settings have been modified.
2.3.7.2.18 CharacterMapping property
Syntax:
session
.
CharacterMapping
Data type: string
Description:
This property may be used to specify custom character mappings. Use this property to specify the
ASCII character value of the Eudo symbol as used by your host computer. For example:
session
.
CharacterMapping = "EURO SIGN=128"
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 175
You can assign any ASCII value for the Euro symbol using this property.
This property can also be used to specify the extended character set mapping for the Prism P30 emulation. To specify the Multinational character set, use:
session
.
CharacterMapping = "MDIS_P30=MULTINATIONAL"
To specify the Standard National Extension character set, use:
session
.
CharacterMapping = "MDIS_P30=STANDARD"
If you need to specify multiple character mappings, separate each with
CR LF
.
2.3.7.2.19 Charset property
Syntax:
session.Charset
Data type: string
Description:
The character set used by the host. The only valid values are NULL for the default character set for the selected terminal emulation, or "NATIVE" if the host uses the current 8-bit (non-Unicode) Windows character set.
2.3.7.2.20 ClientCertificateID property
Syntax:
session.ClientCertificateID
Data type: string
Description:
If an SSL/Telnet host requires the client to authenticate using a certificate, this property contains the name and/or hash of the desired client certificate. The client certificate must be installed in the current user's "MY" certificate store.
2.3.7.2.21 Colors() property
Syntax:
session.Colors( index )
Data type: integer
Description:
This array maps foreground and background colors (using the color
index
described above) to visual attribute combinations. The
index
to the
Colors()
array is the attribute code shown in the following table:
Index Attribute Description
0
1 normal blank
Index Attribute Description
22
24 dim reverse blink dim underline
Copyright 2010-2013 Schellenbach & Assoc., Inc.
176 AccuTerm 7 Help
14
16
18
20
6
8
10
12
Index Attribute Description
2
4
5 blink reverse reverse blank reverse blink undereline underline blink underline reverse underline reverse blink dim dim blink dim reverse
Index Attribute Description
40
42
44
46
32
34
36
38
26
28
30 dim underline blink dim underline reverse dim underline reverse blink bright bright blink bright reverse bright reverse blink bright underline bright underline blink bright underline reverse bright underline reverse blink
The value of this property may include a border effect style which is associated with the visual attribute.
The border effect styles are combined with the foreground and background color as follows: none = fg + bg inset = fb + bg + 16384 raised = fg + bg - 32768 flat = fg + bg - 16384
2.3.7.2.22 ConnectTimeout property
Syntax:
session.ConnectTimeout
Data type: integer
Description:
This property is the number of seconds to wait when attempting to make a connection before a timeout error occurs.
2.3.7.2.23 CopySelMode property
Syntax:
session
.
CopySelMode
Data type: integer
Description:
Set to 1 to clear the selection rectangle after copying the screen selection to the clipboard. Set to 0 to retain selection rectangle.
2.3.7.2.24 CursorType property
Syntax:
session.CursorType
Data type: boolean
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 177
Set to True (non-zero) if cursor shown as a block, False (zero) if cursor shown as an underline.
2.3.7.2.25 DataBits property
Syntax:
session.DataBits
Data type: integer
Description:
This is the number of data bits used by the serial port attached to the session. This property is only meaningful when the communication device type is atDevSERIAL
or atDevMODEM
. Acceptable values are
7 or 8. After changing this property, use the
Reset
method for the change to take effect.
2.3.7.2.26 DefaultCaptureDir property
Syntax:
session
.
DefaultCaptureDir
Data type: string
Description:
This is the default destination directory used for file capture operations which do not specify a directory.
2.3.7.2.27 DefaultTextEncoding property
DefaultTextEncoding property
Syntax:
settings.DefaultTextEncoding
Data type: integer
Description:
Sets the default encoding to use for dow nloaded or captured text files. Set to 1 for ANSI, 2 for Unicode, 3 for UTF-8 or 0 for raw (no encoding).
2.3.7.2.28 DefaultXferDir property
Syntax:
session.DefaultXferDir
Data type: string
Description:
This is the default destination directory used for file transfer operations which do not specify a directory.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
178 AccuTerm 7 Help
2.3.7.2.29 DefaultXferMode property
Syntax:
session.DefaultXferMode
Data type: integer
Description:
This is default transfer mode: 0 for text, 1 for binary.
2.3.7.2.30 DefaultXferOverwrite property
Syntax:
session.DefaultXferOverwrite
Data type: integer
Description:
This is default overwrite setting for received files. Set to True (non-zero) to allow overwrites, else set to
False (zero). This property only applies to ASCII and Xmodem downloads.
2.3.7.2.31 Device property
Syntax:
session.Device
Data type: integer
Description:
The communications device type attached to the session. The device type may be atDevNONE
for no device (disconnects session), atDevSERIAL
,
atDevTELNET
,
atDevSSH
or atDevMODEM
.
2.3.7.2.32 DeviceLicenseMode property
Syntax:
session
.
DeviceLicenseMode
Data type: integer
Description:
If this setting is non-zero, "device licensing" negotiation between AccuTerm and the host system is enabled. When device licensing has been successfully negotiated, multiple AccuTerm connections
(sessions) to the host system consume only one user license.
To enable device license negotiation, set this value to 1 if the device license response requires a
LF
termination character, or 3 if the response requires no termination character.
Device licensing is supported for UniVerse, UniData and QM host systems. The host system must have device licensing enabled (this is often an extra-charge item).
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 179
2.3.7.2.33 DisableAppMode property
Syntax:
session.DisableAppMode
Data type: boolean
Description:
Setting this property to True (non-zero) prevents AccuTerm from entering "keypad application mode" or
"cursor application mode" when running one of the VT emulations. Set to False to allow application mode.
2.3.7.2.34 Duplex property
Syntax:
session.Duplex
Data type: integer
Description:
This property sets the communications duplex mode to local (no communication to or from host: atDuplexLOCAL)
, full (remote echo: atDuplexFULL
) or half (local echo: atDuplexHALF
).
2.3.7.2.35 ExtCols, ExtRows properties
Syntax:
session.ExtCols
session.ExtRows
Data type: integer
Description:
These properties define the terminal screen dimensions when the terminal is placed into "extended mode", also known as "132 column mode".
2.3.7.2.36 FKeys() property (settings)
Syntax:
settings.Fkeys( index )
Data type: string
Description:
This array contains the programmed function and editing key strings. The
index
is formed by combining
(adding) the modifier value with the virtual key number. The special modifier for function key button bar caption can be combined with one of the standard modifiers to retrieve or store the caption & tooltip text.
The string value of the programmed key is binary, and might not contain printable characters. See
session FKeys property for modifier and virtual key values.
The FKeys property implements the standard VB Collection interface, and can be used in a For Each ...
Next statement to enumerate all of the programmed keys for a session:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
180 AccuTerm 7 Help
Sub Main()
Dim itm As Variant
Dim s As String
Dim key As String
Dim content As String
For Each itm In ActiveSession.Settings.FKeys
s = itm.Item
key = Item(s,1,1,vbNullChar) content = Item(s,2,2,vbNullChar)
Debug.Print key & " = " & content
End Sub
Next
Note: the Session FKeys property does not implement the Collection interface.
2.3.7.2.37 FontName property
Syntax:
session.FontName
Data type: string
Description:
This is the name of the terminal font used by the session.
2.3.7.2.38 FontSize property
Syntax:
session.FontSize
Data type: integer
Description:
This is the size of the terminal font in points.
2.3.7.2.39 GmodeEnable property
Syntax:
session.GmodeEnable
Data type: boolean
Description:
Set to True (non-zero) if Tektronix graphics mode is enabled for the session; otherwise set to False
(zero).
2.3.7.2.40 Handshake property
Syntax:
session.Handshake
Data type: integer
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 181
Description:
This is the handshake (flow control) method used by the serial port attached to the session. This property is only meaningful when the communications device type is atDevSERIAL
or atDevMODEM
.
Acceptable handshake settings are atHandshakeNONE
,
atHandshakeXON
,
atHandshakeXIO
, atHandshakeRTS
or atHandshakeDTR
.
2.3.7.2.41 HistoryRows property
Syntax:
session.HistoryRows
Data type: integer
Description:
This is the number of rows allocated for the session history buffer. If a buffer is allocated, each time a line is scrolled off the screen, the line is placed in the history buffer. Likewise, whenever the screen is cleared, the contents of the screen before clearing is copied to the history buffer.
2.3.7.2.42 HostCertificateValidation property
Syntax:
session.HostCertificateValidation
Data type: long
Description:
This property determines how the host certificate is validated when connecting using SSL/Telnet. Set this value to 0 if no validation is desired or -1 for strict validation. Otherwise, this is a bit mask with the following values:
1 = host certificate must be signed by a trusted certificate authority
2 = host certificate name must match host name
4 = host certificate must not be expired
8 = host certificate must not be revoked
16 = certificate must be valid for server authentication
2.3.7.2.43 HostKeyFingerprint property
Syntax:
session.HostKeyFingerprint
Data type: string
Description:
This property contains the hash (fingerprint) of the SSH host key.
2.3.7.2.44 HostKeyValidation property
Syntax:
session.HostKeyValidation
Data type: long
Copyright 2010-2013 Schellenbach & Assoc., Inc.
182 AccuTerm 7 Help
Description:
When using an SSH connection, set this property to 0 to ignore the host's public key, 1 if the host key should be trusted if it has not yet been set, 2 to confirm any change in the host key, or 3 if the key must match the key fingerprint specified in the
HostKeyFingerprint
property.
2.3.7.2.45 HostName property
Syntax:
session.HostName
Data type: string
Description:
This is the name of the host computer system which a session is connected to. This property is only meaningful when the communications device type is Telnet or Secure Shell. You can use the host IP address in place of the host name. After changing this property, use the
Reset
method for the change to take effect.
2.3.7.2.46 HostPort property
Syntax:
session.HostPort
Data type: string
Description:
For Telnet connections, this is the host TCP/IP port number assigned for Telnet services (default port is
23). For Secure Shell connections, it is the TCP/IP port assigned for SSH services (default port is 22).
2.3.7.2.47 HostTermType property
Syntax:
session.HostTermType
Data type: string
Description:
For Telnet and Secure Shell connections, this is the terminal type sent to the host when initiating the connection. This setting is only needed if AccuTerm’s default terminal type is not compatible with the host terminal names.
2.3.7.2.48 KeepaliveInterval property
Syntax:
session
.
KeepaliveInterval
Data type: long
Description:
If this setting is non-zero, AccuTerm will send a special "keepalive" message periodically to maintain the connection (some hosts and routers automatically disconnect when they detect an idle connection.)
This setting is in seconds. Note: enabling k eepalives when connecting to older versions of D3/NT may
cause the error log on the host to fill up.)
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 183
2.3.7.2.49 KermitCRC property
Syntax:
session.KermitCRC
Data type: integer
Description:
Set to True (non-zero) to enable CRC block checking, else set to False (zero) to use checksum block checking. If this option is enabled, and the host Kermit supports this option, then a 16 bit CRC is used to verify packet integrity.
2.3.7.2.50 KermitEOL property
Syntax:
session.KermitEOL
Data type: integer
Description:
Specifies the ASCII character to be sent at the end of each Kermit packet. Usually 13 (
CR
), but may be
10 (
LF
) for some hosts.
2.3.7.2.51 KermitErrRetry property
Syntax:
session.KermitErrRetry
Data type: integer
Description:
Specifies the number of times Kermit will retry during a file transfer before the transfer is aborted.
2.3.7.2.52 KermitInitRetry property
Syntax:
session.KermitInitRetry
Data type: integer
Description:
Specifies the number of times Kermit will retry when initiating a file transfer before the transfer is aborted.
2.3.7.2.53 KermitQuote property
Syntax:
session.KermitQuote
Data type: integer
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
184 AccuTerm 7 Help
Set to True (non-zero) to enable the "eighth bit quoting" option, else set to False (zero). If this option is enabled, and the host Kermit supports this option, then any characters which have the eighth bit set are
"quoted" using a sequence of characters which do not have the eighth bit set. This option is useful for connections which do not support eight bit data.
2.3.7.2.54 KermitRept property
Syntax:
session.KermitRept
Data type: integer
Description:
Set to True (non-zero) to enable the run length encoding data compression option, else set to False
(zero). If this option is enabled, and the host Kermit supports this option, then repeated sequences of any character are encoded to compress the data.
2.3.7.2.55 KermitTimeout property
Syntax:
session.KermitTimeout
Data type: integer
Description:
Specifies the number of seconds before Kermit file transfer operations time out.
2.3.7.2.56 LegibleFont property
Syntax:
session.LegibleFont
Data type: boolean
Description:
Set to True (non-zero) to keep fonts legible when scaling fonts to fit screen; otherwise set to False
(zero).
2.3.7.2.57 LockBaudRate property
Syntax:
session.LockBaudRate
Data type: boolean
Description:
Set to True (non-zero) to lock the modem to the specified baud rate; otherwise set to False (zero). Note: not all modems support this setting.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 185
2.3.7.2.58 LockFKeys property
Syntax:
session
.
LockFKeys
Data type: integer
Description:
Set to 0 for unlocked function keys (host can reset or reprogram keys), 1 to lock from reset (host can reprogram keys, but not reset them) or 2 to lock from programming (host cannot reset or reprogram function keys).
2.3.7.2.59 MapUpperFKeys property
Syntax:
session.MapUpperFKeys
Data type: boolean
Description:
Setting this property to True (non-zero) causes AccuTerm to map
Ctrl+F1
through
Ctrl+F10
as
F11
to
F20
.
This is the default behavior, since the PC keyboard does not have keys
F13
to
F20
.
2.3.7.2.60 MessageRows property
Syntax:
session.MessageRows
Data type: integer
Description:
This property sets the number of message rows and status lines for the session. The value must be between 0 and 3. Note that some emulations do not support any status or message rows, and some only support a single status line. Others support up to 3 lines. For more information, see
2.3.7.2.61 MouseEnable property
Syntax:
session.MouseEnable
Data type: boolean
Description:
Set to True (non-zero) to enable the ESC STX "1" / ESC STX "2"AccuTerm mouse-on command; otherwise set to False (zero).
2.3.7.2.62 NoAutoWrap property
Syntax:
session
.
NoAutoWrap
Data type: boolean
Copyright 2010-2013 Schellenbach & Assoc., Inc.
186 AccuTerm 7 Help
Description:
Set to True (non-zero) to disable automatic line wrap at end of line.
2.3.7.2.63 NormCols, NormRows properties
Syntax:
session.NormCols
session.NormRows
Data type: integer
Description:
These properties define the terminal screen dimensions when the terminal is placed into "normal mode", also known as "80 column mode".
2.3.7.2.64 OverrideModemConfig property
Syntax:
session.OverrideModemConfig
Data type: boolean
Description:
Set to True (non-zero) to override modem Control Panel settings for baud rate, data bits, stop bits, parity and handshake with current session settings for these properties; otherwise set to False (zero).
2.3.7.2.65 Pages property
Syntax:
session.Pages
Data type: integer
Description:
This specifies the number of video pages for the session. The value must be between 1 and 25.
2.3.7.2.66 Palette() property
Syntax:
session.Palette( index )
Data type: OLE_COLOR
Description:
This array contains the color values for the 16 palette entries used to display text on the terminal screen.
The
Color property assigns foreground (text) and background colors based on these 16 colors. You can
use the
RGB()
function to produce an OLE_COLOR from separate red, green and blue values. The red, green and blue values must be in the range of 0 to 255.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 187
11
12
13
14
15
7
8
9
10
5
6
3
4
Palette entry
0
1
2
Color
Black
Dark Blue
Dark Green
Turquoise
Dark Red
Purple
Olive
Light Grey
Dark Grey
Blue
Green
Cyan
Red
Magenta
Yellow
White
An additional 6 palette entries exist for drawing borders (see
). These are:
19
20
21
Palette entry
16
17
18
Used for flat outer border flat inner border shadow outer border shadow inner border highlight outer border highlight inner border
2.3.7.2.67 Parity property
Syntax:
session.Parity
Data type: integer
Description:
This is the parity setting used by the serial port attached to the session. This property is only meaningful when the communication device type is atDevSERIAL
or atDevMODEM
. Acceptable values are atParityNONE
, atParityEVEN
, atParityODD
, atParityMARK
and atParitySPACE
. After changing this property, use the
Reset
method for the change to take effect.
2.3.7.2.68 PasteEOFChar property
Syntax:
session.PasteEOFChar
Data type: integer
Description:
Copyright 2010-2013 Schellenbach & Assoc., Inc.
188 AccuTerm 7 Help
This is the ASCII character which is transmitted to the host at the end of paste operation. If this value is zero, no character will be transmitted.
2.3.7.2.69 PasteEOFMode property
Syntax:
session.PasteEOFMode
Data type: integer
Description:
Set to 0 if no character is transmitted at the end of a paste operation. Set to 1 if a
SUB
control code is transmitted. Set to 2 to use the character defined by the
PasteEOFChar
property.
2.3.7.2.70 PasteEOLChar property
Syntax:
session.PasteEOLChar
Data type: integer
Description:
This is the ASCII character which is transmitted to the host at the end of each line in a paste operaton. If this value is zero, no character will be transmitted.
2.3.7.2.71 PasteEOLMode property
Syntax:
session.PasteEOLMode
Data type: integer
Description:
Set to 0 if a
CR
is transmitted at the end of each line of a paste operation. Set to 1 if a
LF
is transmitted.
Set to 2 if a
CR+ LF
is transmitted. Set to 3 if a
TAB
is transmitted. Set to 4 if no character is transmitted.
Set to 5 to use the character defined by the
PasteEOLChar
property. If you want to suppress the end-ofline character after the last line, add 128 to this value.
2.3.7.2.72 Port property
Syntax:
session.Port
Data type: integer
Description:
Specifies the COM port number attached to the session. This property is only meaningful when the communication device type is atDevSERIAL
. Acceptable values are from 1 to 127. After changing this property, use the
Reset
method for the change to take effect.
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 189
2.3.7.2.73 PrinterColorMode property
Syntax:
session
.
PrinterColorMode
Data type: integer
Description:
If this property is non-zero and the
ScreenPrintMode
property is non-zero (Graphics mode), the screen is printed in color; otherwise the screen is printed in black and white. This property has no effect when the
ScreenPrintMode
property is zero (Text mode).
2.3.7.2.74 PrinterFontBold property
Syntax:
session
.
PrinterFontBold
Data type: boolean
Description:
Set this property to True (non-zero) to print using boldface. This property affects slave (or Aux) print jobs when the
SlavePrintMode
property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero (Text mode).
2.3.7.2.75 PrinterFontItalic property
Syntax:
session
.
PrinterFontItalic
Data type: boolean
Description:
Set this property to True (non-zero) to print using italics. This property affects slave (or Aux) print jobs when the
SlavePrintMode
property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero (Text mode).
2.3.7.2.76 PrinterFontName property
Syntax:
session
.
PrinterFontName
Data type: string
Description:
Set this property to the name of the font to use for slave (or Aux) print jobs when the
SlavePrintMode property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero
(Text mode).
2.3.7.2.77 PrinterFontSize property
Syntax:
session
.
PrinterFontSize
Copyright 2010-2013 Schellenbach & Assoc., Inc.
190 AccuTerm 7 Help
Data type: integer
Description:
Set this property to the size (in points) of the font to use for slave (or Aux) print jobs when the
SlavePrintMode
property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode property is zero (Text mode).
2.3.7.2.78 PrinterOrientation property
Syntax:
session
.
PrinterOrientation
Data type: integer
Description:
Set this property to 0 use the default page orientation, 1 for portrait or 2 for landscape. This property applies only to slave (or Aux) print jobs and only when the
SlavePrintMode
property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero (Text mode).
2.3.7.2.79 PrinterPaperSize property
Syntax:
session
.
PrinterPaperSize
Data type: integer
Description:
Set this property to 0 use the default paper size for the printer. Otherwise use a paper size from the table below. This property applies only to slave (or Aux) print jobs and only when the
property is non-zero (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero (Text mode).
1 Letter 8 1/2 x 11 in
3 Tabloid 11 x 17 in
5 Legal 8 1/2 x 14 in
7 Executive 7 1/4 x 10 1/2 in
9 A4 210 x 297 mm
11 A5 148 x 210 mm
13 B5 (JIS) 182 x 257 mm
15 Quarto 215 x 275 mm
17 11x17 in
19 Envelope #9 3 7/8 x 8 7/8
21 Envelope #11 4 1/2 x 10 3/8
23 Envelope #14 5 x 11 1/2
25 D size sheet
27 Envelope DL 110 x 220mm
2 Letter Small 8 1/2 x 11 in
4 Ledger 17 x 11 in
6 Statement 5 1/2 x 8 1/2 in
8 A3 297 x 420 mm
10 A4 Small 210 x 297 mm
12 B4 (JIS) 250 x 354
14 Folio 8 1/2 x 13 in
16 10x14 in
18 Note 8 1/2 x 11 in
20 Envelope #10 4 1/8 x 9 1/2
22 Envelope #12 4 \276 x 11
24 C size sheet
26 E size sheet
28 Envelope C5 162 x 229 mm
Copyright 2010-2013 Schellenbach & Assoc., Inc.
29 Envelope C3 324 x 458 mm
31 Envelope C6 114 x 162 mm
33 Envelope B4 250 x 353 mm
35 Envelope B6 176 x 125 mm
37 Envelope Monarch 3.875 x 7.5 in
39 US Std Fanfold 14 7/8 x 11 in
41 German Legal Fanfold 8 1/2 x 13 in
AccuTerm 7 Automation 191
30 Envelope C4 229 x 324 mm
32 Envelope C65 114 x 229 mm
34 Envelope B5 176 x 250 mm
36 Envelope 110 x 230 mm
38 6 3/4 Envelope 3 5/8 x 6 1/2 in
40 German Std Fanfold 8 1/2 x 12 in
2.3.7.2.80 PrinterPaperSource property
Syntax:
session
.
PrinterPaperSource
Data type: integer
Description:
Set this property to 0 use the default paper source for the printer. Otherwise use a paper source from the table below. This property applies only to slave (or Aux) print jobs and only when the
SlavePrintMode property is 1 (Graphics mode). This property has no effect when the
SlavePrintMode
property is zero
(Text mode).
5
6
7
8
1
2
3
4
Upper tray
Lower tray
Middle tray
Manual feed
Envelope feeder
Envelope manual
Auto
Tractor
2.3.7.2.81 PrinterTimeout property
Syntax:
session
.
PrinterTimeout
Data type: integer
Description:
This property specifies the number of seconds of inactivity before a print job is closed.
2.3.7.2.82 PrintJobEject property
Syntax:
session
.
PrintJobEject
Data type: integer
Copyright 2010-2013 Schellenbach & Assoc., Inc.
192 AccuTerm 7 Help
Description:
This property specifies if a page is ejected before or after a print job. Set this property to 0 for no page ejects, 1 to eject page before print job, 2 to eject page after print job or 3 to eject page before and after print job.
2.3.7.2.83 PrintScreenBackground property
Syntax:
session
.
PrintScreenBackground
Data type: boolean
Description:
Set to True (non-zero) to print the screen background when using the Print Screen command and the
ScreenPrintMode
property is non-zero (Graphics mode); otherwise set to False (zero). This property has no effect when the
ScreenPrintMode
property is zero (Text mode).
2.3.7.2.84 PrintScreenEject property
Syntax:
session
.
PrintScreenEject
Data type: integer
Description:
This property specifies if a page is ejected before or after a print screen. Set this property to 0 for no page ejects, 1 to eject page before print screen, 2 to eject page after print screen or 3 to eject page before and after print screen.
2.3.7.2.85 ProtectAttr property
Syntax:
session
.
ProtectAttr
Data type: integer
Description:
Visual attribute number assigned to "protected fields" under Wyse/ADDS emulation. See
() property for a list of attribute numbers.
2.3.7.2.86 ScaleFont property
Syntax:
session
.
ScaleFont
Data type: boolean
Description:
Set to True (non-zero) to enable automatic font scaling; otherwise set to False (zero).
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 193
2.3.7.2.87 ScreenPrintAdapterScript property
Syntax:
session
.
ScreenPrintAdapterScript
Data type: string
Description:
This is the name of the print adapter script file to use for screen printing. Print adapter scripts are used to process the print job using an external program, such as Print Wizard. To use the print adapter script, the
property must be set to 2. See
Screen Printer Settings for more information on
print adapters.
2.3.7.2.88 ScreenPrinterName property
Syntax:
session
.
ScreenPrinterName
Data type: string
Description:
This is the name of the printer used by the session for screen printing. It may be set to null ("") to indicate the current Windows default printer, or "no printer" to disable screen printing.
See also:
2.3.7.2.89 ScreenPrintMode property
Syntax:
session
.
ScreenPrintMode
Data type: integer
Description:
Set to 0 for text mode, 1 for graphics mode or 2 to use the print adapter script specified by the
property. When this property is 1, the
properties affect how the screen is printed.
2.3.7.2.90 ScreenPrintOrientation property
Syntax:
session
.
ScreenPrintOrientation
Data type: integer
Description:
Set this property to 0 use the default page orientation, 1 for portrait or 2 for landscape. This property applies only to screen printing and only when the
property is 1 (Graphics mode). This
property has no effect when the
ScreenPrintMode
property is zero (Text mode).
Copyright 2010-2013 Schellenbach & Assoc., Inc.
194 AccuTerm 7 Help
2.3.7.2.91 ScreenPrintPaperSize property
Syntax:
session
.
ScreenPrintPaperSize
Data type: integer
Description:
Set this property to 0 use the default paper size for the printer. Otherwise use a paper size from the table shown in the
property. This property applies only when the
property is non-zero (Graphics mode). This property has no effect when the
ScreenPrintMode
property is zero (Text mode).
2.3.7.2.92 ScreenPrintPaperSource property
Syntax:
session
.
ScreenPrintPaperSource
Data type: integer
Description:
Set this property to 0 use the default paper source for the printer. Otherwise use a paper source from the table shown in the
property. This property applies only to screen printing and only when the
property is 1 (Graphics mode). This property has no effect when the
ScreenPrintMode
property is zero (Text mode).
2.3.7.2.93 ScrMode property
Syntax:
session
.
ScrMode
Data type: integer
Description:
Set to zero for normal (80 column) mode, 1 for extended (132 column) mode.
2.3.7.2.94 ScrollMode property
Syntax:
session
.
ScrollMode
Data type: integer
Description:
This controls the appearance of the vertical scroll bar: 0=no scroll bar (scroll bar is only visible if the current number of Rows will not fit in the current window size), 1=always show scroll bar, and
2=automatically show scroll bar when cursor is positioned near right border of window.
2.3.7.2.95 SlavePrintAdapterScript property
Syntax:
session
.
SlavePrintAdapterScript
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 195
Data type: string
Description:
This is the name of the print adapter script file to use for slave (Aux) print jobs. Print adapter scripts are used to process the print job using an external program, such as Print Wizard. To use the print adapter script, the
property must be set to 2. See
for more information on print adapters.
2.3.7.2.96 SlavePrinterName property
Syntax:
session
.
PrinterName
session
.
SlavePrinterName
Data type: string
Description:
This is the name of the printer used by the session for slave (or Aux) printer output. It may be set to null
("") to indicate the current Windows default printer, or "no printer" to disable slave printing.
See also:
2.3.7.2.97 SlavePrintMode property
Syntax:
session
.
SlavePrintMode
Data type: integer
Description:
Set to 0 for text mode, 1 for graphics mode or 2 to use the print adapter script specified in the
property. When this property is 1, the
PrinterFont…
,
PrinterOrientation
,
PrinterPaperSize
and
PrinterPaperSource
properties affect how the slave (Aux) print job is printed.
Print adapter scripts are used to process the print job using an external program, such as PrintWizard.
See
Slave Printer Settings for more information on print adapters.
2.3.7.2.98 Sound property
Syntax:
session
.
Sound
Data type: string
Description:
This property may be used to specify a custom sound for the terminal beep. Set this property to null to use the default sound. Set to a valid WAVE, MP3 or MIDI file name to play the specified wave file. Set to
“SystemDefault”, “SystemHand”, “SystemExclamation” or “SystemAsterisk” to use the sound associated with a system event (as defined in the Control Panel Sounds applet). Set to frequency,
duration to use a true “beep” at the specified frequency (Hz) and duration (ms).
Copyright 2010-2013 Schellenbach & Assoc., Inc.
196 AccuTerm 7 Help
2.3.7.2.99 SSHAuth property
Syntax:
session
.
SSHAuth
Data type: integer
Description:
This property may be used to select the authentication method which will be used by a Secure Shell
(ssh) session to authenticate a user to the host. Available authentication methods are: public key (2), password (3) and interactive (7). Use zero (0) for the default authentication method (password).
2.3.7.2.100 SSHCipher property
Syntax:
session
.
SSHCipher
Data type: integer
Description:
This property may be used to select a cipher to be used to encrypt a Secure Shell (ssh) session.
Available ciphers are: Triple DES (3), Blowfish (6), 128 bit AES (7) and 256 bit AES (8). Use zero (0) for the default cipher (Triple DES for SSH1 or 128 bit AES for SSH2).
2.3.7.2.101 SSHKey property
Syntax:
session
.
SSHKey
Data type: string
Description:
This property contains the name of the SSH private key file. If no path is included, AccuTerm's default key folder will be used to read the key file.
2.3.7.2.102 SSHUseOnlyPreferredCipher property
Syntax:
session
.
SSHUseOnlyPreferredCipher
Data type: boolean
Description:
Set to True (non-zero) to require that the cipher used for an SSH connection is the cipher specified by the
property. If the host system does not accept the preferred cipher, the connection is
aborted.
2.3.7.2.103 SSHVersion property
Syntax:
session
.
SSHVersion
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 197
Data type: integer
Description:
This property may be used to select the desired SSH protocol version. Set this property to zero (0) for automatic protocol selection. Set to 1 for SSH version 1 or set to 2 for SSH version 2. When automatic protocol selection is used, AccuTerm selects the highest protocol version supported by the host.
2.3.7.2.104 StopBits property
Syntax:
session
.
StopBits
Data type: integer
Description:
This is the number of stop bits used by the serial port attached to the session. This property is only meaningful when the communication device type is atDevSERIAL
or atDevMODEM
. Acceptable values are
1 or 2. After changing this property, use the
Reset
method for the change to take effect.
2.3.7.2.105 Strip8th property
Syntax:
session
.
Strip8th
Data type: boolean
Description:
Set to True (non-zero) to cause AccuTerm to truncate received data to 7 bits; otherwise set to False
(zero).
2.3.7.2.106 TcpIdn property
Syntax:
session
.
TcpIdn
Data type: boolean
Description:
Set this property to True (non-zero) to enable Internationalized Domain Names (IDN) for the host name. I
DN relies upon a standardized mechanism known as "Punycode" for encoding Unicode domain names using only the ASCII characters that are permitted by the global DNS system.
2.3.7.2.107 TcpNoDelay property
Syntax:
session
.
TcpNoDelay
Data type: boolean
Description:
Normally, the TCP network stack delays outbound network messages for a short time in order to
"coalesce" multiple small messages into a single packet. When this setting is True (non-zero),
Copyright 2010-2013 Schellenbach & Assoc., Inc.
198 AccuTerm 7 Help
AccuTerm will send each message as soon as possible. Setting this option may improve throughput, especially when running in AccuTerm's GUI environment and during file transfers, at the expense of increased network traffic.
2.3.7.2.108 TelnetBinary property
Syntax:
session
.
TelnetBinary
Data type: boolean
Description:
Set to True (non-zero) to enable Telnet binary communication mode; otherwise set to False (zero) for text communication mode.
2.3.7.2.109 TelnetBypass property
Syntax:
session
.
TelnetBypass
Data type: boolean
Description:
Set to True (non-zero) to bypass initial option negotiation; otherwise set to False (zero) for normal negotiation. This is required for certain hosts like D3 which do not implement the complete Telnet protocol.
2.3.7.2.110 TelnetKeepaliveIsNOP property
Syntax:
session
.
TelnetKeepaliveIsNOP
Data type: boolean
Description:
Set to True (non-zero) to send Telnet NOP command for keepalives; otherwise, sends Telnet DMARK command for keepalives.
2.3.7.2.111 TermType property
Syntax:
session
.
TermType
Data type: integer
Description:
This is the terminal emulation setting for the session. Possible values are: atTermTTY atTermVPA2 atTermVP60 basic TTY
ADDS Viewpoint A2
ADDS Viewpoint 60
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 199
atTermP60 atTermA2E atTermWY50 atTermWY60 atTermVT52 atTermVT100 atTermVT220 atTermVT320 atTermVT420 atTermLinux atTermSCO atTermANSI atTermPICKMON atTermP30 atTermTEK atTermTEK4100
ProComm Viewpoint 60
ADDS Viewpoint A2 Enhanced
Wyse 50
Wyse 60
DEC VT-52
DEC VT-100
DEC VT-220
DEC VT-320
DEC VT-420
Linux console
SCO console
ANSI BBS
Pick PC Monitor
MDIS P30
Tektronix 4014
Tektronix 4100
2.3.7.2.112 XmodemTimeout property
Syntax:
session.XmodemTimeout
Data type: integer
Description:
Specifies the number of seconds before Xmodem file transfer operations time out.
2.3.7.2.113 YmodemTimeout property
Syntax:
session.YmodemTimeout
Data type: integer
Description:
Specifies the number of seconds before Ymodem file transfer operations time out.
2.3.7.2.114 ZmodemAuto property
Syntax:
session.ZmodemAuto
Data type: integer
Description:
Set to True (non-zero) to enable automatic Zmodem downloads, otherwise set to False (zero).
Copyright 2010-2013 Schellenbach & Assoc., Inc.
200 AccuTerm 7 Help
2.3.7.2.115 ZmodemTimeout property
Syntax:
session.ZmodemTimeout
Data type: integer
Description:
Specifies the number of seconds before Zmodem file transfer operations time out.
2.3.8
AccuTerm constants
Description:
The following constants may be used in setting many of AccuTerm’s properties.
Device constants atDevNONE = 0 atDevSERIAL = 1 atDevPICLAN = 2 atDevTELNET = 3 atDevMODEM = 4 atDevSSH = 5
No communications device selected.
C ommunications device is a serial port.
C ommunications device is a PicLan network connection.
C ommunications device is a TCP/IP Telent network connection.
C ommunications device is a modem.
C ommunications device is a TCP/IP Secure Shell connection.
Serial port constants atBaud300 = 0 atBaud1200 = 1 atBaud2400 = 2 atBaud4800 = 3 atBaud9600 = 4 atBaud14400 = 5 atBaud19200 = 6 atBaud38400 = 7 atBaud57600 = 8 atBaud115200 = 9 atParityNONE = 0 atParityODD = 1 atParityEVEN = 2 atParityMARK = 3 atParitySPACE = 4 atHandshakeNONE = 0 atHandshakeXON = 1 atHandshakeRTS = 2 atHandshakeDTR = 3 atHandshakeXIO
= 4
Baud rate is 300 bps.
Baud rate is 1200 bps.
Baud rate is 2400 bps.
Baud rate is 4800 bps.
Baud rate is 9600 bps.
Baud rate is 14,400 bps.
Baud rate is 19,200 bps.
Baud rate is 38,400 bps.
Baud rate is 57,600 bps.
Baud rate is 115,200 bps.
No parity checking
Use odd parity
Use even parity
Use mark parity
Use space parity
Do not use any flow control (handshake)
Use Xon/Xoff (software) flow control (inbound)
Use RTS/CTS (hardware) flow control
Use DTR/DSR (hardware) flow control
Xon/Xoff handshake (bidirectional)
Copyright 2010-2013 Schellenbach & Assoc., Inc.
AccuTerm 7 Automation 201
Duplex mode constants atDuplexFULL
= 0 atDuplexHALF
= 1 atDuplexLOCAL
= 2
Terminal type constants atTermTTY = 0 atTermVPA2
= 1 atTermVP60
= 2 atTermP60
= 3 atTermA2E
= 4 atTermWY50
= 5 atTermWY60
= 6 atTermVT52
= 7 atTermVT220
= 8 atTermANSI
= 9 atTermPICKMON
= 10 atTermTEK
= 11 atTermVT100
= 12 atTermVT320
= 13 atTermVT420
= 14 atTermSCO
= 15 atTermLinux
= 16 atTermTEK4100
= 17 atTermP30
= 18
File transfer constants atProtocolASCII
= 0 atProtocolKermit
= 1 atProtocolXmodem
= 2 atProtocolYmodem
= 3 atProtocolZmodem
= 4 atProtect
= 0 atOverwrite
= 1 atAppend
= 2 atNewer
= 3 atUpdate
= 4 atResume
= 5
Reset constants atResetAll
= 0 atResetTerminal
= 1
Copyright 2010-2013 Schellenbach & Assoc., Inc.
Full duplex (host performs echo)
Half duplex (local echo)
Local mode
TTY emulation
ADDS Viewpoint A2 emulation
ADDS Viewpoint 60 emulation
Procomm ADDS Viewpoint 60 emulation
ADDS Viewpoint A2 Enhanced emulation
Wyse 50 emulation
Wyse 60 emulation
DEC VT52 emulation
DEC VT220 emulation
ANSI BBS emulation
Pick PC Monitor (console) emulation
Tektronix 4014 emulation
DEC VT100ulation
DEC VT320 emulation
DEC VT420 emulation
SCO Console emulation
Linux Console emulation
Tektronix 4100 emulation
Prism 30 emulation use ASCII file transfer protocol use Kermit file transfer protocol use Xmodem file transfer protocol use Ymodem file transfer protocol use Zmodem file transfer protocol do not overwrite existing file (Zmodem upload only) overwrite existing file (Zmodem upload only) append to existing file (Zmodem upload only) overwrite existing file only when uploaded file is newer
(Zmodem upload only) overwrite existing file, but ignore non-existing file (Zmodem upload only)
Zmodem crash recovery
Reset connection and terminal
Reset terminal only
202 AccuTerm 7 Help
atResetComm
= 2 Reset connection only
Printer constants atPrinterOff atPrinterOn
= 0
= 1
Turn printer off
Auto-print mode atPrinterTransparent
= 2 Transparent print mode
History scroll constants atScrlHistLineUp
= 0 atScrlHistLineDown
= 1 atScrlHistPageUp
= 2 atScrlHistPageDown
= 3 atScrlHistTop
= 6 atScrlHistBottom
= 7
Scroll history to previous line
Scroll history to next line
Scroll history to previous page
Scroll history to next page
Scroll history to beginning
Scroll history to end
Copyright 2010-2013 Schellenbach & Assoc., Inc.
Top Level Intro
This page is printed before a new top-level chapter starts
Part
III
Download
Link público atualizado
O link público para seu chat foi atualizado. Você pode visualizar e gerenciar seus links de chat após o registro aqui.
Link público do documento
Anúncio
