Vlterm Programmer's Reference - Avaya Support

Vlterm
Programmer’s Reference

Copyright © 1999, Lucent Technologies
All Rights Reserved, Printed in U.S.A.
This is the fifth edition of the Vlterm Programmer’s Reference, document number 90446-01, written for the
Vlterm Software Developer’s Kit.
Notice
Every effort was made to ensure that the information in this guide was complete and accurate at the time of
printing. However, information is subject to change.
Lucent Technologies makes no representation or warranties with respect to the contents of this guide and
disclaims any other express or implied warranties, including implied warranties of merchantability or fitness for
any particular purpose. Lucent Technologies reserves the right to revise this guide without obligation to notify any
person or organization of such revision.
If the supplied software is acquired by an agency or other part of the U.S. Government, the software and all its
accompanying written materials are provided with Restricted Rights. Use, duplication, or disclosure by the
Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and
Workstation Program clause at 48 C.F.R. 252.227-7013 or in subparagraphs (c)(1) and (2) of the Commercial
Computer Software - Restricted Rights clause at 48 C.F.R. 52.227-19, as applicable.
All information contained in or disclosed by this document is considered confidential and proprietary by Lucent
Technologies. By accepting this material the recipient agrees that this material and information contained therein
is held in confidence and in trust. All use, disclosure and/or reproduction of any part of this publication not
specifically authorized by Lucent Technologies is prohibited.
Trademarks
Mosaix Predictive Dialing System is a trademark of Lucent Technologies.
The following are trademarks or registered trademarks of their respective companies or organizations:
Chameleon, Chameleon HostLink, Extra!, InfoSwitch, KEA!, Microsoft, On Demand, PASSPORT, Reflection,
Rumba, Windows, Windows NT, and Unix
Other products and brand names are trademarks or registered trademarks of their respective holders.
Obtaining Products
To learn more about Lucent Technologies products and to order products, contact Lucent Direct, the direct-market
organization of Lucent Technologies Business Communications Systems. Access their web site at
www.lucentdirect.com. Or call the following numbers: customers 1 800 451 2100,
account executives 1 888 778 1880 (voice) or 1 888 778 1881 (fax).
Warranty
Lucent Technologies provides a limited warranty on this product. Refer to the “Limited Use Software License
Agreement” card provided with your package.
Lucent Technologies Web Page
The worldwide web home page for Lucent Technologies is:
http://www.lucent.com

Contents
1 Introduction to Vlterm
Agent Workstation Features ...................................................................2
Switch Between Windows...............................................................3
Multiple Step Script.........................................................................3
Agent Workstation Software Configuration....................................3
Agent Use Case Scenario ................................................................3
System Requirements ............................................................................4
Mosaix Terminal Emulation Applications .....................................5
Host Terminal Emulation Applications ..........................................5
Inter-Application Communications ................................................5
2 Installing Vlterm
Installation Methods ..............................................................................9
Command Line Options .........................................................................9
Vlterm File Reference ..........................................................................10
Core Vlterm Executable and Configuration Files ........................10
DDE Configuration Files ..............................................................10
3 Vlkeys.ini Configuration
Toolbar Button Definitions...................................................................11
Syntax ...........................................................................................12
Sample File ...................................................................................14
iii

iv Contents
4 Vlterm.ini Configuration
Sample Vlterm.ini File ........................................................................ 19
Vlterm.ini File Configuration Settings................................................. 22
[GLOBAL] ................................................................................... 22
[SHELL] ....................................................................................... 25
[WIN_TITLE] .............................................................................. 26
[DDE_SESSION] ......................................................................... 26
[FKEY_BUTTONS] .................................................................... 29
[CNPn] ......................................................................................... 30
5 Cut Commands
Emulator Formats ................................................................................ 35
Attachmate KEA! ......................................................................... 35
Attachmate Extra! ........................................................................ 36
Wall Data Rumba ......................................................................... 36
WRQ Reflection ........................................................................... 36
DRV ............................................................................................. 36
ClipCut() .............................................................................................. 37
6 Paste Commands
@x ....................................................................................................... 39
C() ........................................................................................................ 39
ClipCopyBlock() ................................................................................. 40
ClipGet() .............................................................................................. 41
ClipSet() .............................................................................................. 41
Cursor() ............................................................................................... 42
Wall Data Rumba ......................................................................... 42
Attachmate Extra! ........................................................................ 42
CUTn|CVRn ........................................................................................ 43
Date() ................................................................................................... 44
Delay() ................................................................................................. 44
Exit_Vlterm ......................................................................................... 45
File() .................................................................................................... 45
Find() ................................................................................................... 46

Contents v
FocusRemain() .....................................................................................47
FormatStr() ...........................................................................................47
FormLoad() ..........................................................................................47
Hide_Fkeys ..........................................................................................48
Hide_Logon .........................................................................................48
Input .....................................................................................................48
LeftStr() ...............................................................................................49
Lookup() ..............................................................................................49
MathOnVars() ......................................................................................50
Msg ......................................................................................................50
Non-Reserved Word ............................................................................50
OIA ......................................................................................................51
Other() ..................................................................................................52
Pause() .................................................................................................53
Release .................................................................................................53
Relink ...................................................................................................53
RightStr() .............................................................................................53
SendKeys .............................................................................................54
SetVarn ................................................................................................54
Parameters .....................................................................................54
Subroutines ....................................................................................55
ShellApp() ............................................................................................58
Show_Fkeys .........................................................................................58
Start_Auto_CNP ..................................................................................59
Stop_Auto_CNP ..................................................................................59
StrCat() .................................................................................................59
TitleCaption .........................................................................................59
ToggleTo() ...........................................................................................60
VARn ...................................................................................................60
Wait() ...................................................................................................60
WaitForKey() .......................................................................................60
WinFocus() ..........................................................................................61

vi Contents
7 Automatic Cut and Paste
Sample Files ......................................................................................... 64
Vlterm.ini ..................................................................................... 64
Vlkeys.ini ..................................................................................... 65
8 Creating a DDE.ini File
DDE.ini Files Introduction .................................................................. 67
DDE.ini File Variables ........................................................................ 68
DDE.ini File Sections .......................................................................... 70
[DDE_CUTS] ............................................................................... 70
[DDE_PASTECUTS] .................................................................. 70
[DDE_PVAR] .............................................................................. 70
[DDE_OIAKBD] ......................................................................... 70
[DDE_CURSOR] ......................................................................... 70
[DDE_WAITS] ............................................................................ 71
[DDE_PAUSE] ............................................................................ 71
[DDE_FINDS] ............................................................................. 71
[DDE_OTHER] ........................................................................... 71
[DDE_SENDTHRU] ................................................................... 71
[DDE_SENDFKEYS] .................................................................. 72
[DDE_SENDPFKEYS] keystroke ............................................... 72
Additional Variables ........................................................................... 72
DRV_DDE.ini File Example ............................................................... 72
9 Configuring a Custom Form
Loading a Form ................................................................................... 75
Formn.ini File Setup ............................................................................ 76
[GLOBAL] ................................................................................... 77
[Objectn] ...................................................................................... 79
Sample Form1.ini File ......................................................................... 86
A Using the Format Function
Numeric Formats ................................................................................. 91
Predefined Numeric Formats ....................................................... 92
User-Defined Numeric Formats ................................................... 93

Contents vii
Date and Time Formats ........................................................................96
Predefined Date and Time Formats ...............................................97
User-Defined Date and Time Formats ..........................................97
String Formats ....................................................................................100
B Using the SendKeys Function
Sample Configuration ........................................................................102
Usage .................................................................................................103
C Using the Like Operator .........................................................105
D Emulator Special @x Keys......................................................107
E ASCII and VT100 Control Sequences
ASCII Characters ............................................................................... 111
Numeric Pad ...................................................................................... 111
F Emulator Specifics
Attachmate .........................................................................................113
Netware LAN WS ......................................................................113
EXTRA! version 4.3 ...................................................................115
EXTRA! Personal Client 6.x and
EXTRA! Bundle for TCP/IP Version 6.2 ...................................116
Hummingbird Communications Exceed ............................................121
IBM Personal Communications 3270 ................................................123
Irma 3270 ...........................................................................................124
Single Irma 3270 Session ...........................................................124
Multiple Irma 3270 Sessions ......................................................125
MiniSoft PowerTerm .........................................................................126
Netmanage Chameleon.......................................................................128
HostLink 97 ................................................................................128
Unixlink 97 Version 7.0 .............................................................131
PDSI Psched Software DDE Interface ...............................................133
Persoft SmarTerm ..............................................................................138
Quarterdeck Procomm Plus 32 ..........................................................140
Sendkeys ............................................................................................142

viii Contents
Teknekron On Demand Software DDE Interface ............................. 144
Upstanding Systems FASTerm for Windows ................................... 147
Wall Data Rumba Office ................................................................... 152
WRQ Reflection ................................................................................ 157
WRQ R1 Sample ........................................................................ 158
WRQ R2 Sample ........................................................................ 159
WRQ R8 Reflection for Windows Sample ................................ 159
WRQ R8 Reflection for IBM for Windows 95 Sample ............. 161
Zephyr Development Passport 3270 Client ...................................... 164
G Special EXTRA! Key Sequences ........................................ 169
H Configuring For Driver Files................................................. 173
I Error Messages
STARTUP.BAS Module.................................................................... 175
CONFIG.CNP Procedure Errors................................................. 175
FOCUS_APPS Procedure Errors ................................................ 176
HOST_LINK Procedure Errors .................................................. 176
INIT_CNP Procedure Errors....................................................... 177
FOCUS_APPS Procedure Error.................................................. 178
CNP.BAS Module.............................................................................. 178
CUT_DATA Procedure Error..................................................... 178
PASTE_DATA Procedure Errors ............................................... 178
SendDDEMessage Procedure Error............................................ 179
SEND_KEY Procedure Errors.................................................... 179
SEND_PFKEY Procedure Errors ............................................... 179
SETUP_CNP Procedure Errors .................................................. 180
TOGGLE_HOST Procedure Error.............................................. 180
CP.FRM Module ................................................................................ 180
AUTO_CNP.TIMER Procedure Error........................................ 180
Form.Resize Procedure Errors .................................................... 181
Menu_exit.Click Procedure Error ............................................... 181

Contents ix
FKEYS.FRM Module.........................................................................181
KeyButton.Click Procedure Errors..............................................181
LOGON.FRM Module........................................................................182
cmdLOGON.Click Procedure Errors ..........................................182
Index.................................................................................................183

x Contents

Introduction to Vlterm 1
Vlterm is a Windows application that runs on agent PCs that connect to a Mosaix
Predictive Dialing System and a host terminal emulator or client application.
Vlterm provides a visual interface to select Mosaix system agent features, manage
the focus between the Mosaix system and host windows, and interact with
windows using script commands. Use Vlterm to quickly integrate a VT100
emulation window connected to a Mosaix system and an existing customer
character-based emulation window, such as a 3270 terminal emulator.
When the Mosaix system sends outbound call information to an agent
workstation, it sends enough client data for an agent to initiate a conversation with
the customer. However, the agent typically needs to view and update data on a host
computer. To facilitate this host record lookup, Vlterm transfers a unique record
identifier from the Mosaix system to a host window.
As an inter-application tool, Vlterm can send information between Windows
applications. For example, Vlterm can automate user input to a 3270 host system
using data from a Mosaix system screen.
Agents use their existing host connection software along with the Mosaix system
connection software package and a Vlterm toolbar as shown in the following
illustration.
1

2 Vlterm Programmer’s Reference
Agent Workstation Features
The Vlterm graphical user interface consists of a toolbar with up to six rows of
twelve buttons located at the bottom of the PC screen. Agents can point and click
with a mouse to select among the 72 possible toolbar buttons to issue commands
to the system. You can also define a function key sequence for each button and
configure it for intercept from the Mosaix system, host, or both. The types of
actions you can configure for each button include:
• Switch between windows
• Initiate special Mosaix system releases
• Issue a line release command (for example, record release, set recall, play
message, or select alternate screen)
• Run a multiple-step script of Vlterm commands

Switch Between Windows
Introduction to Vlterm 3
An agent can click a toggle button or press a function key sequence to set the focus
to either the Mosaix system or a host window.
Multiple Step Script
You can configure a cut and paste or script button to copy a field of data from the
Mosaix system window, set the focus to the host window, and paste the data into
the host window.
Agent Workstation Software Configuration
You can configure the Vlterm toolbar labels, number of rows, window title, and
the action that each button takes when selected. A vlkeys.ini configuration file
controls the look and action of the toolbar. A vlterm.ini file contains configuration
information on the number and types of windows with which to communicate and
the scripts associated with toolbar actions.
A button can issue a simple line release command to the system or run a script that
performs multiple steps such as the following sequence of commands:
1 Release the phone line.
2 Navigate host screens.
3 Input standard comments to the host screen.
4 Release the current record.
5 Set the focus for the session to wait for the next call.
Agent Use Case Scenario
1 An agent double-clicks the Mosaix Agent icon to start Vlterm. Vlterm
launches the specified system and host terminal emulator programs if they
are not already running. Vlterm establishes a connection to each of these
windows and displays a toolbar.
2 The agent logs on to the host application and navigates to the record lookup
data screen.
3 The agent toggles to the Mosaix system window, logs on, joins a calling
campaign, and waits to receive calls.

4 Vlterm Programmer’s Reference
4 When a call is received, the agent clicks the record lookup button on the
toolbar. Vlterm follows a configured script to cut account data from a field
on the Mosaix system screen and query records on the host system. The
focus remains on the host screen for data input.
5 At the end of the conversation, the agent clicks one of the line release types
on the toolbar.
6 The agent finishes the host data input and releases the record to receive a
new call.
System Requirements
The agent’s workstation must be a Microsoft Windows PC with sufficient system
resources to run both a Telnet connection VT100 emulator for the Mosaix system
and a host communications window. Check with the emulator vendors for
recommended system requirements.
Vlterm requires Windows 95, Windows 98 or Windows NT. Vlterm can
communicate with Windows 95, 98, and NT 32-bit emulator applications if they
can accept incoming data from another application using one of the following
communications methods:
• DDE
• OLE automation
• HLLAPI
• SendKeys
With the exception of SendKeys, implementation of each inter-application
communication method is specific to individual emulator vendors.
This document lists the major emulator vendor software packages that Vlterm
supports. Other software must be evaluated. Software modifications may be
required for an unsupported emulator.

Mosaix Terminal Emulation Applications
Introduction to Vlterm 5
The Mosaix system terminal emulation application must be a DEC VT100
emulation mode software product. The following list identifies three such
applications:
• Wall Data Rumba for UNIX/VAX
• WRQ Reflection R2
• Attachmate KEA! 340
The emulator must support a TCP/IP Telnet connection type and have a DDE
server interface, or the emulator, such as the Microsoft telnet.exe application, must
work with SendKeys.
Host Terminal Emulation Applications
The type of host system and the type of terminals that can attach to the host
determine the emulator software choice. If the host is an IBM mainframe, you
usually use a 3270 series terminal emulator such as the following options:
• Wall Data Rumba for Mainframe
• Attachmate EXTRA! for Windows
The IBM AS/400 minicomputer uses 5250 terminal emulation, such as Wall
Data’s Rumba for AS/400.
Some emulation vendors offer suites that integrate multiple terminal emulation
types such as VT100, 3270, and 5250 into one package. Wall Data Rumba Office
and Attachmate EXTRA! Enterprise are examples of these suites.
Inter-Application Communications
To integrate the Mosaix system at the agent desktop level with existing customer
applications, some means of communications must exist. In broad terms, there are
two options in the Microsoft Windows environment for applications to
communicate.
The first option is to use an Application Programming Interface (API) between the
Mosaix system application and the customer application. For example, a customer
using the Wall Data Rumba terminal emulation product can use the existing
Vlterm capabilities to exchange data using Dynamic Data Exchange (DDE). DDE

6 Vlterm Programmer’s Reference
is an API that Microsoft developed as a means to copy information between two
Windows applications.
A second option to consider if an API is not available is to simulate keystrokes
with SendKeys.
SendKeys
Vlterm can send keystrokes to a Windows application to which Vlterm linked
during startup if the emulator can accept keystrokes from a source other than the
keyboard.
Use the SendKeys method to send cut and paste information to a window that does
not support an API server. To implement SendKeys, a sending application must
set the Windows focus to the receiving application, then issue the SendKeys
command to simulate the keystrokes needed to send the characters.
There are limitations with SendKeys. SendKeys can’t pace the speed at which it
sends information to the application. For example, you must insert fixed length
pauses between SendKeys commands to allow the receiving application to display
the next screen after a user presses Enter.
In addition, after the focus has been sent to an application, SendKeys assumes the
focus does not change. During a send operation in a multi-tasking environment
(for example, Windows NT), another application, such as a print complete
message window, can take the focus.
The need to interact with the host window may involve more than sending an
account number by simulation keystrokes. For 3270 host windows, for example,
keyboard input is inhibited for a variable amount of time after pressing Enter
(indicated by an OIA keyboard lock status).
SendKeys would not be a sufficient solution if script commands must follow a
script command that generates an OIA lock. An API solution is the more robust
solution, although it generally takes more time to implement.
DDE
Dynamic Data Exchange is a method of communicating between Microsoft
Windows applications. Vlterm is best suited to use this communication method.
Vlterm acts as the DDE client; the host emulation software must be able to operate
as a DDE server.

OLE
Introduction to Vlterm 7
If you need to receive status information from the host window or perform a
reverse cut and paste from the host to the Mosaix system for inbound update, use
DDE instead of simulating keystrokes.
The commands to send information from client to server vary between emulation
vendors. Vlterm uses modifiable DDE configuration files to define what DDE
commands must be sent to an emulator. DDE can be configured using text-based
.ini files to connect to, receive from, and send data to a DDE server application.
Object linking and embedding (OLE) is a Microsoft Windows protocol that
defines a method to exchange information between processes. Some 32-bit
emulation applications written for Windows 95, 98, or NT support OLE.
A specific OLE interface must be created for each application with which Vlterm
communicates. An OLE interface is supported for Attachmate EXTRA! Personal
Client for Windows 95/NT.

8 Vlterm Programmer’s Reference

Installing Vlterm 2
Installation Methods
The Vlterm installation includes all the files associated with the Vlterm
application and a pair of configuration (*.ini) files that a Lucent representative sets
up based on the customer’s environment. There are three Vlterm installation
methods. Regardless of which method you use, you need to place the customized
configuration files on each agent workstation.
Install Vlterm using any of the following methods:
• Install Vlterm from the CD-ROM to a PC hard drive. Copy the mirror image
of the hard drive to the agent workstations.
• From each agent PC, access the Vlterm install routine from a shared network
CD-ROM drive. Copy the customized configuration files to each agent
workstation.
• Install Vlterm onto each agent workstation directly from the Vlterm
CD-ROM. Copy the customized configuration files to each agent
workstation.
Command Line Options
The Vlterm setup process automatically creates a Start menu option for Vlterm. If
the Vlterm configuration files have non-standard names (for example, if you
renamed the vlterm.ini and vlkeys.ini files), you can modify the Start menu option
to include the specially named configuration files by setting the option’s
associated properties:
[path]vlterm.exe [“path\vlterm.ini”] [“path\vlkeys.ini”]
Vlterm requires that you place quotation marks around each argument in the
vlterm.exe command line (don’t include the brackets).
9

10 Vlterm Programmer’s Reference
The location of the Vlterm shortcut depends on your system’s operating system:
• Windows 95
c:\Windows\Start Menu\Programs\Vlterm
• Windows 98
c:\Windows\Start Menu\Programs\Vlterm
• Windows NT
c:\Winnt\Profiles\All Users\Start Menu\Programs\Vlterm
Vlterm File Reference
The following sections list Vlterm’s executable and configuration files.
Core Vlterm Executable and Configuration Files
VLTERM.EXE
EXTDRV.EXE
VLKEYS.INI
VLTERM.INI
DDE Configuration Files
ACC_DDE.INI IRM_DDE.INI REF_DDE.INI
CAB_DDE.INI KEA_DDE.INI RUM_DDE.INI
DRV_DDE.INI MIN_DDE.INI RUM1_DDE.INI
EXT_DDE.INI OND_DDE.INI SMA_DDE.INI
FACE_DDE.INI PDSI_DDE.INI SPRY_DDE.INI
FAS_DDE.INI PRO_DDE.INI TCP_DDE.INI
HST_DDE.INI PTW_DDE.INI TER_DDE.INI
IBM_DDE.INI
IE4_DDE.INI
QWS_DDE.INI WIN_DDE.INI

Vlkeys.ini Configuration 3
The vlkeys.ini configuration file contains the parameters that control the look and
actions for the Vlterm toolbar buttons. The vlterm.exe program reads the
vlkeys.ini and vlterm.ini configuration files during startup.
You can also associate function key sequences with toolbar buttons. This feature
allows customers to use keystrokes instead of PC mouse operations in a terminal
environment. A third-party tool from Desaware translates a function key sequence
into the appropriate action.
You can display up to six rows of twelve buttons. The 72 possible function key
equivalents are organized by toolbar row.
Toolbar Row # Key State Function Key
1st row Unshifted F1-F12
2nd row Shift F1-F12
3rd row Control F1-F12
4th row Alt F1-F12
5th row Control+Shift F1-F12
6th row Control+Alt F1-F12
Toolbar Button Definitions
Toolbar button definitions appear in the [VOICELINK_KEYS] section of the
vlkeys.ini file.
11

12 Vlterm Programmer’s Reference
Syntax
Action
For each toolbar button, the vlkeys.ini file contains a KEYn= definition line that
includes six parameters.
KEYn=action,session,label,focus~tooltip~color
The commas separating the first four parameters in the key1 through key72
configuration lines must be included. The remaining two parameters are optional.
Examples
key1=CNP1,0,Cut/Paste,1~Host record lookup~12
key2=Ay,0,COM PTP,0~Co-Maker Promise to Pay~7
key3=TGL9,9,Toggle,0~Switch focus between sessions~1
key4=FRM1,9,Misc,0~Menu of misc release codes~7
key5=CNP4,0,DONE,0~Release Record~4
When you define a toolbar button, you can choose between five actions:
• TGLn-toggle to session n
The variable n specifies a session number. Use TGL9 to toggle through each
of the sessions in succession rather than to a specific session.
• CNPn-cut and paste n
The variable n specifies a cut and paste script that is defined in the vlterm.ini
file. See “[CNPn]” on page 30 for more information about cut and paste
scripts.
• A release code to send to the system
For release codes, a CTRL A (SOH, ASCII hex 01, or ^A) precedes the key
sequence value and a CTRL M (CR, ASCII hex 13, or ^M) follows it. In the
previous example for key2, Vlterm sends the sequence ^AA^M to the Mosaix
system. You can include a “y” after the release code, as in the key2 example,
to automatically respond to the Mosaix system Are you sure? prompt.
• FRMn-load a user-definable form
For more information about custom forms, see Chapter 9, “Configuring a
Custom Form,” beginning on page 75.

Vlkeys.ini Configuration 13
Session
The session parameter identifies the session in which Vlterm intercepts the
function key. In other sessions, the function key is ignored. This parameter must
be a valid session number. Use 0 for the Mosaix system emulator session, 1
through n (host session number) for a host emulator session, or 9 to intercept the
key in all Vlterm sessions.
Label
Focus
The label parameter defines the text that appears on the button. Labels need to fit
in the limited space on the toolbar button, typically seven characters. Use
lowercase characters where possible; uppercase characters take more space.
The focus parameter identifies the session that has the Windows focus at the end
of the command. Use 0 for the Mosaix system emulator session or 1 through n
(host session number) for a host emulator session. If you don’t define the focus
parameter, the focus does not change.
Tooltip
A tool tip is text that appears when the mouse cursor is placed over a button when
the Vlterm toolbar has the focus. Use this parameter for a longer description for
the button than what the label allows. Tool tips are optional, and the last tilde (~)
is required only if you set the color parameter.
Color
The color property defines the background color for the button on the GUI toolbar.
Setting a button background color is optional, and the tilde (~) is not required if
you don’t define a color. The following table contains color codes.

14 Vlterm Programmer’s Reference
Sample File
NOTE The default color is set to 0 (black), which is the same as the default text
color. Change the background color of the button to avoid a black-on-black
toolbar button.
0-Black 8-Gray
1-Blue 9-Light Blue
2-Green 10-Light Green
3-Cyan 11-Light Cyan
4-Red 12-Light Red
5-Magenta 13-Light Magenta
6-Yellow 14-Light Yellow
7-White 15-Bright White
To change the text color, use the Windows Display Properties, Font setting. The
text change is workstation-wide, not toolbar button specific.
; Generic keys
; Vlterm
[VOICELINK_KEYS]
; keyn=6 fields, first 4 separated by commas, last 2 by tilde:
;; Unshifted
; key1 through key12 correspond to F1 - F12
Key1=TGL9,0,Toggle,~Switch focus between windows~7
key2=CNP1,0,GetRec,~Get host record lookup~7
key3=B,0,Done,~Get next Mosaix record~7
key4=C,0,SetRcl,0~Set a Mosaix time and date recall~7
key5=D,0,RclRel,0~Recall line release~7
key6=E,0,Trnsfr,0~Transfer call~7
key7=F,0,TrnRel,0~Transfer release~7
key8=G,0,Dial,~Telephone dial command menu~7
key9=H,0,MDial,~Managed dial command menu~7

key10=I,0,Misc,~Misc command menu~7
key11=J,0,,~~7
key12=K,0,Logout,~Log out of Mosaix~7
; Shifted
; key13 through key24 correspond to ShF1 - ShF12
key13=L,0,Rel A,1~Line release A~7
key14=M,0,Rel B,1~Line release B~7
key15=N,0,Rel C,1~Line release C~7
key16=O,0,Rel D,1~Line release D~7
key17=P,0,Rel E,1~Line release E~7
key18=Q,0,Rel F,1~Line release F~7
key19=R,0,Rel G,1~Line release G~7
key20=S,0,Rel H,1~Line release H~7
key21=T,0,Rel I,1~Line release I~7
key22=U,0,Rel J,1~Line release J~7
key23=V,0,Rel K,1~Line release K~7
key24=W,0,Rel L,1~Line release L~7
Vlkeys.ini Configuration 15
; Control
; key25 through key 36 correspond to CtlF1 - CtlF12
key25=X,,,~~
key26=Y,,,~~
key27=Z,,,~~
key28=a,,,~~
key29=b,,,~~
key30=c,,,~~
key31=d,,,~~
key32=e,,,~~
key33=f,,,~~
key34=g,,,~~
key35=h,,,~~
key36=i,,,~~

16 Vlterm Programmer’s Reference
; Alt
; key37 through key 48 correspond to AltF1 - AltF12
key37=j,,,~~
key38=k,,,~~
key39=l,,,~~
key40=m,,,~~
key41=n,,,~~
key42=o,,,~~
key43=p,,,~~
key44=q,,,~~
key45=r,,,~~
key46=s,,,~~
key47=t,,,~~
key48=u,,,~~
;key49 through key60
key49=,0,,0~~7
key50=,0,,0~~7
key51=,0,,0~~7
key52=,0,,0~~7
key53=,0,,0~~7
key54=,0,,0~~7
key55=,0,,0~~7
key56=,0,,0~~7
key57=,0,,0~~7
key58=,0,,0~~7
key59=,0,,0~~7
key60=,0,,0~~7
;key61 through key 72
key61=,0,,0~~7
key62=,0,,0~~7
key63=,0,,0~~7
key64=,0,,0~~7

key65=,0,,0~~7
key66=,0,,0~~7
key67=,0,,0~~7
key68=,0,,0~~7
key69=,0,,0~~7
key70=,0,,0~~7
key71=,0,,0~~7
key72=,0,,0~~7
Vlkeys.ini Configuration 17

18 Vlterm Programmer’s Reference

Vlterm.ini Configuration 4
The vlterm.ini configuration file provides most of the specific information about
the operating environment. For example, vlterm.ini includes parameters that
control the emulator applications that must be started, the window title of each
emulator window, specifications to communicate with an emulator, and the names
of other .ini files. In addition, any script commands are organized within this
configuration file as CNP sections.
Standard Windows .ini file conventions are used. Sections enclosed in brackets [ ]
can appear in any order within the file. All entries are unique; Vlterm reads them
individually and they can appear in any order within the section. To include spaces
in an entry, enclose the value following the equal sign in quotation marks (“ ”).
Duplicate keywords or missing required entries generate an error message.
Entries in the .ini files are not case sensitive. You can add comments by starting a
line with a semi-colon or inserting a semi-colon in the middle of a line.
NOTE Certain Windows versions have problems reading .ini configurations if
spaces are used (instead of tabs) between configuration items or if a comment is
startedonthesameline.
The rest of this chapter contains a sample vlterm.ini file and descriptions of the
sections in the vlterm.ini file.
Sample Vlterm.ini File
[GLOBAL]
DEBUG=OFF
MAX_SESSIONS=1
MAX_CUTS=5
MAX_PASTES=10
19

20 Vlterm Programmer’s Reference
NUMBER_CNPS=27
NUMBER_VARS=15
AUTO_INTERVAL=5
AUTO_ENABLED=N
Errorlog=N
ShowSplashScreen=Y
FunctionKeys=Y
TblName=C:\program files\vlterm\table.txt
[SHELL]
HTERM0=C:\Progra~1\WallData\VT\Rumbavt.exe
C:\Progra~1\WallData\VT\mosaix.WDU
S_DELAY0=3
HTERM1=C:\Progra~1\WallData\mframe\Rumbadsp.exe
C:\Progra~1\WallData\mframe\host.WDU
S_DELAY1=3
[WIN_TITLE]
HWIN0=Mosaix*
HWIN1=Host*
[DDE_SESSION]
DDE_TIMEOUT=5
DDE_DELAY0=3
HOST_SERVER0=rumbavt
HOST_TOPIC0=Mosaix.vtp
HOST_ITEM0=
USE_DDE0=Y
DDE_CONFIG_SESSION0=RUM_DDE.INI
DDE_DELAY1=3
HOST_SERVER1=rumbadsp

HOST_TOPIC1=SESSIONA.dsp
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=RUM_DDE.INI
[FKEY_BUTTONS]
DISPLAY_FKEYS = Y
KEYS_FILE=
FKEYS_ON_TOP=Y
CAPTION=Vlterm for Rumba
DISPLAY_TOOLTIPS=Y
FKEYS_POSITION=Bottom
ROW1=Y
ROW2=Y
ROW3=N
ROW4=N
ROW5=N
ROW6=N
[CNP1]
CNP_NAME=Host Lookup
CUT_SESSION=0
PASTE_SESSION=1
CNP_TYPE=2
AUTO_CUT_COMPARE=
NUMBER_CUT_COMMANDS=2
NUMBER_PASTE_COMMANDS=6
; row1, col1 row2, col2
CUT_CMD1=(2,19,2,36)
CUT_CMD2=(8,11,8,22)
PASTE_CMD1=C(1)
PASTE_CMD2=@E
Vlterm.ini Configuration 21

22 Vlterm Programmer’s Reference
PASTE_CMD3=OIA,*0*
PASTE_CMD4=@T
PASTE_CMD5=C(2)
PASTE_CMD6=@E
; END OF VLTERM.INI
Vlterm.ini File Configuration Settings
[GLOBAL]
The vlterm.ini file contains several sections. Each section contains configuration
settings. The following sections identify the sections and the corresponding
settings.
DEBUG
DEBUG=[OFF|ON]
The DEBUG setting lets you choose to use (ON) or suspend (OFF) tight error
checking of the vlkeys.ini and vlterm.ini files during Vlterm startup. For example,
if you disable DEBUG, Vlterm allows for mismatched values between the
NUMBER_PASTE_COMMANDS= value and the actual number of paste
command lines.
Set the Debug value in all uppercase. For example:
DEBUG=OFF
MAX_SESSIONS
MAX_SESSIONS=n
MAX_SESSIONS identifies the number of sessions Vlterm controls (0–8). The
Mosaix system session is 0. If you communicate with one host, enter
MAX_SESSIONS=1. This is a required field.

Vlterm.ini Configuration 23
MAX_CUTS
MAX_CUTS=n
MAX_CUTS identifies the maximum number of cut commands in any individual
CNP section. Use this setting to allocate dynamic storage arrays for the
commands. The MAX_CUTS value must be greater than or equal to the number
of cut commands you define. The default is 10.
MAX_PASTES
MAX_PASTES=n
MAX_PASTES identifies the maximum number of paste commands in any
individual CNP. Use this setting to allocate dynamic storage arrays for the
commands. The MAX_PASTES value must be greater than or equal to the number
of paste commands you define. The default is 15.
NUMBER_CNPS
NUMBER_CNPS=n
The NUMBER_CNPS value identifies the highest CNPn section number. For
example, if you define three CNP sections, set NUMBER_CNPS to 3. The default
is 1.
NOTE The value for NUMBER_CNPS must match the number of CNPn
sections that you define.
AUTO_INTERVAL
AUTO_INTERVAL=n
AUTO_INTERVAL identifies the timer interval in seconds for automatically
executing any CNP with CNP_TYPE=1, an automatic type CNP. The default is 3
seconds.
AUTO_ENABLED
AUTO_ENABLED=[Y|N]
AUTO_ENABLED lets you specify whether or not the timer for CNPs with
CNP_TYPE=1 is enabled at startup. In many cases, the emulator sessions are not
on the correct screen for the automatic CNP when Vlterm starts. The agent may

24 Vlterm Programmer’s Reference
have to logon and navigate to the start screen before the timer can be enabled. The
agent can enable the timer using a CNP script that uses the START_AUTO_CNP
paste command.
NUMBER_VARS
NUMBER_VARS=n
NUMBER_VARS identifies the number of global variables you define, based on
the number of variables you need for the CNP sections. The default is 0. You can
add variables to the vlterm.ini as VAR1 through VARn or as a SetVarn paste
command, or the agent can enter the variables using the INPUT paste command.
You can use SetVarn to conditionally set a variable from cut data, then refer to the
variable in other CNP sections.
VARn
VARn=variable
VARn allows you to define an initial value for a global variable. n is the global
variable number. The variable value can be any text.
ShowSplashScreen
ShowSplashScreen=[Y|N]
The default, Y, shows the splash screen at startup.
TblName
TblName=C:\Program Files\Vlterm\table.txt
TblName identifies the path and file name for the file that contains lookup data.
Configure this setting if you use the paste command Lookup(). The lookup file
must be comma delimited. Do not specify a file name if you are not using the
Lookup() function. The default is no file name.

Vlterm.ini Configuration 25
ERROR_LOG
ERROR_LOG=[Y|N]
The ERROR_LOG option indicates whether or not Vlterm activates an error log.
Y activates the error log. N inactivates the error log. The default value is N.
When activated, Vlterm writes error messages to the vlterr.log, which is located in
the same directory as the Vlterm executable (vlterm.exe).
FunctionKeys
FunctionKeys=[Y|N]
FunctionKeys allows you to disable the function key intercept. A value of Y
enables function key intercept. A value of N disables function key intercept. The
default value is Y.
With function key intercept enabled, each time an agent uses a PC keyboard
function key, Vlterm evaluates the key against the vlkeys.ini configuration file
settings to determine the corresponding user-defined action.
[SHELL]
HTERMn
HTERMn=command_line
HTERMn defines the command line that starts a session. Define one HTERMn
line for each session that Vlterm controls. n is the session number. The Mosaix
system must be session 0.
The command line contains the path, executable file (.exe) name, and the session
profile name. This is the same command that you would use to start the session
from the Windows Start menu Run command. HTERMn is a required field.
Example with short file names:
HTERM0=C:\Progra~1\WallData\VT\Rumbavt.exe
C:\Progra~1\WallData\VT\mosaix.WDU
Example with long file names:
HTERM0=C:\Program Files\WallData\VT\Rumbavt.exe C:\Program
Files\WallData\VT\mosaix.WDU

26 Vlterm Programmer’s Reference
S_DELAYn
S_DELAYn=m
S_DELAYn lets you set a value (in seconds) that causes a delay between
launching the HTERMn session and the next operation. n is the session number.
m is the number of seconds to delay.
This is an optional parameter that you may need to use with slower systems or
during remote testing over dial-up lines when you need to wait for the HTERMn
application to start. The default is 3. If the S_DELAY value is greater than 60,
Vlterm changes the value to 3.
[WIN_TITLE]
HWINn
HWINn=window title text
HWINn identifies a sessions window title. n is the session number.
The text must exactly match the running emulator title so that Vlterm can identify
with which windows to communicate. Spacing must be exact. The Windows title
bar uses proportional fonts and compresses spaces making it difficult to determine
the exact number of spaces present. The exact Windows title may change between
release versions of an emulator vender. HWINn is a required field for each
session.
[DDE_SESSION]
USE_DDEn
USE_DDEn=[Y|N]
USE_DDEn specifies whether a session uses DDE as its method of
communication. n is the session number.
If you set USE_DDEn to Y, the session to which Vlterm communicates must
support DDE. When you use DDE, you can use any of the commands described
in Chapter 5, “Cut Commands,” beginning on page 35 and Chapter 6, “Paste
Commands,” beginning on page 39.

Vlterm.ini Configuration 27
If the session does not use DDE as its method of communication, set USE_DDEn
to N. Vlterm bypasses the remaining DDE section for this session. For example,
set USE_DDEn to N (USE_DDE1=N) if the terminal emulator does not support
DDE and you are using SendKeys functionality to send information to that
emulator. When you don’t use DDE, you can use a limited set of cut and paste
commands. See Appendix B, “Using the SendKeys Function,” beginning on page
101 for a list of available SendKeys commands.
The default is Y (indicating that the session uses DDE).
HOST_SERVERn
HOST_SERVERn=application name
HOST_SERVERn identifies an emulators DDE application name. n is the session
number.
Vlterm uses HOST_SERVERn as the first of two DDE parameters required to
specify a DDE server. It is typically the executable name.
The application name is unique to each emulator.
Emulator Application Name
Rumba for the VAX rumbavt
Rumba for the Mainframe rumbadsp
RumbafortheAS/400 rumbawsf
KEATerm 420 kt420
KEATerm 340 kt340
Reflection R2 r2win
Reflection R4 r4win
Reflection R8 r8win
Irma Mainframe Display kt420

28 Vlterm Programmer’s Reference
HOST_TOPICn
HOST_TOPICn=profile name/identifier
Vlterm uses HOST_TOPICn as the second of two DDE parameters required to
specify a DDE server. n is the Vlterm session number. HOST_TOPICn is often the
emulator profile name.
The profile name or identifier value varies by emulator.
Emulator Profile Name or Identifier
Rumba for the VAX profile.vtp
Rumba for the Mainframe profile.dsp
Rumba for the AS/400 profile.wsf
Reflection R2 RCL
Reflection R8 CONTROL
KEAterm 340/420 macro
IRMA for windows SESSIONA (or B, C, etc. for session)
DDE_TIMEOUT
DDE_TIMEOUT=n
DDE_TIMEOUT identifies the number of seconds before a DDE request times
out. The default is 10 seconds. You may need to increase this number if host
response time is unusually high.
DDE_DELAYn
DDE_DELAYn=m
DDE_DELAYn defines for each session the number of seconds in a wait loop. n
is the session number.
Typically, this delay is not required. However, if a session is slow to respond for
any reason, increase the number. The default is 3 seconds.

Vlterm.ini Configuration 29
DDE_CONFIG_SESSIONn
DDE_CONFIG_SESSIONn=file_dde.ini
DDE_CONFIG_SESSIONn specifies the name of the DDE host configuration file
for each emulator session with which Vlterm must communicate. n is the session
number.
vlterm.ini contains the DDE commands needed for each of the macro commands
that interact with an emulator. More than one session can use the same file, or you
can create a different file for each session even if the sessions use the same
emulator.
[FKEY_BUTTONS]
DISPLAY_FKEYS
DISPLAY_FKEYS=[Y|N]
Y displays the function key toolbar. N does not display the toolbar. This is a
required field.
FKEYS_ON_TOP
FKEYS_ON_TOP=[Y|N]
FKEYS_ON_TOP determines whether a Windows API is used to keep the toolbar
as the topmost window. You can use the SHOW_FKEYS and HIDE_FKEYS
paste commands to dynamically change whether the toolbars are visible (for
example, to hide them in selected sessions). FKEYS_ON_TOP is a required field.
CAPTION
CAPTION=title
CAPTION sets the title on the main Vlterm button bar. The default title is “ ” or
blank.

30 Vlterm Programmer’s Reference
ROWn
ROWn=[Y|N]
ROWn determines which rows of the toolbar are visible. n is the number of a row
of buttons (1–6).
A value of Y displays the row. A value of N hides the row. The default is N. The
following example tells Vlterm to display only the first two toolbar rows.
ROW1=Y
ROW2=Y
ROW3=N
ROW4=N
ROW5=N
ROW6=N
Any rows can be omitted; the remaining rows are repositioned. Vlterm sizes the
FKEYS form to the width of the screen for the current resolution.
DISPLAY_TOOLTIPS
DISPLAY_TOOLTIPS=[Y|N]
DISPLAY_TOOLTIPS indicates whether tooltips appear when the Fkeys form
has the focus. The default Y. You can activate this option from the pop-up menu
on the toolbar form.
FKEYS_POSITION
FKEYS_POSITION=[TOP|BOTTOM]
FKEYS_POSITION determines the starting position of the toolbar, either at the
top or bottom of the screen. The default location is BOTTOM.
[CNPn]
CNPn sections identify a cut and paste script to execute. n specifies a number, 1
through n. The maximum value for n is the value of NUMBER_CNPS in the
[GLOBAL] section.

Vlterm.ini Configuration 31
NUMBER_CUT_COMMANDS
NUMBER_CUT_COMMANDS=n
NUMBER_CUT_COMMANDS specifies the number of CUT_CMDs to execute.
This is a required field.
NUMBER_PASTE_COMMANDS
NUMBER_PASTE_COMMANDS=n
NUMBER_PASTE_COMMANDS specifies the number of PASTE_CMDs to
execute. Gradually incrementing the number of commands and verifying partial
results is a good way to test complex sequences. This is a required field.
CUT_SESSION
CUT_SESSION=n
CUT_SESSION specifies the host session number from which to cut. The Mosaix
system session is always 0. To cut from different sessions with a single agent
command, use the CNPn paste command to branch to another [CNPn] section that
contains CUT_SESSION=n set to a different number. This is a required field.
PASTE_SESSION
PASTE_SESSION=n
PASTE_SESSION specifies the host session number to which to paste. The
Mosaix system session is always 0. To paste to different sessions with a single
agent command, use the CNPn paste command to branch to another [CNPn]
section that contains PASTE_SESSION=n set to a different number. This is a
required field.
CNP_TYPE
CNP_TYPE=n
CNP_TYPE indicates the type of cut and paste. A value of 1 indicates an
automatic cut and paste. If the CNP type is set to automatic, the CNP will execute
at the time interval set in the AUTO_INTERVAL parameter in the [GLOBAL]
section. If the AUTO_CUT_COMPARE in the [CNPn] section specifies a cut
command number, the script compares the previous cut value against the specified
cut command results to determine whether the rest of the script is executed.

32 Vlterm Programmer’s Reference
A CNP_TYPE value of 2 indicates a manual cut and paste. This is the default.
A CNP_TYPE value of 3 indicates logon. This is needed for any CNP command
used as part of logon sequence. Other CNP commands, such as automatic, are
ignored until logon is finished.
A CNP_TYPE value of 4 indicates a DDE cut and paste. This is a hot link similar
to an automatic cut and paste. The link is to the item contained in CUT_CMDn
specified by AUTO_CUT_COMPARE in the session specified as the
CUT_SESSION within the [CNPn]. This works just like the automatic cut and
paste, but instead of performing a DDE cut based upon a timer, the link is told in
the changed event.
AUTO_CUT_COMPARE
AUTO_CUT_COMPARE=n
AUTO_CUT_COMPARE identifies the cut number used to compare data
between outbound screen pops to determine if the field has changed since the last
time it was automatically copied. This is a required field if the CNP_TYPE is
type 1.
CUT_CMDn
CUT_CMDn=format
CUT_CMDn identifies the command line format for each cut command. n begins
with 1 and continues to the value set in NUMBER_CUT_COMMANDS. The
highest value for n (the number of cut commands that you define) must equal the
value of NUMBER_CUT_COMMANDS. Cut command numbers must be
sequential.
The command lines specified follow the same format as the paste command lines,
with the exception that the action is limited to copying text from a specified area.
The source window from which the text is copied is determined by the
CUT_SESSION parameter.
For information about cut command formats for various emulator applications,
see Chapter 5, “Cut Commands,” beginning on page 35.

Vlterm.ini Configuration 33
PASTE_CMDn
PASTE_CMDn=a predefined script command or text to send
PASTE_CMDn identifies a predefined script or text to send for each paste
command. n begins with 1 and continues to the value set in
NUMBER_PASTE_COMMANDS. The highest value for n (the number of paste
commands that you define) must equal the value of
NUMBER_PASTE_COMMANDS. Paste command numbers must be sequential.
The session window to which paste command is directed is determined by the
PASTE_SESSION parameter.
For information about paste command formats, see Chapter 6, “Paste
Commands,” beginning on page 39.

34 Vlterm Programmer’s Reference

Cut Commands 5
Define cut commands in the CNPn sections of the vlterm.ini file. See “[CNPn]”
on page 30 for more information about setting up cut and paste actions in the
vlterm.ini file. Vlterm uses cut commands to identify a location on a screen from
which it copies a specified amount of data. Typically, you define paste commands
that transfer and apply the copied data to another session(s). For information about
paste command options, see Chapter 6, “Paste Commands,” beginning on page 39.
Emulator Formats
Different emulator applications use different formats to specify a cut location. The
following sections define the cut command formats for a variety of emulators.
Attachmate KEA!
(page,row,column,length)
You must include a page value. Use 1 for the Mosaix system page number. Each
screen for each session should have its own unique page number. Row and column
values begin with 1.
For example, CUT_CMD1=(1,3,5,9) copies nine characters beginning at the third
row and fifth column from the Mosaix system session.
35

36 Vlterm Programmer’s Reference
Attachmate Extra!
(PxxxxLyyyy)
The xxxx variable is the presentation space starting position. Typically, it ranges
from 1 through 1920 or the maximum number of characters on the screen. The
yyyy variable is the length to cut.
For example, CUT_CMD1=(P0165L0009) copies nine characters (Length)
beginning at screen Position 165.
Wall Data Rumba
(rr1,cc1,rr2,cc2)
The rr1 and cc1 variables specify the starting row and column for the cut. The rr2
and cc2 variables specify the ending row and column for the cut. Rows range from
1 through 24. Columns range from 1 to 80.
For example, CUT_CMD1=(3,5,3,13) copies data beginning at the fifth column
of the third row and ending at the thirteenth column of the third row.
WRQ Reflection
DRV
(rr1,cc1,rr2,cc2)
The rr1 and cc1 variables specify the starting row and column for the cut. The rr2
and cc2 variables specify the ending row and column for the cut. Row values
range from 0 through 23. Column values range from 0 through 79.
For example, CUT_CMD1=(3,5,3,13) copies data beginning at the sixth column
of the fourth row and ending at the fourteenth column of the fourth row.
(row, col, len)
Use this format to communicate to external interfaces that use the drv_dde.ini
DDE configuration file.
For example, CUT_CMD1=(3,5,9) copies nine characters beginning at the fifth
column of the third row.

ClipCut()
Cut Commands 37
ClipCut(key_sequence~(row,col,len))
ClipCut() Copies the contents of the emulator screen to the Windows clipboard.
ClipCut() uses the key_sequence to return a string from a designated row and
column position.
Use ClipCut() when the emulator doesn’t support any other API. Use ClipCut() in
conjunction with the SendKeys paste command. (See “SendKeys” on page 54 for
more information.)
Example
CUT_CMD1=ClipCut(%ea%ec~(19,9,10))
CUT_CMD2=ClipCut(~(20,9,10))
The first cut command executes an Alt+E a Alt+E c key sequence (Edit menu,
Select All option and Edit menu, Copy option) to place the screen contents on the
Windows clipboard, then places the contents of row 19, column 9, length 10 into
C(1). The second cut command places the contents of row 20, column 9, length 10
from the same clipboard to C(2).

38 Vlterm Programmer’s Reference

Paste Commands 6
@x
C()
Define paste commands (PASTE_CMDn)intheCNPnsections of the vlterm.ini
file. See “[CNPn]” on page 30 for more information about setting up vlterm.ini cut
and paste commands. Vlterm uses paste commands to send a predefined script
command or text to a Vlterm session. This chapter contains the commands
available for PASTE_CMDn.
In this chapter, special characters, such as brackets ([]), braces ({}), and the pipe
symbol (|), are often used to illustrate the syntax of paste commands. Brackets and
braces group items in syntax strings, and the pipe represents an or. Unless
specifically noted, don’t include these characters in the actual paste commands.
@x is a special keystroke command. See Appendix D, “Emulator Special @x
Keys,” beginning on page 107 for a list of the commands that you can use with
each vendor’s emulator software. Only the DDE interface type supports @x
commands. Use SendKeys() as an alternative. For information about the
SendKeys function, see “SendKeys” on page 54 and Appendix B, “Using the
SendKeys Function,” beginning on page 101.
C(n)[,Numeric][,Space][,Alphanum]
The C(n) command pastes the contents of the previously cut data, which is held in
cut variable C(n). n is the number of the CUT_CMDn script command line in the
current CNP section.
39

40 Vlterm Programmer’s Reference
The numeric, space, and alphanum options modify the data held in the variable.
C(n) Option Description
C(n),Numeric Numeric removes all non-numeric characters.
C(n),Space Space adds a space to the end of the cut data.
C(n),Alphanum Alphanum removes all non-alphanumeric characters. Use this
to eliminate tabs and other control characters that are
sometimes passed from the VT emulators.
Examples
PASTE_CMD1=C(1)
PASTE_CMD2=C(1),Numeric
If the value of C(1) is ACCT234, PASTE_CMD1 contains ACCT234.
PASTE_CMD2 contains 234.
NOTE An alternative to using these paste options is the Format() command
which provides more formatting control. See Appendix A, “Using the Format
Function,” beginning on page 91 for more information.
ClipCopyBlock()
ClipCopyBlock(VarTo~VarClip~iRow~iCol~iLen)
ClipCopyBlock() sets a variable to the row, column, and length position of another
variable. Use ClipCopyBlock() to copy text from Windows applications that don’t
support an API.
Use this command with the ClipGet() command. For example, use ClipGet() to set
a variable to hold the contents of the Windows clipboard, then use
ClipCopyBlock() to set another variable to a sub-string of the first variable.
The second variable is set with a sub-string of the contents of the ClipCopyBlock
command. The portion of the first variable that is assigned to the second variable
is the area of the clipboard defined by iRow, iCol, and iLen.
Example
PASTE_CMD1=SendKeys=%ea%ec
PASTE_CMD2=ClipGet(1)
PASTE_CMD3=ClipCopyBlock(2~1~5~9~10)

ClipGet()
ClipSet()
Paste Commands 41
The SendKeys command copies the contents of a screen to the clipboard.
ClipGet(1) places the clipboard text into VAR1. ClipCopyBlock(2~1~5~9~10)
copies the block of text located at row 5, column 9, of length 10 from VAR1 to
VAR2.
ClipGet(n)
Use ClipGet() with the ClipCopyBlock() command. ClipGet() assigns the
contents of the Windows clipboard to VARn. Then, you can use ClipCopyBlock()
or other commands to manipulate VARn.
Example
PASTE_CMD1=ClipGet(1)
The contents of the Windows clipboard is assigned to VAR1.
ClipSet({“string”|CUTn|VARn}~{Y|y|True|true})
The ClipSet() command replaces the contents of the Windows clipboard with
either a literal string, a cut, or a variable. A string argument requires quotation
marks (“ ”). The final argument appends a carriage return after the string, cut
value, or variable value. Use a Y or True value. The carriage return argument is
not case sensitive. If you don’t include the final argument, Vlterm doesn’t add a
carriage return after the string or variable.
Example
PASTE_CMD1=ClipSet(CUT1~True)
The contents of CUT_CMD1 is placed in the Windows clipboard followed by a
carriage return.

42 Vlterm Programmer’s Reference
Cursor()
The Cursor option sets the cursor to a specific 3270 screen location. The following
two sections describe the cursor command syntax for Wall Data Rumba and
Attachmate Extra!.
Wall Data Rumba
Cursor(position) or Cursor(rr,cc)
For Rumba, you can set the cursor position by specifying a presentation space
location or using row and column values. Values for position can range from 1
through 1920, which represent the total number of characters on a screen that
contains 24 rows and 80 columns. For example, row 1 contains positions 1
through 80, row 2 contains positions 81 through 160, and row 24 contains
positions 1841 through 1920.
Examples
PASTE_CMD1=Cursor(0165)
PASTE_CMD1=Cursor(3,5)
Attachmate Extra!
Cursor(Pnnnn)
The nnnn represents the presentation space location. Values for nnnn can range
from 1 through 1920, which represent the total number of characters on a screen
that contains 24 rows and 80 columns. For example, row 1 contains positions 1
through 80, row 2 contains positions 81 through 160, and row 24 contains
positions 1841 through 1920.
Example
PASTE_CMD1=Cursor(P0165)

CUTn|CVRn
CUTn|CVRn=string|CUTn|VARn:true_action:false_action
Argument Description
Paste Commands 43
n The CUT or VAR command number from the current CNP.
string or CUTn orVARn The value to compare to the cut data.
true_action Must be either Next, Exit, or CNPn where n is a different
CNP number than the CNP script that uses this command.
The true_action argument controls the script flow when the
comparison is true.
false_action Must be either Next, Exit, or CNPn where n is a different
CNP number than the CNP script that uses this command.
The false_action argument controls the script flow when the
comparison is false.
The CUTn/CVRn command branches to another CNP sequence depending on a
comparison between a variable and a string. If the comparison is true, the
true_action is carried out. If the comparison is false, then the false_action is
carried out. This is useful for making decisions based on screen content.
CVRn is another method of referring to VARn. CVR represents a cut variable. Use
CVRn only on the left side of the expression. Use VARn only on the right side of
the expression.
Examples
PASTE_CMD1=CUT1=Ready:CNP2:Exit
Vlterm compares the contents of CUT1 to the string “Ready.” If the comparison
is true, the script branches to CNP2. If the comparison is false, the script stops.
PASTE_CMD1=CVR1=:Next:CNP2
Vlterm compares the contents of the variable VAR1, which is the same as CVR1,
to a blank string. (When nothing appears between the equal sign and the colon,
Vlterm interprets the string argument as a blank string.) If the comparison is true,
the script executes the next paste statement. If the comparison is false, the script
branches to CNP2.
PASTE_CMD1=CUT1=VAR2:Next:CNP2

44 Vlterm Programmer’s Reference
Date()
Delay()
Vlterm compares the contents of the CUT1 to the variable VAR2. If the
comparison is true, the script executes the next paste statement. If the comparison
is false, the script branches to CNP2.
Date(n,format_string)
The Date command pastes the current date at the current screen location. Include
a value greater than zero to specify current date plus n days. You can use the
Format command structure to format the date. For more information, see “Using
the Format Function” on page 91.
Examples
PASTE_CMD1=Date(7,mmddyy)
Add 7 days to the current date and display it in the 041596 format.
PASTE_CMD1=Date(-1,mm/dd/yy)
Subtract 1 day from the current date and display it in the 04/15/96 format.
PASTE_CMD3=”The time is: ”
PASTE_CMD4=Date(0,hh:nn)
Displays the current time in hh:nn format: The time is: 14:25
Delay(n)
The Delay(n) paste command causes Vlterm to pause for the specified amount of
time. n is the number of seconds and can use decimal fractions.
Example
PASTE_CMD2=Delay(1.5)
Vlterm pauses for 1 1/2 seconds.

Exit_Vlterm
File()
Exit_Vlterm closes the Vlterm application.
Paste Commands 45
File({create|delete|append}~path|VARn~format|VARx~string|VARm)
Use the File() paste command to create, append to, or delete an ASCII text file.
The File() command supports three file formats: CRLF, QUOTECLRF, and
COMMA. The CRLF format places a carriage return and a line feed after each
data entry. QUOTECLRF places quotation marks around and adds a carriage
return and line feed after each entry. The COMMA format places a comma after
each data entry.
The following table provides descriptions of the File() command arguments.
Argument Description
create Creates a new file or overwrites an existing file of the
same name.
delete Deletes the specified file.
append Adds specified content to the end of an existing file or
creates the specified file if it doesn’t exist.
path|VARn The file name, including directory path, or a variable.
format|VARx Specify CRLF to insert a carriage return and line feed
after each entry, QUOTECRLF to insert quotation marks
around each entry and a carriage return and line feed after
each entry, or COMMA to insert a comma after each
entry. If you set a variable equal to CRLF, QUOTECRLF
or COMMA, you can use that variable in the File()
command.
string|VARm A string or variable to insert into the specified file.

46 Vlterm Programmer’s Reference
Find()
You must define the File() command arguments in the specified sequence. The
first argument must be one of the three actions (create, delete, or append). The
second argument must include a valid drive, path, and file name. The third
argument must be the file format, either CRLF, QUOTECRLF, or COMMA. The
final argument must contain the data that the File() command puts into the file.
Example
PASTE_CMD1=SetVar1=h:\temp\m2s2276.txt
PASTE_CMD2=SetVar2=123456789
PASTE_CMD3=File(create~Var1~CRLF~Var2)
This series of paste commands creates a new file (or overwrites an existing file)
by the name of h:\temp\m2s2276.txt that contains the string 123456789.
The Find() command supports two syntaxes:
• Find(string,rr,cc):ntrue_action:false_action
• Find(string,xxxx):true_action:false_action
Argument Description
string The value to compare to the screen data.
rr,cc A row and column position to start the search.
xxxx A single value, 1 through 1920, that represents the starting
position for the string search. 1920 represents the total number of
characters on a screen that contains 24 rows and 80 columns.
true_action Must be either Next, Exit, or CNPn where n is a different CNP
number than the CNP script that uses this command. The
true_action argument controls the script flow when the
comparison is true.
false_action Must be either Next, Exit, or CNPn where n is a different CNP
number than the CNP script that uses this command. The
false_action argument controls the script flow when the
comparison is false.
Only the Rumba and Extra! emulators support the Find() paste command.

Paste Commands 47
This function searches for a string in the paste session presentation space starting
at a location specified by a row and column setting (rr,cc) or a single value that
represents a specific position on the screen (xxxx). If the string is found, the
true_action is carried out, if the string is not found the false_action is carried out.
FocusRemain()
FocusRemain(Y|y|N|n|True|true|False|false)
The FocusRemain() option determines whether, when CNPn completes, Vlterm
directs the window focus to the most recent session that was set in the script. If
you set FocusRemain() to N or False, Vlterm directs the focus to the session
specified in the PASTE_SESSION parameter in the CNP session. FocusRemain()
Y and N arguments are not case sensitive. True and False settings can be all lower
case or use an initial capital letter.
FormatStr()
FormatStr({C(n)|VARn}~string)
FormatStr() formats the contents of C(n)orVARnaccording the mask string and
places the contents back into C(n) orVARn. Define the mask string using the
Format() command. For more information, see “Using the Format Function” on
page 91.
Example
PASTE_CMD1=SetVar1=123454678
PASTE_CMD2=FormatStr(VAR1~#,###,###.00)
PASTE_CMD3=MSG=VAR1
VAR1 contains the string 12345678. After Vlterm applies the FormatStr
command, VAR1 contains 12,345,678.00.
FormLoad()
FormLoad(n)
FormLoad(n) causes Vlterm to read from the external configuration file
FORMn.ini and load the form.

48 Vlterm Programmer’s Reference
Hide_Fkeys
The Hide_Fkeys command hides the FKEYS form. Use this command to hide the
FKEYS form during a host session.
Hide_Logon
Input
Hide_Logon hides the predefined user input logon form. Hide_Logon is
maintained for compatibility with previous Vlterm versions.
Input=message:title:n
Argument Description
message The contents of the message box.
title The message box title.
n The variable number (VARn) in which Vlterm stores the
agent-typed text.
The Input command causes an InputBox, or message box, to appear. The box can
display messages and prompt the agent to enter data into single text field. After
the agent types text, then chooses OK, Vlterm places the text in the VARn variable
for use in subsequent commands. You must define VARn in the [GLOBAL]
section of the vlterm.ini file. The title appears in the message window title bar. For
example:
PASTE_CMD1=Input=Type Data Here:Data Entry Box:1
PASTE_CMD2=MSG=VAR1
PASTE_CMD1 causes Vlterm to display a message box titled Data Entry Box to
the agent. The message box contains the Type Data Here prompt. Vlterm stores
the information typed by the agent in VAR1. PASTE_CMD 2 uses the MSG
command to display the VAR1 contents.

LeftStr()
Lookup()
Paste Commands 49
LeftStr({C(n)|VARn}~x)
LeftStr() Returns the defined number (x) of left-most characters from either a C(n)
or a VARn script variable.
Lookup(VARn~VARm)
Lookup() uses VARn as input to search a table and return a corresponding VARm
string.
Example
CUT_CMD1=ClipCut(%ea%ec~(1,1,4))
PASTE_CMD1=SetVar1=CUT1
PASTE_CMD2=Lookup(VAR1~VAR2)
PASTE_CMD3=SendKeys=VAR2
The example code cuts a four-digit number from one session and does a lookup in
the table specified in the [GLOBAL] section of vlterm.ini. For example:
TblName=C:\Program Files\Vlterm\table.txt
A lookup file must use a comma delimited variable length format. You can
generate this file with an application such as Microsoft Access. Each row in the
table consists of two fields. The first field is the search string. The second field is
the source string.
Lookup File Example
“2222”,”Phone Company”
“2300”,”Nortel Meridian”
“1332”,”Long Distance company”
Use related script commands for debugging purposes to view the input file before
Vlterm has translated the fields.

50 Vlterm Programmer’s Reference
MathOnVars()
Msg
MathOnVars({VARn|CUTn}~{VARn|CUTn}~{+ | - | * | / | \ }~{x|VARn|CUTn})
MathOnVars() provides the ability to do arithmetic on either a VARn or CUTn
script variable. The first argument receives the result of the mathematical
operation that uses argument two, an operator, and argument three. The variable x
in argument 3 can be a literal number. Separate all arguments with the tilde (~)
symbol.
Example
MathOnVars(VAR1~CUT2~+~3.1)
Performs the following operation:
VAR1 = C(2) + 3.1
Msg={string|CUTn|VARn}
The Msg option sends a specified message string to the agent using a message box.
After the message appears, the agent must click OK to continue. For strings,
quotation marks are optional. If you enclose a string in quotation marks, the
quotation marks appear in the message box. If the Msg value is a cut variable, you
must use the CUTn syntax. C(n) is not a valid value for the Msg command.
Example
PASTE_CMD1=Msg=This is the message
PASTE_CMD2=Msg=CUT1
Non-Reserved Word
You can specify a non-reserved word in a paste command, which causes Vlterm
to send characters as keystrokes directly to the emulator. This can include ordinary
alphanumeric characters or special characters used for screen or cursor
manipulation commands. If the emulator doesn’t accept the format, a DDE error
message is displayed:
“Error Pasting to window-title. VB error code VB error message. CNPn CMDn.”
The agent must click OK. Vlterm ends the current CNP script.

OIA
Paste Commands 51
Enclose the text string in quotation marks to include space characters.
Example
PASTE_CMD1=“ The text is: ”
OIA,string,[n]
Argument Description
string Search string. Vlterm compares this string against the string the
emulator sends.
[n] OIA timeout, in seconds. This argument is optional. If you don’t
specify a value for n, Vlterm defaults to 10 seconds. Include the
brackets in the command.
The OIA option causes Vlterm to wait for keyboard unlock. This applies to 3270
emulations only (Wall Data Rumba and Attachmate Extra!).
Vlterm issues a request to the emulator for OIA status in a loop, which contains a
brief pause between each loop. If a clear indication is not received in that time,
Vlterm issues the following message: “OIA searching for an unlocked status
timed out.” The paste function is then exited.
Issue the OIA command after any command that sends data to the host rather than
just manipulating text or the cursor in the 3270 presentation space buffer.
Rumba and Extra! use the following commands.
Command Key Sequence
Clear @C
Enter @E
PF1-24 (program function) @0-@9, @a-@o
PA1-3 (program attention) @x-@z

52 Vlterm Programmer’s Reference
Other()
The following table contains commonly used commands that don't require OIA.
Command Key Sequence
Tab @T
Home @0
Backtab @B
Newline @N
Erase EOF (end of field) @F
NOTE Use the SendKeys function for commands not listed above or for use with
other emulators. See Appendix B, “Using the SendKeys Function,” beginning on
page 101 for more information.
The string that the OIA looks for is different for each emulator package. You must
identify the emulator string before setting up an OIA command. Vlterm interprets
the string using the Like command format. See “Using the Like Operator” on
page 105 for more information.
Extra! Example
PASTE_CMD2=OIA,*CLEAR*,[30]
Where CLEAR is the search string and the asterisks (*) are wild card characters.
The OIA timeout is set to 30 seconds.
Rumba 3270 and AS400 Example
PASTE_CMD2=OIA,*0*
The string that Rumba sends is *0*. The OIA timeout value defaults to 10 seconds.
Other(string)
Use the DDE Other section to paste the string contents to the defined
PASTE_SESSION.
Example
PASTE_CMD2=Other([EXIT()])
This sends an exit command to the external OLE interface program.

Pause()
Release
Relink
RightStr()
Paste Commands 53
Pause(n)
The Pause option is supported only in Wall Data Rumba. Set the value of n in 1/2
second intervals. The pause allows for host processing. The Pause option can be
useful if the host sends data while the 3270 keyboard is in an unlocked state.
Release=n or Release=VAL=x
If the format is RELEASE=n, Vlterm sends a Mosaix system release key as
specified in the vlkeys.ini file. n is the key number of the release sequence to send,
1-72.
If the format is RELEASE=VAL=x, Vlterm sends a release to the Mosaix system
using the value x. x may be one character preceded by and followed by
.
A y may be added after the x character to automatically respond to the question
“Are you sure?”
Example
PASTE_CMD2=RELEASE=VAL=Hy
Sends Hy to the Mosaix system session.
A relink may be necessary to re-establish a DDE connection to one of the
HTERMn sessions. For example, Rumba drops all DDE links if a host Telnet
session times out.
RightStr({C(n)|VARn}~x)
Returns x number of right-most characters from either a C(n) oraVARnscript variable.

54 Vlterm Programmer’s Reference
SendKeys
SetVarn
Parameters
SendKeys={string|C(n)|VARn|~NoFocusSet}
You can use this function as the primary way to send keystrokes or cut data into a
host session if it is not necessary or possible to communicate to a host emulator
DDE server. It is still necessary to use DDE to get information from a window or
to paste the output to a window. The PASTE_SESSION parameter in the CNPn
section determines where the output will be sent.
If the string ~NoFocusSet is included at the end of the SendKeys command line,
the string ~NoFocusSet will be taken out of the string and the focus will not be
changed or set after the command has been issued. This is important if your
command displays a new dialog box or form.
NOTE The new dialog box or form is not the initial form to which Vlterm
connected. Vlterm sets the focus to the original form or window unless you
include the ~NoFocusSet string.
Examples
PASTE_CMD1=SendKeys=C(1)
Send previously cut data placed in C(1) to the PASTE_SESSION host window.
PASTE_CMD1=SendKeys={ENTER}
Specify SendKeys={Enter} to wake up the Telnet session. The braces {} are
required. To define special keystrokes, see “Using the SendKeys Function” on
page 101.
SetVarn={C(n)|VARn|CUTn|string|UserID|Date()|InString()|MidString()}
Sets the script variable VARn to the contents of one of the listed parameters or
subroutines.
Define a SetVarn parameter using variables or a literal string.

Variable
Literal
Subroutines
UserID
Date()
PASTE_CMD1=SetVar1=C(1)
Sets VAR1 to the contents of C(1) or CUT_CMD1.
Paste Commands 55
If you enclose the literal string in quotation marks, the quotation marks aren’t
included in the script variable.
PASTE_CMD2=SETVAR2=hello there
Sets VAR2 to the string hello there.
PASTE_CMD3=SetVar2=“”
Sets VAR2 to an empty string.
The UserID, Date, InString, and Midstring subroutines are available only for use
with the SetVarn command.
The SetVarn UserID option for SetVar accesses the user’s Windows login ID.
Example
PASTE_CMD1=SetVar1=UserID
PASTE_CMD2=Msg=Var1
The series of paste commands displays the user’s login ID.
SetVarn=Date(n,format)
Use the SetVarn Date command option to include a date in a SetVarn routine.
Assign to a variable a string, which represents the local PC date and time. Format

56 Vlterm Programmer’s Reference
the string according to the existing Date() command capabilities (see “Date()” on
page 44 for more information about the Date() command).
Argument Description
n The number of days to add to the current date (0 for the
current date).
format The format Vlterm uses to display the date using the
FormatStr command options. See “Date and Time Formats” on
page 96 for more information.
Example
PASTE_CMD1=SetVar1=Date(1,yyyymmdd)
PASTE_CMD2=Msg=Var1
The series of paste commands adds one day to the current date. For example, if the
current date is October 27, 1999, the PASTE_CMD2 command adds 1 to the date
and displays the date as 19991028.
InString()
SetVARn=(Start_Position~Source_string~Sub_string)
SetVARn= InString(
{C(n)|string|VARn|CUTn}
~{C(n)|string|VARn|CUTn}
~{C(n)|string|VARn|CUTn})
Use the SetVarn InString() function to return the column position of a substring
within a row of string characters. The InString function uses the following
arguments.
Argument Description
Start_position The position of the search string to start searching for a
substring. Required entry.
Source_string The string to be searched
Sub_string The sub-string to find within the searched string
The result is to return the column that the search string was
found within the string being searched.

Example
SETVAR3=InString(1~CUT1~VAR2)
Paste Commands 57
The source string CUT1 is searched for the substring VAR2 starting at position 1.
The first column position where VAR2 is located within CUT1 is assigned to
VAR3.
Midstring()
Midstring(Source~Start~Length)
SetVARn=MidString(
{C(n)|string|VARn|CUTn}
~{C(n)|string|VARn|CUTn}
~{C(n)|string|VARn|CUTn})
Use the SetVarn Midstring() function to return a specified number of characters
from a string.
Argument Description
Source The string from which characters are extracted.
Start Character position in the Source string from which to begin
extracting.
Length The number of characters to return from the Source string
(optional parameter).
Example
SETVAR2=MidString(CUT1~VAR2~5)

58 Vlterm Programmer’s Reference
ShellApp()
ShellApp({string|VARn}~WinTitle)
Use the ShellApp() option to determine if an application with WinTitle is currently
running. If it is, the focus is set to that application. If the application is not
currently running, the string parameter is used to launch the application and set
focus to it.
Examples
ShellApp(Calc.exe~Calculator)
Launches the Windows calculator program.
CUT_CMD1=ClipCut(%ea%ec~(1,1,20))
PASTE_CMD1=SetVar1=Notepad.exe
PASTE_CMD2=StrCat(Var1~Cut1)
PASTE_CMD3=ShellApp(Var1~Win_Title Here)
CUT_CMD1 copies 20 characters beginning at row 1, column 1 of the
CUT_SESSION window. PASTE_CMD1 assigns the executable name
(notepad.exe) to VAR1. PASTE_CMD2 adds the string in CUT1 to VAR1. For
example, VAR1 contains “notepad.exe c:\temp\filename.txt.” PASTE_CMD3
launches Notepad using the CUT1 string as the argument.
Show_Fkeys
Argument Description
string Path and executable file name to be started
VARn String variable
WinTitle Window title of application (can include a wildcard, for
example Calc*). Use WinTitle to further qualify the file you
want to open. WinTitle is optional.
The Show_Fkeys option displays the toolbar. Use this command to make the
FKEYS toolbar visible for a host session.

Start_Auto_CNP
Start_Auto_CNP enables the automatic CNP timer.
Stop_Auto_CNP
StrCat()
Stop_Auto_CNP disables the automatic CNP timer.
StrCat(VARn~{CUTn|VARn|string})
Use StrCat() to concatenate a string to the end of VARn.
Example
StrCat(VAR1~CUT1)
Where VAR1 = VAR1 + (C(1) or CUT_CMD1).
TitleCaption
Paste Commands 59
TitleCaption={VARn|string|CUTn}
Use the TitleCaption paste command to change the Windows title of the Vlterm
button bar. Use quotation marks if you want them to appear in the title.
Examples
PASTE_CMD1=SetVar1=“New Title”
PASTE_CMD2=TitleCaption=VAR1
or
PASTE_CMD1=TitleCaption=“New Title”
or
PASTE_CMD1=TitleCaption=CUT1

60 Vlterm Programmer’s Reference
ToggleTo()
VARn
Wait()
ToggleTo(n)
The value of n is a session number from 0 to MAX_SESSIONS as defined in the
vlterm.ini file.
ToggleTo() sets the windows focus to the specified HTERMn session.
The VARn option pastes the value of VARn into the active screen. You must define
VARn in the [GLOBAL] section of vlterm.ini. You can set the value of VARn with
the Input paste command or the SetVar paste command.
Wait(n,string)
This command is supported in Wall Data Rumba and WRQ Reflections only. This
command tells the system to wait for a specific data string from the host, where n
is number of seconds to wait.
WaitForKey()
WaitForKey(iKeyCode~iFocusWin)
Argument Description
iKeyCode ASCII value
iFocusWin session 0 to MAX_SESSIONS
WaitForKey() pauses the CNP script until the key specified by iKeyCode is
pressed. After this key is pressed, focus is set to the session specified by
iFocusWin, and the CNP script execution continues.

Example
WinFocus()
WaitForKey(13~0)
Paste Commands 61
Sets the focus to session 0 when the return key (ASCII 13) is pressed.
WinFocus(HWINn~VARn)
This command tests whether the session specified has the current focus. If it does,
VARn is set to 1. If it doesn’t, VARn is set to 0.

62 Vlterm Programmer’s Reference

Automatic Cut and Paste 7
You can configure Vlterm to automatically copy information from the Mosaix
system session VT100 emulator to any host session every time a field on the
VT100 screen changes, such as when a new data record for a call appears.
The automatic cut and paste copies a designated string of text from the Mosaix
system emulator screen at specified intervals. If the copied string differs from the
last copy, Vlterm assumes that a new record has been sent to the Mosaix system
agent and carries out the automatic CNP commands. This typically consists of
pasting the cut information to the host session.
Set the number of cut commands, in the CNPn sectionofvlterm.ini,tozeroto
execute the automatic cut and paste regardless of screen changes. For example,
NUMBER_CUT_COMMANDS=0.
Because of the limitations of the character-based Mosaix system interface, the
examples in this chapter show additional configuration settings that control when
the automatic compare takes place.
The automatic compare is turned off after an agent logs off the job and after each
automatic compare. This prevents a copy and paste from occurring while on the
same record. This may occur if an agent views a different screen within the
Mosaix system emulator with a goto screen2, for example. The automatic
compare is turned on again once the agent selects record release.
For a similar reason, the automatic cut and paste is turned off until the agent logs
on and joins a job. You must configure a button to start the automatic cut and paste
for the first record.
63

64 Vlterm Programmer’s Reference
Sample Files
Vlterm.ini
The following sections contain sample vlterm.ini and vlkeys.ini files.
[GLOBAL]
NUMBER_CNPS=4
MAX_SESSIONS=1
AUTO_INTERVAL=3;attempt auto cut every 3 seconds
AUTO_ENABLED=N ;do not enable auto compare on Vlterm startup
[CNP1]
CUT_SESSION=0
PASTE_SESSION=1
CNP_TYPE=1;CNP type 1 = automatic
AUTO_CUT_COMPARE=1;1 = cut_cmd number to compare against
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=3
CUT_CMD1=(0,64,0,73);compare this cut against the old cut to
;determine whether a screen change has occurred
PASTE_CMD1=C(1);if cuts are different, execute paste steps
PASTE_CMD2=^M
PASTE_CMD3=STOP_AUTO_CNP;stop checking while on current call
[CNP2]
CUT_SESSION=0;Begin auto cut and paste (AUTO)
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=1
PASTE_CMD1=START_AUTO_CNP;used only at beginning of day or
;session

Vlkeys.ini
Automatic Cut and Paste 65
[CNP3]
CUT_SESSION=0;Log Off button click (LOGOFF)
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=2
PASTE_CMD1=RELEASE=VAL=A;send logoff release code to Mosaix
PASTE_CMD2=STOP_AUTO_CNP;stop the auto cut cycle after
;logging off
[CNP4]
CUT_SESSION=0;Release Record button click (DONE)
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=2
PASTE_CMD1=RELEASE=VAL=B;send release record code to Mosaix
PASTE_CMD2=START_AUTO_CNP;start auto cut cycle to watch for
;next record
key1=CNP2,0,AUTO,0,START AUTO CNP,1
key2=CNP3,0,LOGOUT,0,Request Logout
key3=CNP4,0,DONE,0,Release Record,4

66 Vlterm Programmer’s Reference

Creating a DDE.ini File 8
Vlterm reads from external DDE.ini configuration files to get information it needs
about specific emulator packages. DDE.ini files contain emulator-specific DDE
commands that the Vlterm script commands need.
By placing all the DDE commands into an external configuration file, the Vlterm
executable does not need to be modified to add DDE communications support for
previously unsupported emulation packages.
You can configure DDE.ini files. DDE.ini file content follows the standard
Windows configuration (*.ini) file format.
To communicate with Vlterm using DDE, an emulation package must meet the
following requirements:
• The emulation package must act as a DDE server.
• Documentation for the DDE server command structure describes the
emulation package’s functions in detail.
• The emulation package supports the functionality that the solution requires,
for example, cut and paste.
DDE.ini Files Introduction
Each script command in a vlterm.ini CNPn section that interacts with a host
system generally depends on a series of DDE commands. The Vlterm DDE client
must send these DDE commands in a particular order to the target emulation
package operating as a DDE server.
NOTE Not all DDE commands require arguments.
The external DDE.ini file structure allows for a variable number of lines (entries)
for each section as well as several commands and arguments in each line.
67

68 Vlterm Programmer’s Reference
There are currently 12 sections in the DDE.ini file. The OTHER section can be
used as a general purpose section for unanticipated situations.
The name of the DDE.ini file needs to be specified in the DDE_SESSION section
ofthevlterm.inifile(see“[DDE_SESSION]”onpage26).
Example
; DDE host configuration files, one file for each session
DDE_CONFIG_SESSION0=KEA_DDE.INI
DDE_CONFIG_SESSION1=RUM_DDE.INI
The first file for session 0, the Mosaix system session, has settings for
Attachmate’s KEA! vt100 emulator. The second file is for Wall Data’s Rumba
emulator going to session 1, a host session. You may have the same file in both
entries if you use the same type of emulator for both sessions, but you must have
a file name listed for each session used.
Each section within the DDE.ini file may have associated variables. The Vlterm
code parses these variables and replaces with variable values that are known
within the code. By using variables, Vlterm has access to dynamically changing
values, such as when a string has been cut from an emulator screen.
This chapter lists the variables in the sections to which they apply and the internal
variables that are assigned to them. These variable declarations are found within
the cnp.bas module in the DDE_MessageSend sub-routine.
DDE.ini File Variables
NumberOfLines=2
Line1=LinkItem copyblock(&CutVar1&)
Line2=LinkRequest
Parameter Description
NumberOfLines The number of lines in this sequence
Line1 The first line in the sequence of events for a cut command
LinkItem Tells Vlterm that a LinkItem DDE command will be used

Parameter Description
copyblock() A literal text sting sent to the DDE Server
& Field delimiter
Example of a Cut Command for Rumba
For a vlterm.ini [CNPn] section command configured as:
CUT_CMD1=(1,1,1,5)
And a RUM_DDE.ini file cut section defined as:
Creating a DDE.ini File 69
CutVar1 Internal variable, described later in this chapter as a cut command
[DDE_CUTS]
NumberOfLines=2
Line1=LinkItem copyblock(&CutVar1&)
Line2=LinkRequest
Vlterm makes the following variable assignment:
CutVar1 = (1,1,1,5)
After the RUM_DDE.ini [DDE_CUTS] section Line1 is parsed and the variable
substitutions are made, a DDE LinkItem request is sent to the DDE server of the
emulation package. The request contains the following data:
copyblock(1,1,1,5)
The LinkRequest DDE command for Line2 would then be sent without
parameters.
The result would be that the text on the screen for CUT_SESSION=0 in location
1,1,1,5 would be placed in the cut variable number 1, C(1), in the CNP section for
later processing.
The startup.bas module in the CONFIG_CNP subroutine reads the DDE.ini file
information into Vlterm and places it into structures for each session. The
DDE_MessageSend subroutine is then called and given the appropriate structure
for the task to be performed.

70 Vlterm Programmer’s Reference
DDE.ini File Sections
Not all functions or sections are available for all emulators. Rumba was used as
the first example of what commands to include. Although variables are generally
associated with a specific section in the DDE.ini file, they may be used in other
sections as needed. For example, the Chr1 and Chr13 variables represent the
ASCII characters 1 (^A) and 13 (^M) respectively.
[DDE_CUTS]
CutVar1 = the string contents of a cut command from the vlterm.ini file.
Example
If CUT_CMD1=(1,1,1,5) in the vlterm.ini file, then CutVar1 = “(1,1,1,5)”.
[DDE_PASTECUTS]
PasteVar1 = the string contents of a previously cut item to paste to a session
designated in the vlterm.ini file.
Example
If PASTE_CMD1=C(1) in the vlterm.ini file, the contents of C(1) are pasted to the
session.
[DDE_PVAR]
PvarVar1 = the string contents of an internal VARn variable designated in the
vlterm.ini file.
[DDE_OIAKBD]
Internal variables are not defined for this section.
[DDE_CURSOR]
CursorVar1 = the string contents of a CURSOR command designated in the
vlterm.ini file.

[DDE_WAITS]
Creating a DDE.ini File 71
WaitSVar1 = the string contents of the first parameter before the comma (,) in the
WAIT command designated in the vlterm.ini file.
WaitSVar2 = the string contents of the second parameter after the comma (,) in the
WAIT command designated in the vlterm.ini file.
[DDE_PAUSE]
PauseVar1 = the string contents of the PAUSE command designated in the
vlterm.ini file.
[DDE_FINDS]
FindVar1 = the string contents of the first parameter separated by a comma (,) in
the FINDS command designated in the vlterm.ini file.
FindVar2 = the string contents of the second parameter separated by a comma (,)
in the FINDS command designated in the vlterm.ini file.
FindVar3 = the string contents of the third parameter separated by a comma (,) in
the FINDS command designated in the vlterm.ini file.
[DDE_OTHER]
OtherVar1 = the string contents of the OTHER command designated in the
vlterm.ini file. This variable may not be needed for this section.
[DDE_SENDTHRU]
PassVar1 = the string contents of text on a line designated in the vlterm.ini file, not
associated with an internal function such as the PAUSE command.
Example
The PASTE_CMD1=X line in the vlterm.ini file sends the letter X to the session.

72 Vlterm Programmer’s Reference
[DDE_SENDFKEYS]
FKEYVar1 = the string contents of the first command designated in the vlkeys.ini
file.
NOTE If you need to include a “y” after this Mosaix system release code, use the
[DDE_SENDTHRU] command structure.
[DDE_SENDPFKEYS] keystroke
PFKEYVar1 = the string contents of the PFK command designated in the
vlkeys.ini file.
Additional Variables
Chr1 = Chr1 variable which holds the ASCII character 1, used in the
[DDE_SENDFKEYS] command structure or as needed.
Chr13 = Chr13 variable which holds the ASCII characters 13, used in the
[DDE_SENDFKEYS] command structure or as needed.
& = Acts as a field delimiter.
“Text” = Other text placed on the line is passed through as is, text and variables
must be separated by an ampersand (&) symbol.
DRV_DDE.ini File Example
Use the drv_dde.ini sample file as a template to create a new DDE configuration
file when you need Vlterm to communicate with an emulator that’s not included
in the “Emulator Specifics” appendix beginning on page 113. The following file
provides samples of the association between script commands and their
functionality.

Creating a DDE.ini File 73
;*****************************************************************
; DDE Host Configuration File
; for Generic DDE Driver
;
; DRV_DDE.INI file for Vlterm
;*****************************************************************
;This file contains parameters that control Vlterm DDE operation
;including the all the supported commands for DDE specifications
;for each emulator
;This file is called from the Vlterm.ini file
;The following sections handle particular Vlterm script
;commands. For a particular script command, there is a
;corresponding section which specifies the DDE commands
;which will be sent to the DDE server to which Vlterm is
;communicating.
;The pseudo-command lines within these sections are interpreted by
;Vlterm code and reconstructed into VB DDE commands.
;Note the variable such as &CutVar1& which gets replaced by a value
;defined in a Vlterm script command. For CutVar1, it would be
;replaced ;by the contents of C(1) in a Paste_Cmd1=C(1) Vlterm script
;command.
[DDE_CUTS]
;Handles the Cut_Cmd1=(row,col,len) script command
NumberOfLines=3
Line1=LinkExecute [CopyBlock(&CutVar1&)]
Line2=LinkItem txtDDE
Line3=LinkRequest
[DDE_PASTECUTS]
;Handles the Paste_Cmd1=C(1) script command
NumberOfLines=1
Line1=LinkExecute [SendKey(&PasteVar1&)]
[DDE_PVAR]
;Handles the Paste_Cmd1=VAR1 script command
NumberOfLines=1
Line1=LinkExecute [SendKey(&PvarVar1&)]
[DDE_OIAKBD]
;Handles the Paste_Cmd1=OIA script command
NumberOfLines=3
; The OIA word to search for is: *CLEAR*
Line1=LinkExecute [OIA()]

74 Vlterm Programmer’s Reference
Line2=LinkItem txtDDE
Line3=LinkRequest
[DDE_CURSOR]
;Handles the Paste_Cmd1=Cursor() script command
NumberOfLines=1
Line1=LinkExecute [Cursor(&CursorVar1&,&CursorVar2&)]
[DDE_WAITS]
;Handles the Paste_Cmd1=Wait() script command
NumberOfLines=1
Line1=LinkExecute [WaitFor(&WaitSVar1&,&WaitSVar2&)]
[DDE_PAUSE]
;Handles the Paste_Cmd1=C(1) script command
NumberOfLines=1
Line1=LinkExecute [Pause(&PauseVar1&)]
[DDE_FINDS]
;Handles the Paste_Cmd1=Find() script command
NumberOfLines=3
Line1=LinkExecute [Find(&FindVar1&,&FindVar2&,&FindVar3&)]
Line2=LinkItem txtDDE
Line3=LinkRequest
[DDE_OTHER]
;Handles the Paste_Cmd1=Other() script command
NumberOfLines=1
Line1=LinkExecute OtherVar1
[DDE_SENDTHRU]
;Handles the Paste_Cmd1=some_text script command
NumberOfLines=1
Line1=LinkExecute [SendKey(&PassVar1&)]
[DDE_SENDFKEYS]
;Handles the key1=W,0,label,~~7 vlkeys.ini command
;Handles the Paste_Cmd1=Release=x script command
;Handles the Paste_Cmd1=Release=VAL=x script command
NumberOfLines=1
Line1=LinkExecute [SendKey(&Chr1&FKEYVar1&Chr13&)]
[DDE_SENDPFKEYS]
NumberOfLines=0
; END OF DRV_DDE.INI

Configuring a Custom Form 9
You can create any number of formn.ini files that can be configured with any
number of objects. The following list identifies available object types:
• Button
• Label
• TextField
• MaskTextField
• ComboField
• ListField
• CheckBox
Loading a Form
You can call a form from either a button in the vlkeys.ini file or from a script in
the vlterm.ini file.
You can automatically fill a form with data gathered using a CNPn script. Text
fields, list boxes, and combo boxes can be filled with static text or information cut
from emulation screen objects based on vlterm.ini script commands specified for
each object.
All object types except Button can also interact with other script commands by
passing variables back to the vlterm.ini script. Label objects pass the value of the
Caption setting. The other objects pass the value of the Contents setting.
If a CNPn script calls the form, loading the form should be the last command in a
script sequence. The form can execute other CNPn script sequences when the
form closes. For example you can configure an OK button to execute a CNPn
script.
75

76 Vlterm Programmer’s Reference
An alternate method is to call a form that sets a variable associated with each form
object. These variables can be maintained globally for subsequent script command
reference.
vlkeys.ini Example
Call the form load command from the vlkeys.ini file:
key1=FRM1,0,Info frm,0~Show the Information form~1
The example in key1 looks for the file form1.ini in the same directory as the
Vlterm executable file. The relationship between the .ini file and the action
command is that the “1” in FRM1 corresponds to the “1” in form1.ini. Similarly,
FRM2 looks for the form2.ini file.
vlterm.ini Example
Call the form load from a vlterm.ini script using the FormLoad(n) command:
[CNP1]
CUT_SESSION=0
PASTE_SESSION=1
CNP_TYPE=2
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=1
CUT_CMD1=(1,64,1,73)
;Load the FORM1.INI file
PASTE_CMD1=FormLoad(1)
The example in CNP1 looks for the file form1.ini in the same directory as the
vlterm executable file. The relationship is the “1” in FormLoad(1) corresponds to
the “1” in form1.ini. Similarly, FormLoad(2) looks for the form2.ini file.
For more information about the FormLoad() command, see “FormLoad()” on
page 47.
Formn.ini File Setup
This section identifies the sections of a formn.ini file and the configuration
settings for each section.

[GLOBAL]
Configuring a Custom Form 77
ControlFocus
ControlFocus=(n)
ControlFocus specifies the object in the form that has initial focus when the form
is opened. If the number defined is for a text object, the cursor flashes in that
object.
The value of n ranges from 1 to the number of objects.
NumObjects
NumObjects=(n)
NumObjects identifies the total number of objects that you setup in the form. This
number corresponds to the number of objects added in the Formn.ini file.
The value of n can be greater than or equal to 1. There is no default setting.
NumObjects is a required entry.
Position
Position=(left, top, width, height)
Position determines the position and size of the form. These values are
automatically changed if the variable UserSetSize is set to Y.
Left, top, width, and height must be integer values. The default Position setting is
(0,0,200,50).
UserSetSize
UserSetSize=[{Y|True}|{N|False}]
You can let users change the size of the form by setting UserSetSize to Y or True.
When set to Y or True, Vlterm saves the new window size setting. If you set the
variable to N or False, users can modify the window size, but Vlterm does not save
the user-defined setting.
Acceptable values for UserSetSize are Y, N, True, or False. The default setting is
N.

78 Vlterm Programmer’s Reference
WindowStyle
WindowStyle=[0|1]
You can set the style for an open window. The choices are 1 (Modal), indicating
that the user must respond before continuing, or 0 (Modeless), indicating that the
user may use other windows while leaving this window open.
Values for WindowStyle are 0 or 1. The default value is 1, Modal.
CAUTION Try to provide a mechanism or procedure for the window to close
after use. If too many windows are open, Windows will run out of system
resources, slowing or halting your computer.
UnloadOtherForms
UnloadOtherForms=All
If one or more forms are open, UnloadOtherForms unloads the forms. More than
one form can be open at a time if the WindowStyle is set to 0.
WindowTitle
WindowTitle=string
WindowTitle sets the string of text that appears in the window title bar.
The default value is a blank string (“”).
MinButton
MinButton=[Y|N]
MinButton determines whether a Minimize Window option appears on the form
menu bar.
MaxButton
MaxButton=[Y|N]
MaxButton determines whether a Maximize Window option appears on the form
menu bar.

[Objectn]
Action
Configuring a Custom Form 79
Action=CNPn
When you define an action for a button object, you identify a specific CNPn to
run. When an agent chooses the button, Vlterm performs all the cut and paste
actions defined for the CNPn in the vlterm.ini file, then returns control to the form.
The default value for Action is a blank string (“”), which means no action is taken.
Apply the Action setting to Button objects.
Cancel
Cancel=[{Y|True}|{N|False}]
Cancel sets the first command performed by the Button object to close the form
that has been loaded without performing any Actions or Required checks.
Acceptable values of Cancel are Y, N, True, or False. The default setting is N.
Apply the Cancel setting to Button objects.
Caption
Caption=string
Caption sets the text label for the specified object.
Label objects can return the caption value as a VARn to the Vlterm script that calls
the form. To pass the Caption value back to the script, define the object using the
Object setting, then reference the object as a variable using the Parameters setting
of a button object. See “Object” and “Parameters” on page 82 for more
information.
The default value for Caption is a blank string (“”).
Apply the Caption setting to Button, CheckBox, and Label objects.

80 Vlterm Programmer’s Reference
CloseForm
CloseForm=[{Y|True}|{N|False}]
CloseForm sets the last command performed by the Button object to close the
form that has been loaded after performing all Contents items.
Acceptable values of CloseForm are Y, N, True, or False. The default setting is N.
Apply the CloseForm setting to Button objects.
Contents
Contents=[string, CNPn,C(n), ~ as the separator]
Contents sets the initial value of the form object. For example, for a TextField
object, the Contents value appears in the text field on the form. If you use a C(n)
variable, the command places the contents of the last cut (stored in C(n)) into the
text of the object. All cut and paste actions are performed within the CNPn and
any other actions described. It’s a good idea to define a CNPn with only cut
commands.
Contents can appear on more than one line, each one being appended to the last.
See “UseContentsData” on page 85 for more information.
The default value for Contents is a blank string (“”).
Apply the Contents setting to TextField, MaskTextField, and ComboField objects.
FontBold
FontBold=[True|False]
FontBold sets the font to Bold (True) or Regular (False) for this object.
The default value for FontBold is False.
The FontBold setting applies to all objects.
FontSize
FontSize=n
FontSize sets the font size for this object.
The value of n can be an integer or decimal number. The default value is 8.25.
The FontSize setting applies to all objects.

Configuring a Custom Form 81
ForeColor
ForeColor=n
ForeColor sets the text color for each of the objects used. Color values range from
0 to 15. See “Color” on page 13 for a table that correlates a number to a color.
Valid settings for ForeColor are 0-15. The default is 0, which is black.
The ForeColor setting applies to all objects except command buttons.
Height
Height=n
Height specifies the height of the object. For Label, it is the maximum height of
text that will show without being clipped off. Some objects have a minimum
height. This is set by default.
The value of n must be an integer. The default value is 10 or the objects minimum
height.
Assign a Height setting for the following object types: Button, Label, TextField,
MaskTextField, ListField, and CheckBox.
Left
Mask
Left=n
Left specifies the left position of the object relative to the form.
The value of n must be an integer. The default value is 0.
Left applies to all objects.
Mask=mask string
Use the Mask setting a mask for data input into a MaskTextField. If you define a
Mask, do not define the Contents setting with a CNPn and C(n).
The default setting is a blank string (“”).
The Mask setting applies to the MaskTextField object type.

82 Vlterm Programmer’s Reference
MultiDelimiter
MultiDelimiter=string
MultiDelimiter defines the delimiter used between items if multiple items are
selected. Vlterm inserts the MultiDelimiter string before each selected item, even
if only one item is selected. If MultiDelimiter is left blank, Vlterm uses no
characters between items within the object passed to the VARn. If you want to use
a space as a delimiter, define MultiDelimiter=“ ” (quotation marks “ ” with a space
between them).
The default value for MultiDelimiter is a blank string (“”).
The MultiDelimiter setting applies to the ListField object type.
Object
Object=string
Object assigns a name to the contents of this object. With this object name, you
can transfer the contents of this object to a vlterm script during a Button Action.
Place the Object value in the Parameter setting for the Button. See “Action” on
page 79 and “Parameters” on page 82 for more information.
The default value for Object is a blank string (“”).
The Object setting applies to the Label, TextField, MaskTextField, ComboField,
ListField, and CheckBox object types.
Parameters
Parameters=Objectn
Use the Parameters option to define the data (typically the Contents value for an
object) that the form passes to the Vlterm script using variables (VARn). In the
Parameters option, list the objects that you want placed in variables. To access the
objects in a script, use a VARn in a PASTE_CMD command. If you don’t use a
VARn in PASTE_CMD, Vlterm loads the object into a variable but never
references it, then replaces the VARn value the next time the form object is used.
The Action setting identifies the CNPn script that uses the variables identified in
Parameters. See “Action” on page 79 for more information.
The sequence of objects in the Parameters list determines the VARn to which
they’re assigned. For example, the first object in the Parameters list corresponds
to VAR1; the second object in the parameters list corresponds to VAR2.

Configuring a Custom Form 83
For each object that you include in the Parameters list, define the Object setting in
the corresponding Objectn section. Typically, you’ll use the Object section name
as the Object setting. For example, to include the value of Object7 in the
parameters list, set Object=Object7 in the [Object7] section. See the previous
section, “Object,” for more information.
In the Parameters value, use a tilde (~) to separate the object names to define more
than one object. For example:
Parameters=Object4~Object6~Object7~Object8
The default value for Parameters is a blank string (“”). Parameters is a required
entry.
The Parameters setting applies to the Button and CheckBox object types.
Password
Password=[{Y|True}|{N|False}]
The Password option, when the value is Y or true, sets a TextField object to
display asterisks (*) as text is entered. Use this setting for a password or ID in
login forms.
Acceptable values of Password are Y, N, True, or False. The default setting is Y.
Apply the Password setting to TextField objects.
PasteIndex
PasteIndex=n
The value of n can be 1 to the total number of objects for the form.
Required
Required=[{Y|True}|{N|False}]
Required sets the TextField object to Required before exiting the form.
Acceptable values of Required are Y, N, True, or False. The default setting is Y.
Apply the Required setting to TextField objects.

84 Vlterm Programmer’s Reference
SQLContents
SQLContents=[db name with path~db type~select statement]
The contents are placed in the ListField or ComboField objects as selectable
items. Each item of each field that is returned is parsed and placed in the list on its
own line unless you use UseContentsData. (See “UseContentsData” on page 85
for more information.)
Example
SQLContents=H:\CUSTOMER\DB~FoxPro 2.0;~select Value, code as
ID from config
The default value for SQLContents is empty.
Use SQLContents with ListField and ComboField object types.
TabIndex
TabIndex=n
TabIndex determines the order in which a Tab keystroke sets the focus to this
object in relation to other objects with a TabIndex value.
Set the value of n from 1 to the total number of objects on the form.
TabIndex applies to all object types.
Top
Type
Top=n
The Top position of the object relative to the form.
The value of n is an integer. The default value is 0.
Top applies to all object types.
Type=[Button|Label|TextField|MaskTextField|ComboField|ListField|CheckBox]
Type identifies the type of object being configured. Each object type has
configurations settings that are common with all other object types and
configuration settings that are specific to that object. For ComboField, a single
line with a pull-down ListField, all options are viewable unless the object height
is insufficient, then a scroll bar appears.

Type does not have a default value. Type is a required setting.
The Type option applies to all object types.
Configuring a Custom Form 85
UseContentsData
UseContentsData=[{Y|True}|{N|False}]
If you set UseContentsData to Y, the incoming Contents data is paired. The first is
the display string; the second is the data string. For example, if Contents is
“ID~1234~Name~Wally Smith,” the ListField or ComboField would display ID
and Name, and the data associated with them would be 1234 and Wally Smith. See
“Contents” on page 80 for more information.
Acceptable values of UseContentsData are Y, N, True, or False. The default
setting is N.
Apply the UseContentsData setting to ListField and ComboField objects.
Value
Width
Value={0|1|2}
The Value setting determines the initial state of a CheckBox object.
Setting Initial CheckBox Value
0 Cleared (not selected)
1 Selected (checked)
2 Gray (CheckBox doesn’t accept input)
The final CheckBox setting is passed back through the object property to the script
section that called the form.
Width=n
Width sets the width of the object being loaded. For Label, it is the maximum
width of text that can appear before being truncated.
Set the value of n to an integer. The default value is 10 or the object’s minimum
width.
Apply the Width setting to all object types.

86 Vlterm Programmer’s Reference
Sample Form1.ini File
[GLOBAL]
WindowTitle=Customer Information
WindowStyle=1
NumObjects=8
UserSetSize=N
Position=0,7045,11985,1615
ControlFocus=
UnloadOtherForms=All
MinButton=N
MaxButton=N
;This object is a button which has the text OK in it. When it
is pressed, CNP24 is executed, and the form closes. It will
pass four parameters to CNP24. The Object4 parameter refers
to the contents of Object four on this form. It is passed to
the CNP24 script as VAR1. Additional parameters would be VAR2,
etc.
[Object1]
Type=Button
Caption=OK
Action=CNP24
Parameters=Object4~Object6~Object7~Object8
Cancel=N
CloseForm=Y
Left=700
Top=5
Width=
Height=
FontBold=Y
FontSize=8.25
[Object2]
Type=Button

Caption=Cancel
Action=
Parameters=
Cancel=Y
CloseForm=Y
Left=700
Top=30
Width=
Height=
FontBold=Y
FontSize=8.25
[Object3]
Type=Label
Caption=Account Num:
Left=10
Top=5
Width=100
Height=20
FontBold=True
FontSize=8.25
ForeColor=0
[Object4]
Type=TextField
Object=Object4
Password=
Contents=CNP27~C(1)
Required=
Left=100
Top=5
Width=350
Height=
Configuring a Custom Form 87

88 Vlterm Programmer’s Reference
[Object5]
Type=Label
Caption=Date:
Left=10
Top=25
Width=100
Height=20
FontBold=True
FontSize=
ForeColor=12
[Object6]
Type=MaskTextField
Object=Object6
Contents=
Required=Y
Mask=##/##/##
Left=100
Top=25
Width=350
Height=10
FontBold=True
FontSize=
ForeColor=0
[Object7]
Type=ListField
Object=Object7
Contents=Home~Work~Cellular
Contents=Fax~Pager
Left=460
Top=5
Width=200
Height=50

FontBold=True
FontSize=8.25
ForeColor=0
MultiDelimiter=,
[Object8]
Type=ComboField
Object=Object8
UseContentsData=Y
Contents=Red~1
Contents=Yellow~2
Contents=Green~3
Contents=Blue~4
Left=460
Top=50
Width=200
FontBold=True
FontSize=12
ForeColor=12
Configuring a Custom Form 89

90 Vlterm Programmer’s Reference

Using the Format Function A
The Format command displays a number, date, time, or string according to
instructions contained in the format expression. The FORMAT command syntax
is:
FORMAT(fmt)
The format expression (fmt) can be a commonly used format name or a string of
display-format characters that specify how Vlterm displays the data. You can’t use
different format expression types (numeric, date/time, or string) in a single (fmt)
argument.
The content in this appendix was adapted from the Microsoft Visual Basic Online
Help.
Numeric Formats
To format numbers, you can use predefined formats or you can create user-defined
formats with standard characters that have special meaning in a format expression.
91

92 Vlterm Programmer’s Reference
Predefined Numeric Formats
The following table shows the predefined numeric format names you can use.
Format name Description
General Number Displays the number as is, without thousand separators.
Currency Displays the number with a thousand separator. If appropriate,
displays negative numbers enclosed in parentheses; displays two
digits to the right of the decimal separator.
Fixed Displays at least one digit to the left and two digits to the right of
the decimal separator.
Standard Displays the number with a thousand separator and, if appropriate,
displays two digits to the right of the decimal separator.
Percent Displays the number multiplied by 100 with a percent sign (%)
appended to the right; displays two digits to the right of the decimal
separator.
Scientific Uses standard scientific notation.
Yes/No Displays No if number is 0, otherwise displays Yes.
True/False Displays False if number is 0, otherwise displays True.
On/Off Displays Off if number is 0, otherwise displays On.

User-Defined Numeric Formats
Using the Format Function 93
The following table lists the characters you can use to create user-defined number
formats.
Character Meaning
Null string Display the number with no formatting.
0 Digit placeholder. Display a digit or a zero. If there is a digit in the
expression in the position where the 0 appears in the format string,
display it; otherwise, display a zero in that position. If the number
being formatted has fewer digits than there are zeros (on either side
of the decimal) in the format expression, display leading or trailing
zeros. If the number has more digits to the right of the decimal
separator than there are zeros to the right of the decimal separator
in the format expression, round the number to as many decimal
places as there are zeros. If the number has more digits to the left of
the decimal separator than there are zeros to the left of the decimal
separator in the format expression, displays the extra digits without
modification.
# Digit placeholder. Display a digit or a blank space. If there is a digit
in the expression where the # appears in the format string, display
it; otherwise, display nothing in that position. This symbol works
like the 0 digit placeholder, except that leading and trailing zeros
aren’t displayed if the number has the same or fewer digits than
there are # characters on either side of the decimal separator in the
format expression.
. (period) Decimal placeholder. The decimal placeholder determines how
many digits are displayed to the left and right of the decimal
separator. If the format expression contains only number signs to
the left of this symbol, numbers smaller than 1 begin with a
decimal separator. If you want a leading zero to always appear with
fractional numbers, use 0 as the first digit placeholder to the left of
the decimal separator. The actual character used as a decimal
placeholder in the formatted output depends on the specified
Number Format in the International section of the Microsoft
Windows Control Panel. Some countries use a comma as the
decimal separator.
% Percentage placeholder. The expression is multiplied by 100. The
percent character (%) is inserted in the position where it appears in
the format string.

94 Vlterm Programmer’s Reference
Character Meaning
, (comma) Thousand separator. The thousand separator separates thousands
from hundreds within a number that has four or more places to the
left of the decimal separator. Standard use of the thousand separator
is specified if the format contains a comma surrounded by digit
placeholders (0 or #). Two adjacent commas or a comma
immediately to the left of the decimal separator (whether or not a
decimal is specified) means to scale the number by dividing it by
1000, rounding as needed. You can scale large numbers using this
technique. For example, you can use the format string “##0,,” to
represent 100 million as 100. Numbers smaller than 1 million are
displayed as 0. Two adjacent commas in any position other than
immediately to the left of the decimal separator are treated simply
as a thousand separator. The actual character used as the thousand
separator in the formatted output depends on the specified Number
Format in the International section of the Control Panel. Some
countries use a period as the thousand separator.
E- E+ e- e+ Scientific format. If the format expression contains at least one digit
placeholder (0 or #) to the right of E-, E+, e-, or e+, the number is
displayed in scientific format and E or e is inserted between the
number and its exponent. The number of digit placeholders to the
right determines the number of digits in the exponent. Use E- or eto
place a minus sign next to negative exponents. Use E+ or e+ to
place a minus sign next to negative exponents and a plus sign next
to positive exponents.
: (colon) Time separator. The time separator separates hours, minutes, and
seconds when time values are formatted. The actual character used
as the time separator depends on the specified Time Format in the
International section of the Control Panel.

Character Meaning
Using the Format Function 95
/ Date separator. The date separator separates the day, month, and
year when date values are formatted. The actual character used as
the date separator in the formatted output depends on the specified
Date Format in the International section of the Control Panel.
- + $ ( ) space Display a literal character. To display a character other than one of
those listed, precede it with a backslash (\) or enclose it in quotation
marks (“”).
\ Display the next character in the format string. Many characters in
the format expression have a special meaning and can’t be
displayed as literal characters unless they are preceded by a
backslash. Vlterm doesn’t display the backslash itself. Using a
backslash is the same as enclosing the next character in quotation
marks (“”). To display a backslash, use two backslashes (\\).
Examples of characters that can’t be displayed as literal characters
unless they are preceded by a backslash are the date- and timeformatting
characters (a, c, d, h, m, n, p, q, s, t, w, y, and /:), the
numeric-formatting characters (#, 0, %, E, e, comma, and period),
and the string-formatting characters (@, &,, and !). “ABC”
displays the string inside the quotation marks.
Unless the (fmt) argument contains a predefined format, a format expression for
numbers can have from one to four sections separated by semicolons.
If you use The result is
One section only The format expression applies to all values.
Two sections The first section applies to positive values and zeros, the second to
negative values.
Three sections The first section applies to positive values, the second to negative
values, and the third to zeros.
Four sections The first section applies to positive values, the second to negative
values, the third to zeros, and the fourth to null values.
The following example has two sections: the first defines the format for positive
values and zeros; the second section defines the format for negative values.
“$#,##0;($#,##0)”

96 Vlterm Programmer’s Reference
If you include semicolons with nothing between them, the missing section is
displayed using the format of the positive value. For example, the following
format displays positive and negative values using the format in the first section
and displays “Zero” if the value is zero.
“$#,##0;;\Z\e\r\o”
Some sample format expressions for numbers are shown in the following table.
(These examples all assume that the Country setting in the International section of
the Control Panel is United States.) The first column contains the format strings.
The other columns contain the output that results if the formatted data has the
value given in the column headings.
Format (fmt) Positive 5 Negative 5 Decimal .5 Null
Null string 5 -5 0.5
0 5 -5 1
0.00 5.00 -5.00 0.50
#,##0 5 -5 1
#,##0.00;;;Nil 5.00 -5.00 0.50 Nil
$#,##0;($#,##0) $5 ($5) $1
$#,##0.00;($#,##0.00) $5.00 ($5.00) $0.50
0% 500% -500% 50%
0.00% 500.00% -500.00% 50.00%
0.00E+00 5.00E+00 -5.00E+00 5.00E-01
0.00E-00 5.00E00 -5.00E00 5.00E-01
Date and Time Formats
Numbers can also be used to represent date and time information. You can format
date and time serial numbers using date and time formats or number formats
because date and time serial numbers are stored as floating-point values. To
format dates and times, use either the commonly used formats or create userdefined
time formats using standard characters that have special meaning in a
format expression.

Predefined Date and Time Formats
The following table lists the predefined data format names.
Format Name Description
User-Defined Date and Time Formats
Using the Format Function 97
General Date Display a date or time or both. For real numbers, display a date and
time; for example, 4/3/93 05:34 PM. If there is no fractional part,
display only a date; for example 4/3/93. If there is no integer part,
display time only; for example, 05:34 PM.
Long Date Display a Long Date, as defined in the International section of the
Control Panel.
Medium Date Display a date in the same form as the Short Date, as defined in the
International section of the Control Panel, except spell out the
month abbreviation.
Short Date Display a Short Date, as defined in the International section of the
Control Panel.
Long Time Display a Long Time, as defined in the International section of the
Control Panel. Long Time includes hours, minutes, and seconds.
Medium Time Display time in 12-hour format using hours and minutes and the
AM/PM designator.
Short Time Display a time using the 24-hour format, for example 17:45.
The following table lists the characters you can use to create user-defined date and
time formats.
Character Meaning
c Display the date as ddddd and display the time as ttttt, in that order.
Only date information is displayed if there is no fractional part to
the date serial number; only time information is displayed if there is
no integer portion.
d Display the day as a number without a leading zero (1-31).
dd Display the day as a number with a leading zero (01-31).
ddd Display the day as an abbreviation (Sun-Sat).
dddd Display the day as a full name (Sunday-Saturday).

98 Vlterm Programmer’s Reference
Character Meaning
ddddd Display a date serial number as a complete date (including day,
month, and year) formatted according to the Short Date setting in
the International section of the Windows Control Panel. The default
ShortDateformatism/d/yy.
dddddd Display a date serial number as a complete date (including day,
month, and year) formatted according to the Long Date setting in
the International section of the Control Panel. The default Long
Date format is mmmm dd, yyyy.
w Display the day of the week as a number (1 for Sunday through 7
for Saturday.)
ww Display the week of the year as a number (1-52).
m Display the month as a number without a leading zero (1-12). If m
immediately follows h or hh, the minute rather than the month is
displayed.
mm Display the month as a number with a leading zero (01-12). If m
immediately follows h or hh, the minute rather than the month is
displayed.
mmm Display the month as an abbreviation (Jan-Dec).
mmmm Display the month as a full month name (January-December).
q Display the quarter of the year as a number (1-4).
y Display the day of the year as a number (1-366).
yy Display the year as a two-digit number (00-99).
yyyy Display the year as a four-digit number (100-9999).
h Display the hour as a number without leading zeros (0-23).
hh Display the hour as a number with leading zeros (00-23).
n Display the minute as a number without leading zeros (0-59).
nn Display the minute as a number with leading zeros (00-59).
s Display the second as a number without leading zeros (0-59).
ss Display the second as a number with leading zeros (00-59).

Character Meaning
Using the Format Function 99
t t t t t Display a time serial number as a complete time (including hour,
minute, and second) formatted using the time separator defined by
the time Format in the International section of the Control Panel. A
leading zero is displayed if the Leading Zero option is selected and
the time is before 10:00 A.M. or P.M. The default time format is
h:mm:ss.
AM/PM Use the 12-hour clock and display an uppercase AM with any hour
before noon; display an uppercase PM with any hour between noon
and 11:59 PM.
am/pm Use the 12-hour clock and display a lowercase am with any hour
before noon; display a lowercase pm with any hour between noon
and 11:59 PM.
A/P Use the 12-hour clock and display an uppercase A with any hour
before noon; display an uppercase P with any hour between noon
and 11:59 PM.
a/p Use the 12-hour clock and display a lowercase a with any hour
before noon; display a lowercase p with any hour between noon
and 11:59 PM.
AMPM Use the 12-hour clock and display the contents of the 1159 string
(s1159) in the win.ini file with any hour before noon; display the
contents of the 2359 string (s2359) with any hour between noon
and 11:59 PM. AMPM can be either uppercase or lowercase, but
the case of the string displayed matches the string as it exists in the
win.ini file. The default format is AM/PM.
The following are examples of user-defined date and time formats.
Format Display
m/d/yy 12/7/58
d-mmmm-yy 7-December-58
d-mmmm 7-December
mmmm-yy December 58
hh:mm AM/PM 08:50 PM
h:mm:ss a/p 8:50:35 p

100 Vlterm Programmer’s Reference
Format Display
h:mm 20:50
h:mm:ss 20:50:35
m/d/yy h:mm 12/7/58 20:50
String Formats
Strings can also be formatted with Format[$]. A format expression for strings can
have one section or two sections separated by a semicolon.
If you use The result is
One section only The format applies to all string data.
Two sections The first section applies to string data, the second to Null values
and zero-length strings.
You can use any of the following characters to create a format expression for
strings.
Character Meaning
@ Character placeholder. Display a character or a space. If there is a
character in the string being formatted in the position where the @
appears in the format string, display it; otherwise, display a space in that
position. Placeholders are filled from right to left unless there is an !
character in the format string.
& Character placeholder. Display a character or nothing. If there is a
character in the string being formatted in the position where the &
appears, display it; otherwise, display nothing. Placeholders are filled
from right to left unless there is an ! character in the format string.
< Force lowercase. All characters are displayed in lowercase format.
> Force uppercase. All characters are displayed in uppercase format.
! Force placeholders to fill from left to right instead of right to left.

Using the SendKeys Function B
The Vlterm SendKeys function is an adaptation of the SendKeys methodology.
Vlterm SendKeys sends a single keystroke or multiple keystrokes to the active
window as if they had been entered at the keyboard.
Vlterm can send keystrokes to any Windows application as long as the receiving
window is en emulation window to which Vlterm links during startup. The
emulator must accept keystrokes from a source other than the keyboard. Use the
SendKeys method to send information during cut and paste to a window that does
not support DDE server.
You can use the following Vlterm script commands with the SendKeys
methodology:
Cut Commands
• ClipCut
Paste Commands
• SendKeys
• ClipGet
• ClipSet
• ClipCopyBlock
The content in this appendix was adapted from the Microsoft Visual Basic Online
Help.
101

102 Vlterm Programmer’s Reference
Sample Configuration
The following sample shows a vlterm.ini file set up to use SendKeys.
[SHELL]
HTERM0=C:\win95\telnet.exe zurabi
S_DELAY0=3
HTERM1=notepad.exe c:\win95\config.txt
S_DELAY1=3
[WIN_TITLE]
HWIN0=Telnet - zurabi
HWIN1=config.txt - Notepad
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=
HOST_TOPIC0=
HOST_ITEM0=
USE_DDE0=N
DDE_CONFIG_SESSION0=
DDE_DELAY1=3
HOST_SERVER1=
HOST_TOPIC1=
HOST_ITEM1=
USE_DDE1=N
DDE_CONFIG_SESSION1=
[CNP1]
CNP_NAME=
CUT_SESSION=0
PASTE_SESSION=1

Usage
CNP_TYPE=2
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=1
CUT_CMD1=ClipCut(%ea%ec~(19,9,10))
PASTE_CMD1=SendKeys=C(1)
Using the SendKeys Function 103
Each key on a keyboard is represented by one or more characters. To specify a
single keyboard character, use the character itself. For example, to represent the
letter A, use “A” for keytext (the string you use with the SendKeys command). If
you want to represent more than one character, append each additional character
to the one preceding it. To represent the letters A, B, and C, use “ABC” for
keytext.
The plus sign (+), caret (^), percent sign (%), tilde (~), and parentheses ( ) have
special meanings to SendKeys. To specify one of these characters, enclose it in
braces. For example, to specify the plus sign, use {+}. Brackets ([ ]) have no
special meaning to SendKeys, but you must enclose them in braces because, in
other applications, brackets do have special meaning that may be significant when
dynamic data exchange (DDE) occurs. To send brace characters, use {{} and {}}.
To specify characters that your system doesn’t display when you press a key (such
as Enter or Tab) and keys that represent actions rather than characters, use the
codes shown in the following table.
Key Code Key Code
Backspace {BACKSPACE} or {BS}
or {BKSP}
Break {BREAK}
Caps Lock {CAPSLOCK} Clear {CLEAR}
Del {DELETE} or {DEL} Down Arrow {DOWN}
End {END} Enter {ENTER} or ~
Esc {ESCAPE} or {ESC} Help {HELP}
Home {HOME} Ins {INSERT}
Left Arrow {LEFT} Num Lock {NUMLOCK}
Page Down {PGDN} Page Up {PGUP}

104 Vlterm Programmer’s Reference
Key Code Key Code
Print Screen {PRTSC} Right Arrow {Right}
Scroll Lock {SCROLLLOCK} Tab {TAB}
Up Arrow {UP} F1 {F1}
F2 {F2} F3 {F3}
F4 {F4} F5 {F5}
F6 {F6} F7 {F7}
F8 {F8} F9 {F9}
F10 {F10} F11 {F11}
F12 {F12} F13 {F13}
F14 {F14} F15 {F15}
F16 {F16}
To specify keys used with any combination of the Shift, Ctrl, and Alt keys, precede
the regular key code with one or more of the following codes.
Key Code
Shift +
Control ^
Alt %
To specify that Shift, Ctrl, or Alt should be held down while other keys are
pressed, enclose the key codes in parentheses. For example, to have the Shift key
held down while E and C are pressed, use “+(EC).” To have Shift held down while
E is pressed, followed by C being pressed without Shift, use “+EC.” To specify
repeating keys, use the format {key number}; you must put a space between key
and number. For example, {LEFT 42} represents pressing the Left Arrow key 42
times; {h 10} represents pressing h ten times.
NOTE SendKeys can’t send keystrokes to an application that is not designed to
run in Microsoft Windows. Sendkeys also can’t send the Print Screen (PRTSC)
key to any application.

Using the Like Operator C
Use the Like operator to compare two string expressions. The syntax for the Like
operator is:
result=expression Like pattern
If the expression matches the pattern, then the result is True; if there is no match,
the result is False. If either the expression or the pattern is a Null, the result is also
aNull.
The case sensitivity and character sort order of the Like operator depend on the
Option Compare statement. Unless otherwise specified, the default string
comparison method for each module is Option Compare Binary; that is, string
comparisons are case sensitive.
Built-in pattern matching provides a versatile tool for string comparisons. The
pattern-matching features allow you to use wildcard characters, such as those
recognized by the operating system, to match strings. The wildcard characters and
what they match are shown in the following table.
Wildcard Character Matches in expression
? Any single character
* Zero or more characters
# Any single digit (0–9)
[charlist] Any single character in charlist
[!charlist] Any single character not in charlist
You can group one or more characters (charlist) enclosed in brackets ([ ]) to match
any single character in the expression. Charlist can include almost any characters
in the ANSI character set, including digits. The special characters left bracket ([ ),
question mark (?), number sign (#), and asterisk (*) can be used to match
105

106 Vlterm Programmer’s Reference
themselves directly only by enclosing them in brackets. The right bracket ( ])
cannot be used within a group to match itself, but it can be used outside a group
as an individual character.
In addition to a simple list of characters enclosed in brackets, charlist can specify
a range of characters. Use a hyphen (-) to separate the upper and lower bounds of
the range. For example, [A-Z] in pattern results in a match if the corresponding
character position in an expression contains any of the uppercase letters in the
range A through Z. Multiple ranges are included within the brackets without any
delimiter. For example, [a-zA-Z0-9] matches any alphanumeric character.
The following list contains other important rules for pattern matching:
• An exclamation point (!) at the beginning of charlist means that a match is
made if any character except the ones in charlist are found in expression.
When used outside brackets, the exclamation point matches itself.
• You can use a hyphen (-) either at the beginning (after an exclamation mark,
if one is used) or at the end of charlist to match itself. In any other location,
the hyphen is used to identify a range of ANSI characters.
• When you specify a range of characters, they must appear in ascending sort
order (from lowest to highest). [A-Z] is a valid pattern, but [Z-A] is not.
• The character sequence [ ] is ignored; it is considered a zero-length string.
In some languages, there are special characters in the alphabet that actually
represent two separate characters. For example, several languages use the
character “Ê” to represent the characters “a” and “e” when they appear together.
The Like operator recognizes that the single special character and the two
individual characters are equivalent. When a language that uses a special character
is specified in the win.ini file (sLanguage), an occurrence of the special single
character in either pattern or expression matches the equivalent two-character
sequence in the other string. Similarly, a special single character in pattern
enclosed in brackets (by itself, in a list, or in a range), matches the equivalent twocharacter
sequence in expression.
The content in this appendix was adapted from the Microsoft Visual Basic Online
Help.

Emulator Special @x Keys D
When you use the DDE connection type, you can send the special characters
identified in the following table to the corresponding emulator. Send these
character sequences using the PASTE_CMDn=Varn or PASTE_CMDn=@A
commands.
Special keystroke
to send
Equivalent
Vlterm
command to
script
EXTRA!
3270
Irma
3270
Rumba
3270
Rumba
5250
@ @@ X X X
Alt @A X X X
Attention @A@Q X X
Backspace @< X X X X
Backtab (Left Tab) @B X X X X X
Caps Lock @Y X
Clear @C X X X X
Rumba
VAX
Cmd Function Key @A@Y X =Control
Key
Copy @K X
Cursor Down @V X X X
Cursor Left @L X X X
Cursor Right @Z X X X
Cursor Select @A@J X
Cursor Up @U X X X X
107

108 Vlterm Programmer’s Reference
Special keystroke
to send
Equivalent
Vlterm
command to
script
Delete Char @D X X X
Dup @S@X X X
End @q X
Enlarge @M X
Enter @E X X X X X
Erase EOF @F X X X
Erase Input @A@F X X =Remove
Field + @A@+ X =Next
Screen
Field - @A@- X =Previous
Screen
Field Exit @A@E X =Find
Field Mark @S@y X =Select
Finish (Quit) @Q X
Help @H X X
Hexadecimal @A@X X =Compose
Home @0 (zero) X X x X
Insert @I X X X X
Insert Toggle @A@I X
Jump @J X
Left Tab (Backtab) @B X X X X X
Local Print @P X X
New Line @N X
Not Used @W X
EXTRA!
3270
Irma
3270
Rumba
3270
Rumba
5250
Rumba
VAX
PA1 @x X X X =PF1
PA2 @y X X X =PF2
PA3 @z X X X =PF3

Special keystroke
to send
Equivalent
Vlterm
command to
script
EXTRA!
3270
Irma
3270
Emulator Special @x Keys 109
PA4 @+ X =PF4
PA5 @% X
PA6 @& X
PA7 @ X
PA8 @( X
PA9 @) X
PA10 @* X
Rumba
3270
Page Down @v X
Page Up @u X
Rumba
5250
Rumba
VAX
PF1 @1 X X X X =F1
PF2 @2 X X X X =F2
PF3 @3 X X X X =F3
PF4 @4 X X X X =F4
PF5 @5 X X X X =F5
PF6 @6 X X X X =F6
PF7 @7 X X X X =F7
PF8 @8 X X X X =F8
PF9 @9 X X X X =F9
PF10 @a X X X X =F10
PF11 @b X X X X =F11
PF12 @c X X X X =F12
PF13 @d X X X X =F13
PF14 @e X X X X =F14
PF15 @f X X X X =F15
PF16 @g X X X X =F16
PF17 @h X X X X =F17

110 Vlterm Programmer’s Reference
Special keystroke
to send
Equivalent
Vlterm
command to
script
PF18 @i X X X X =F18
PF19 @j X X X X =F19
PF20 @k X X X X =F20
PF21 @l X X X X
PF22 @m X X X X
PF23 @n X X X X
PF24 @o X X X X
Print @P X X
Print (PC) @A@t X
Record Backspace @A@< X
Reserved @X X
EXTRA!
3270
Irma
3270
Reset @R X X X X
Right Tab (Tab) @T X X X X X
Shift @S X X
Rumba
3270
Sys Request @A@H X X
Tab @T X X X X X
Test @A@c X
Rumba
5250
Rumba
VAX

ASCII and VT100 Control
E
Sequences
ASCII Characters
Unix host systems, such as the Mosaix system, interpret the following key
sequences to control screen or cursor movement.
ASCII Sequence Action
^H Backspace
^I Tab
^J Line Feed
^M Carriage Return
^[ Escape
Numeric Pad
There are a number of DEC escape codes to change many areas of terminal
operation such as keyboard, cursor, and display control. All of the DEC escape
sequences may not be supported by the application handling VT emulation. The
following table contains examples of common codes you can use.
Escape Code
^[P PF1
^[Q PF2
^[R PF3
^[S PF4
VT100 Keyboard
Equivalent
111

112 Vlterm Programmer’s Reference

Emulator Specifics F
This appendix contains descriptions and samples of various emulator packages
that
Attachmate
Vlterm supports several emulators offered by Attachmate Corporation.
Netware LAN WS
This section pertains to Attachmate Netware LAN WS 1.2 (previously offered by
Novell).
Vlterm communicates to Netware LAN using an intermediary program called
ntwrdrv.exe. Vlterm uses DDE to communicate to ntwrdrv.exe, and ntwrdrv.exe
communicates to Netware LAN using HLLAPI.
HLLAPI is required because the Attachmate application doesn’t support DDE
server and doesn’t accept the SendKeys() command, which simulates keystrokes
to perform a host record lookup during cut and paste.
Vlterm.ini Settings for Netware LAN WS
[SHELL]
HTERM1=c:\3270wks\wslanwin.exe c:\3270wks\lanws.wsc
HTERM2=c:\Program Files\Vlterm\ntwrdrv.exe /SN=A /Debug=Off
[WIN_TITLE]
HWIN1=A:ABC SESSION (LANWS.WSC)
HWIN2=Attachmate Netware Lan WS 1.2
113

114 Vlterm Programmer’s Reference
[DDE_SESSION]
HOST_SERVER1=
HOST_TOPIC1=
USE_DDE1=N
DDE_CONFIG_SESSION1=
HOST_SERVER2=NTWRDRV
HOST_TOPIC2=Ntwrdrv.exe
USE_DDE2=Y
DDE_CONFIG_SESSION2=DRV_DDE.INI

EXTRA! version 4.3
Emulator Specifics 115
To start EXTRA! with particular session configurations and window sizes, open
the sessions you want to configure in EXTRA!, size the windows, then save the
layout. (From the Window menu, choose Save Layout.)
Launch EXTRA! with the following Windows 95 command syntax:
HWIN1=C:\Program Files\E!PC16\EXTRA!.EXE C:\ Program Files
1\E!PC16\USER\HOST.EWL
or
HWIN1=C:\ PROGRA~1\E!PC16\EXTRA!.EXE
C:\PROGRA~1\E!PC16\USER\HOST.EWL
Sample Vlterm.ini for Attachmate EXTRA! version 4.3.
[WIN_TITLE]
HWIN0=KEA! 340 - MOSAIX
HWIN1=EXTRA! A - Session1
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=keavt
HOST_TOPIC0=macro
HOST_ITEM0=
USE_DDE0=Y
DDE_CONFIG_SESSION0=Kea_dde.ini
DDE_DELAY1=3
HOST_SERVER1=extra!
HOST_TOPIC1=A
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=Ext_dde.ini

116 Vlterm Programmer’s Reference
EXTRA! Personal Client 6.x and
EXTRA! Bundle for TCP/IP Version 6.2
Use EXTRA! Personal Client (EPC) 6.x 32-bit edition at sites running a 32-bit
Windows environment such as Windows 95 or Windows NT. Vlterm can
communicate with EXTRA! two different ways: SendKeys() and OLE.
SendKeys() can be used without special adjustments in the 32-bit environment.
EXTRA! supports OLE Automation, a Microsoft Windows standard for interprogram
communications. As an OLE Automation server, EXTRA! exposes
programmable objects like Session, Screen, and Toolbar, whose built-in
functionality can be accessed by user-written applications. For example, you
could write a PC application that transfers files between an IBM mainframe, AS/
400, and VAX. You would not have to write the file transfer code, but merely
invoke the file transfer functionality inherent in 3270, 5250, and VT Session
objects. To access automation-enabled objects, you must use a macro or
programming language that supports OLE Automation, such as the EXTRA!
Basic language or Microsoft Visual Basic 3.0 or later.
You control objects through their properties and methods using the dot syntax of
object.property and object.method.
For Vlterm to communicate to EPC using OLE, configure an additional
application for each EPC emulation window required to which Vlterm connects.
This additional application is called extdrv.exe, which is an external interface
between Vlterm and EPC. Vlterm communicates to extdrv.exe using DDE.
extdrv.exe communicates to EPC using OLE.
Special Notes
Consider the following recommendations when setting up a system that uses
EXTRA!. See Appendix H, “Configuring For Driver Files,” beginning on page
173, for further recommendations about configuring Vlterm to use a driver file for
EXTRA!.
• Note the relationship between the following:
The [SHELL] section entry to start the extdrv.exe interface must specify a
unique /SN= parameter for each instance:
C:\Program Files\Vlterm\extdrv.exe /SN=MOSAIX /Debug=Off
This parameter must be used in the corresponding [DDE_SESSION] section
entries:

Emulator Specifics 117
HOST_SERVER0=ExtDrv
HOST_TOPIC0=MOSAIX
The [WIN_TITLE] section must include:
Extra Personal Client Driver - MOSAIX
• EPC 6.1 uses a different method to send special key operations such as
ENTER, CLEAR, or HOME.
Send these instructions between angle bracket (< >) delimiters. For example,
PASTE_CMD2=
or
PASTE_CMD2=
See Appendix G, “Special EXTRA! Key Sequences,” beginning on page 169,
for a complete listing.
• If EXTRA! is installed using the Custom installation option, the API option
must be selected for installation. Otherwise, the extdrv.exe drive cannot
establish an OLE connection to EXTRA!.
To confirm that EXTRA! OLE Automation support is available, create a
macro using Learn. Play back the macro. If the macro playback is successful,
OLE Automation is enabled in EXTRA!.
Sample Vlterm.ini File for EXTRA! OLE
[GLOBAL]
MAX_SESSIONS=3
MAX_CUTS=10
MAX_PASTES=11
NUMBER_CNPS=3
NUMBER_VARS=9
AUTO_INTERVAL=3
AUTO_ENABLED=N
VERSION=0
[SHELL]
HTERM0=c:\Program Files\Vlterm\EXTDRV.EXE /SN=MOSAIX /
Debug=Off
S_DELAY0=3

118 Vlterm Programmer’s Reference
HTERM1=C:\Progra~1\E!PC\EXTRA.exe
c:\Progra~1\E!PC\sessions\UNIXDE~1.edp
S_DELAY1=3
HTERM2=c:\Program Files\Vlterm\EXTDRV.EXE /SN=HOST /
Debug=Off
S_DELAY2=3
HTERM3=C:\Progra~1\E!PC\EXTRA.exe
c:\Progra~1\E!PC\sessions\Mainfr~1.edp
S_DELAY3=3
[WIN_TITLE]
HWIN0=Extra Personal Client Driver - MOSAIX
HWIN1=Unixde~1 - EXTRA! Personal Client
HWIN2=Extra Personal Client Driver - HOST
HWIN3=Mainfr~1 - EXTRA! Personal Client
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=ExtDrv
HOST_TOPIC0=MOSAIX
HOST_ITEM0=
USE_DDE0=Y
DDE_CONFIG_SESSION0=DRV_DDE.ini
DDE_DELAY1=3
HOST_SERVER1=
HOST_TOPIC1=
HOST_ITEM1=
USE_DDE1=N
DDE_CONFIG_SESSION1=
DDE_DELAY2=3
HOST_SERVER2=ExtDrv
HOST_TOPIC2=HOST
HOST_ITEM2=

USE_DDE2=Y
DDE_CONFIG_SESSION2=DRV_DDE.ini
DDE_DELAY3=3
HOST_SERVER3=
HOST_TOPIC3=
HOST_ITEM3=
USE_DDE3=N
DDE_CONFIG_SESSION3=
DDE_TIMEOUT=20
[FKEY_BUTTONS]
DISPLAY_FKEYS=Y
FKEYS_FILE=
FKEYS_ON_TOP=Y
CAPTION=Vlterm
ROW1=Y
ROW2=Y
ROW3=Y
ROW4=N
ROW5=N
ROW6=N
[CNP1]
CNP_NAME=Main Cut and Paste Script
CUT_SESSION=0
PASTE_SESSION=2
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=5
CUT_CMD1=(1,1,8)
PASTE_CMD1=literal string
PASTE_CMD2=
;Set the Mosaix goto screen
PASTE_CMD3=RELEASE=VAL=x
Emulator Specifics 119

120 Vlterm Programmer’s Reference
PASTE_CMD4=ToggleTo(3)
PASTE_CMD5=FocusRemain(Y)
[CNP2]
CNP_NAME=Stop Extra driver to host session
CUT_SESSION=2
PASTE_SESSION=2
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=2
PASTE_CMD1=Other([exit()])
PASTE_CMD2=CNP3
[CNP3]
CNP_NAME=Stop Extra driver to Mosaix session and Vlterm
CUT_SESSION=0
PASTE_SESSION=0
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=2
PASTE_CMD1=Other([exit()])
PASTE_CMD2=Exit_Vlterm

Hummingbird Communications Exceed
Emulator Specifics 121
Hummingbird Exceed Version 6.0 Multiplatform has been tested as a 3270
emulator that communicates to a host system and a VT100 emulator that
communicates to a Mosaix system using telnet. This section deals with issues
specific to the Exceed emulator and Vlterm. Vlterm can communicate with
Exceed using DDE. Exceed follows the Attachmate DDE convention.
NOTE As a default, the DDE session numbers in the HOST_TOPIC=
configuration are assigned in increasing numerical order depending on the order
of executable startup.
Special 3270 keystrokes are sent using the typical @x convention. See Appendix
D, “Emulator Special @x Keys,” beginning on page 107 for more information.
The cut area is specified by (PxxxLyyy) where P is the presentation space position,
from 1 to 1920 representing row1 (positions 1 through 80) through row 24
(positions 1841 through 1920). L represents the length of the string to cut.
Example Vlterm.ini File for Exceed
[SHELL]
HTERM0=c:\hostex\programs\telnet.exe -P MOSAIX
S_DELAY0=3
HTERM1=c:\hostex\programs\tn3270.exe -P HOST
S_DELAY1=3
[WIN_TITLE]
HWIN0=MOSAIX
HWIN1=HOST
[DDE_SESSION]
DDE_DELAY0=6
HOST_SERVER0=HOSTEX
HOST_TOPIC0=1
;NOTE: The DDE topic values seem to be assigned by the order
;in which sessions are started. Maintaining a consistent
;session start or is therefore very important.
HOST_ITEM0=
USE_DDE0=Y

122 Vlterm Programmer’s Reference
DDE_CONFIG_SESSION0=HST_DDE.INI
DDE_DELAY1=3
HOST_SERVER1=HOSTEX
HOST_TOPIC1=2
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=HST_DDE.INI
DDE_TIMEOUT=10
[CNP1]
CNP_NAME=Sample host record lookup
CUT_SESSION=1
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=4
CUT_CMD1=(P2L16)
PASTE_CMD1=SetVar1=C(1)
PASTE_CMD2= VAR1
PASTE_CMD3= @E
PASTE_CMD4=Release=Val=hy

IBM Personal Communications 3270
Emulator Specifics 123
IBM Personal Communications (Pcomm) Version 4.0 has been tested with Vlterm
as a 3270 emulator to communicate to a host system. This section deals with issues
specific to the Pcomm emulator and Vlterm.
Vlterm can act as the DDE client and communicate with the Pcomm DDE server.
Special 3270 keystrokes are sent using the typical @x convention. See Appendix
D, “Emulator Special @x Keys,” beginning on page 107 for more information.
Sample Vlterm.ini Settings for IBM Pcomm
[SHELL]
HTERM1=C:\PCOM\PCSWS.EXE c:\pcom\private\ss1.ws
[WIN_TITLE]
HWIN1= A - SuperSession 1
[DDE_SESSION]
DDE_DELAY1=3
HOST_SERVER1=IBM3270
HOST_TOPIC1= SessionA
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=IBM_DDE.INI
[CNP1]
CNP_NAME=Sample host record lookup
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=2
PASTE_CMD1=C(1)
PASTE_CMD2=@E

124 Vlterm Programmer’s Reference
Irma 3270
Irma Workstation for Windows (IWW) is unique among the emulators that Vlterm
supports. For IWW to respond to Vlterm’s DDE requests, it must be configured to
execute a “quickscript” during startup to enable DDE serving. To create this
configuration, copy the appropriate files from the Vlterm installation CD-ROM
IRMA directory to the workstation’s IWW directory (default C:\IRMAWIN).
Single Irma 3270 Session
The files for a single 3270 session are described in the following table.
hostA.qep This file associates a specific emulation session profile (for
example, sessionA.emu) with a quickscript (for example,
serverA.isx). Chaining this file with the IWW binary on the
command line (for example, C:\irmawin\qexec.exe
C:\irmawin\hostA.qep) causes IWW to load the session
profile sessionA.emu and execute the quickscript
serverA.isx. This file is predefined by Lucent and doesn’t
need to be modified.
serverA.isx This quickscript sets up DDE serving on IWW. It should be
executed upon launching IWW and manually shut down after
closing the emulation session. This file is predefined by
Lucent and doesn’t need to be modified.
serverA.isl This is an uncompiled version of the quickscript serverA.isx.
It is a straight text file that outlines the DDE calls that IWW
will accept. This file would have to be modified and
recompiled to add additional DDE functionality. It is not
recommend to change this file unless directed by Lucent or
Attachmate.
utils.isl This is a supplementary utilities quickscript for IWW that is
called from serverA.isx. The utils.isl file provided by Lucent
is an updated 1995 version that should replace any existing
copy on the customer’s workstation. Only one copy of this
file is required for multiple sessions. This file should not be
modified in any way.

The customer needs to create one IRMA setup file.
Multiple Irma 3270 Sessions
Emulator Specifics 125
sessionA.emu This file defines the customer’s emulation session profile. It
contains information such as connection type, terminal
display, key mapping, so on. The customer should create this
file by following the steps outlined in the IWW User’s
Guide.
If you need to access more than one 3270 session with Vlterm, copy multiple
instances of the files described in the previous section from the Vlterm installation
CD-ROM to the customer’s IWW directory. The configuration files for each
individual session are identified by an appended letter, for example, A for the first
session, B for the second, C for the third, and D for the forth. For example, when
using two IWW sessions with Vlterm, copy hostA.qep, hostB.qep, serverA.isx,
serverB.isx, serverA.isl, serverB.isl, and one copy of utils.isl.
You must create multiple sessionn.emu files for each connection. This can be a
tricky procedure that requires a detailed understanding of the IWW User’s Guide.
Each individual EMU session must be saved with an appended A, B, C or D
depending on the number of emulation sessions. The best method to accomplish
this is to create the first session, sessionA.emu. Once you save sessionA.emu,
choose New Display from the File menu to create a second session (B) and
configure its connection type. Save this second session as sessionB.emu. Repeat
this procedure for the number of needed sessions.
NOTE Vlterm supports only four concurrent IWW sessions (A, B, C, and D).
The HTERMn entries in the vlterm.ini file must have a separate line for each
session. The main binary in the IRMAWIN directory is named qexec.exe. This
binary must be followed by the QEP file for a specific session. For example, the
entries to configure two 3270 sessions would look like the following:
HTERM0=C:\KEA\KEAVT.EXE C:\Program Files\Vlterm\MOSAIX.VTP
MOSAIX session with Kea!
HTERM1=C:\IRMAWIN\QEXEC.EXE C:\IRMAWIN\HOSTA.QEP Session A of
Irma
HTERM2=C:\IRMAWIN\QEXEC.EXE C:\IRMAWIN\HOSTB.QEP Session B of
Irma

126 Vlterm Programmer’s Reference
MiniSoft PowerTerm
PowerTerm Version 5.1.2 has been tested as a Host emulator in a Windows NT 4
environment with Vlterm version 4.x 32-bit edition.
PowerTerm supports DDE server. Only one instance of PowerTerm can be used as
a DDE server. PowerTerm doesn’t support unique DDE topic names to
differentiate connections.
If you use PowerTerm for the Mosaix system VT connection, you can use
ClipCut() to copy information from the screen. Setting DDE=N to force vlkeys.ini
file control character to send Mosaix releases is supported. PowerTerm accepts
Sendkeys paste script commands, such as %e, to access that menu, but does not
accept ordinary text to the screen.
Send special keystrokes using the syntax. PowerTerm buffers
keystrokes so that you can send data and press enter and have PowerTerm handle
the pacing before sending the next data item.
Sample Vlterm.ini File for PowerTerm
[SHELL]
HTERM1=\\Redfs01\custom\Alltel\MINISOFT\PTW\PTW32.EXE
[WIN_TITLE]
HWIN1=(A) T*
[DDE_SESSION]
DDE_DELAY1=3
HOST_SERVER1=PTW
HOST_TOPIC1=PSL
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=PTW_DDE.INI
[CNP27]
CNP_NAME=Main host record lookup
CUT_SESSION=1
PASTE_SESSION=1

Emulator Specifics 127
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=4
;screen startRow startCol [endRow] endCol
CUT_CMD1=(23 1 23 18)
PASTE_CMD1=C(1)
PASTE_CMD2=SetVar1=abc
PASTE_CMD3=Var1
PASTE_CMD4=literal string
;Example of Buffered key input example, no need for OIA
;PASTE_CMD1=1
;PASTE_CMD2=
;PASTE_CMD3=2
;PASTE_CMD4=
;PASTE_CMD5=3
;PASTE_CMD6=

128 Vlterm Programmer’s Reference
Netmanage Chameleon
HostLink 97
This section deals with issues specific to the HostLink 97 emulator and Vlterm.
Vlterm can communicate with HLLAPI, a High-Level Language Application
Programming Interface, for communications between 3270 sessions.
NOTE The HostLink Driver connection to Vlterm fails if the other applications
(terminal or printer sessions) are not already open. To connect to such a window,
use a wildcard(*) in the [WIN_TITLE] section of the vlterm.ini file.
Chameleon Hostlink 97 Examples
[WIN_TITLE]
HWIN0=Telnet*
HWIN1=HSLDRV32
HWIN2=3270 Terminal*
The HLLAPI driver Session Name should be A, and it must be one character in
length.
HTERM1=c:\Program Files\Vlterm\HSLDRV32.EXE /SN=A /Debug=ON
Different versions of the software use different directory names. The directory
names c:\Netmanag.95 and c:\Netmanag.32 look very much alike.
NOTE Don’t confuse the Hostlink and Unixlink emulators. Although they are
both produced by NetManage, Inc., they communicate with different machines.
Sample Vlterm.ini File for Hostlink
[GLOBAL]
;DEBUG=ON
MAX_SESSIONS=2
MAX_CUTS=3
MAX_PASTES=15
NUMBER_CNPS=1
NUMBER_VARS=3
AUTO_INTERVAL=3
AUTO_ENABLED=N

Emulator Specifics 129
[SHELL]
; Command lines for starting the emulator sessions.
; The Mosaix system session is always session 0.
HTERM0=TELNET.EXE 10.14.2.214
s_delay0=3
HTERM1=c:\Program Files\Vlterm\HSLDRV32.EXE /SN=A /Debug=OFF
s_delay1=3
;HTERM2=C:\NETMANAG.32\TN3270.EXE 168.61.2.18 1023
HTERM2=C:\NETMANAG.32\TN3270.EXE -f
C:\WINNT\Profiles\sh7790\Desktop\RJM.CFG
s_delay2=3
[WIN_TITLE]
HWIN0=Telnet*
HWIN1=HSLDRV32
HWIN2=3270 Terminal*
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=
HOST_TOPIC0=
HOST_ITEM0=
USE_DDE0=N
DDE_CONFIG_SESSION0=
DDE_DELAY1=3
HOST_SERVER1=HSLDRV32
HOST_TOPIC1=A
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=DRV_DDE.INI
DDE_DELAY2=3
HOST_SERVER2=

130 Vlterm Programmer’s Reference
HOST_TOPIC2=
HOST_ITEM2=
USE_DDE2=N
DDE_CONFIG_SESSION2=
; DDE session timeout in seconds
DDE_TIMEOUT=8
[FKEY_BUTTONS]
DISPLAY_FKEYS = Y
ROW1=Y
ROW2=Y
ROW3=Y
ROW4=Y
FKEYS_ON_TOP=Y
CAPTION=Vlterm
[CNP1]
CNP_NAME=Main cut and paste
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=3
NUMBER_PASTE_COMMANDS=4
;ACCTNUM
CUT_CMD1=ClipCut(%ea%ec~(6,23,11))
;MARKET
CUT_CMD2=ClipCut(~(5,23,2))
;NPA
CUT_CMD3=ClipCut(~(6,23,3))
PASTE_CMD1=C(2)
PASTE_CMD2=C(3)
PASTE_CMD3=@E
PASTE_CMD4=OIA,*CLEAR*

Unixlink 97 Version 7.0
Emulator Specifics 131
Chameleon Unixlink 97 by NetManage, Inc. has been tested as a host emulator in
a Windows NT environment with Vlterm version 4.4 32-bit edition.
NOTE The Vlterm SendKeys command cannot be used with Unixlink. Unixlink
will not respond to Sendkeys.
Unixlink supports HLLAPI for communications between 3270 sessions.
You can paste special keys by using the @ character convention. For example,
PASTE_CMD1=@E *
The HLLAPI driver Session Name should be A, and it must be one character in
length. For example,
HTERM1=c:\Program Files\Vlterm\HSLDRV32.EXE /SN=A /Debug=ON
Sample Vlterm.ini File for Unixlink
[SHELL]
HTERM0=C:\NETMANAG.32\TELNET.EXE
s_delay0=3
HTERM1=c:\Program Files\Vlterm\UXLDRV32.EXE /SN=A /Debug=ON
s_delay1=3
HTERM2=C:\NETMANAG.95\TN3270.EXE HOST.CFG
s_delay2=3
[WIN_TITLE]
HWIN0=Telnet -*
HWIN1=Unixlink Hllapi Driver 32 - A
HWIN2=3270 Terminal*
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=
HOST_TOPIC0=
HOST_ITEM0=
USE_DDE0=N
DDE_CONFIG_SESSION0=

132 Vlterm Programmer’s Reference
DDE_DELAY1=3
HOST_SERVER1=UXLDRV32
HOST_TOPIC1=A
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=DRV_DDE.INI
DDE_DELAY2=3
HOST_SERVER2=
HOST_TOPIC2=
HOST_ITEM2=
USE_DDE2=N
DDE_CONFIG_SESSION2=
DDE_TIMEOUT=20
[CNP1]
CNP_NAME=CNP
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=8
PASTE_CMD1=1
PASTE_CMD2=@E
PASTE_CMD3=OIA,*CLEAR*
PASTE_CMD4=2
PASTE_CMD5=@E
PASTE_CMD6=OIA,*CLEAR*
;PASTE_CMD7=C(1)
PASTE_CMD7=SetVar1=abc123ABC!@#
PASTE_CMD8=Var1

PDSI Psched Software DDE Interface
Emulator Specifics 133
PDSI Psched has been tested as an application with a DDE server with which
Vlterm can communicate. The tested communications consist of sending a data
record to effect a host record lookup. No cut or other type of paste command has
been tested.
This section of the appendix deals with issues specific to the Psched emulator and
Vlterm.
The following is an example of the string expected by PDSI. PATIENT is a fixed
string representing the message type; all other tilde delimited strings are fields
from the Mosaix system session.
PATIENT~A123456~MOORE ~JOHN ~M~01/22/1976~714-474-7374~800-
756-5640~AN~Neg
Data Description Data From a Record on the Mosaix System
Message Type PATIENT
Donor ID A123456
Last Name MOORE
First Name JOHN
Middle M
Date of Birth 01/22/1976
Home Phone # 714-474-7374
Work Phone # 800-756-5640
Blood Type AN
CMV Status Neg
Sample Vlterm.ini Settings for PDSI
[SHELL]
HTERM1=c:\cms\psched\psched.exe dde
[WIN_TITLE]
HWIN1=PheresiSched*

134 Vlterm Programmer’s Reference
[DDE_SESSION]
DDE_DELAY1=3
HOST_SERVER1=PSched
HOST_TOPIC1=Scheduling
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=PDSI_DDE.INI
[CNP1]
CNP_NAME=Main record lookup
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=8
NUMBER_PASTE_COMMANDS=20
;cut all the fields from the Mosaix Page2A screen
;Reflection R2 format: (row1,col1,row2,col2) 0..79
;Donor ID
CUT_CMD1=(15,42,15,48)
;Last Name
CUT_CMD2=(0,45,0,68)
;First Name
CUT_CMD3=(0,6,0,20)
;Middle Name
CUT_CMD4=(0,24,0,38)
;Date of Birth
CUT_CMD5=(15,26,15,33)
;Home Phone
CUT_CMD6=(8,5,8,16)
;Work Phone
CUT_CMD7=(8,37,8,48)
;Blood Type
CUT_CMD8=(15,11,15,13)
;CMV Status (actually part of Blood type field)
;CUT_CMD9=(0,1,0,2)

Emulator Specifics 135
PASTE_CMD1=Delay(.1)
;set a tilde delimiter character between fields
PASTE_CMD2=SetVAR1=~
;Build up the DDE message to send to PDSI
;Header description
PASTE_CMD3=StrCat(VAR2~“PATIENT”)
PASTE_CMD4=StrCat(VAR2~VAR1)
;Donor ID
PASTE_CMD5=StrCat(VAR2~CUT1)
PASTE_CMD6=StrCat(VAR2~VAR1)
;Last Name
PASTE_CMD7=StrCat(VAR2~CUT2)
PASTE_CMD8=StrCat(VAR2~VAR1)
;First Name
PASTE_CMD9=StrCat(VAR2~CUT3)
PASTE_CMD10=StrCat(VAR2~VAR1)
;Middle Name
PASTE_CMD11=StrCat(VAR2~CUT4)
PASTE_CMD12=StrCat(VAR2~VAR1)
;Date of Birth
PASTE_CMD13=StrCat(VAR2~CUT5)
PASTE_CMD14=StrCat(VAR2~VAR1)
;Home Phone
PASTE_CMD15=StrCat(VAR2~CUT6)
PASTE_CMD16=StrCat(VAR2~VAR1)
;Work Phone
PASTE_CMD17=StrCat(VAR2~CUT7)
PASTE_CMD18=StrCat(VAR2~VAR1)
;Blood Type
; If the 3rdchar is blank, the string is only 2chars long.
; evaluate the length, fill blood type and RH type depending
on field length
PASTE_CMD19=SetVar6=Midstring(CUT8~3~1)
PASTE_CMD20=CVR6=:CNP6:CNP7

136 Vlterm Programmer’s Reference
[CNP6]
CNP_NAME=Main record lookup continuation 2 char Blood type
CUT_SESSION=0
PASTE_SESSION=0
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=3
;Blood type
PASTE_CMD1=SetVar7=MidString(CUT8~1~1)
;RH type
PASTE_CMD2=SetVar8=MidString(CUT8~2~1)
PASTE_CMD3=CNP8
[CNP7]
CNP_NAME=Main record lookup continuation 3 char Blood type
CUT_SESSION=0
PASTE_SESSION=0
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=3
;Blood type
PASTE_CMD1=SetVar7=MidString(CUT8~1~2)
;RH type
PASTE_CMD2=SetVar8=MidString(CUT8~3~1)
PASTE_CMD3=CNP8
[CNP8]
CNP_NAME=Main record lookup continuation
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=5
;Blood Type
PASTE_CMD1=StrCat(VAR2~VAR7)
PASTE_CMD2=StrCat(VAR2~VAR1)

;Append a CMV Status value as a filler for now
;PASTE_CMD=StrCat(VAR2~CUT9)
;RH Type (equivalent to CMV?)
PASTE_CMD3=StrCat(VAR2~VAR8)
;send the string to PDSI
;PASTE_CMD4=Msg=VAR2
PASTE_CMD4=VAR2
;clear VAR2 for next time
PASTE_CMD5=SetVAR2=“”
Emulator Specifics 137

138 Vlterm Programmer’s Reference
Persoft SmarTerm
The following example pertains to SmarTerm for Windows 95/NT Version 7.0.
Sample Vlterm.ini File for SmarTerm
[SHELL]
HTERM0=c:\PROGRA~1\Persoft\STOFFICE.EXE
c:\PROGRA~1\Persoft\sessions\mosaix.stw
S_DELAY0=3
HTERM1=c:\PROGRA~1\Persoft\STOFFICE.EXE
c:\PROGRA~1\Persoft\sessions\cmis.stw
S_DELAY1=3
[WIN_TITLE]
HWIN0=SmarTerm Office - [mosaix.stw]
HWIN1=SmarTerm Office - [cmis.stw]
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=SToffice
HOST_TOPIC0=mosaix.stw
HOST_ITEM0=
USE_DDE0=Y
DDE_CONFIG_SESSION0=Sma_dde.ini
DDE_DELAY1=3
HOST_SERVER1=SToffice
HOST_TOPIC1=cmis.stw
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=Sma_dde.ini
DDE_TIMEOUT=10
[CNP1]
CNP_NAME=Main Cut and Paste record lookup
CUT_SESSION=0

PASTE_SESSION=1
CNP_TYPE=2
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=3
;row 3, col 43, page 1, len 12
CUT_CMD1=(3,43,1,12)
;Home
PASTE_CMD1=^[P4
;Tab
PASTE_CMD2=^I
PASTE_CMD3=C(1)
PASTE_CMD4=^M
Emulator Specifics 139
See Appendix E, “ASCII and VT100 Control Sequences,” beginning on page 111
for a description of the control sequences shown in the sample file.

140 Vlterm Programmer’s Reference
Quarterdeck Procomm Plus 32
Procomm supports a DDE server API interface. The emulator can be used for
either the Mosaix system or host connection. This emulator is typically used when
the connection to the host system requires asynchronous serial communication, or
the emulated terminal type must be an asynchronous terminal such as Wyse50,
IBM3101, VT220 or TVI925.
Verified functionality using the Procomm Plus emulator:
• Send characters to a Procomm session
• Get characters from a specified location
• Send Mosaix system line releases to a Procomm session
Vlterm.ini Settings for Procomm Plus
[SHELL]
HTERM0=D:\PROWIN\PROGRAMS\PW3.EXE CONNECT TELNET “ZURABI”
; use PW4 for version 4.5
[WIN_TITLE]
HWIN0=PROCOMM PLUS for Windows*
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=PW3
; use PW4 for version 4.5
HOST_TOPIC0=system
HOST_ITEM0=
USE_DDE0=Y
DDE_CONFIG_SESSION0=PRO_DDE.INI
[CNP15]
CNP_NAME=Test CNP sample cut
CUT_SESSION=0
PASTE_SESSION=0
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=3
;Procomm format: (row column ret_string string_len)

Emulator Specifics 141
;note a start count of row 0..23 and column 0..79
;S0 is a predefined global variable in Procomm Aspect script
language to hold the cut data
;this cut command copies from row0, col3, len10.
CUT_CMD1=(0 3 S0 10)
PASTE_CMD1=Msg=Cut1
PASTE_CMD2=C(1)
;Use ASCII control codes to send special keystrokes, or use
sendkeys instead.
;This is a carriage return
PASTE_CMD3=^M
PRO_DDE.INI Sample File
Use the pre-configured PRO_DDE.INI file to specify the DDE commands to send
to Procomm during script command interpretation.
[DDE_CUTS]
NumberOfLines=3
Line1=LinkExecute ASPECTCMD termgets &CutVar1
Line2=LinkItem S0
Line3=LinkRequest
[DDE_PASTECUTS]
NumberOfLines=1
Line1=LinkExecute TRANSMIT &PasteVar1&

142 Vlterm Programmer’s Reference
Sendkeys
The following sample portion of a vlterm.ini configuration file demonstrates the
use of Sendkeys to interact with the Mosaix system using Microsoft Telnet and a
simulation of a non-API customer application, such as Microsoft Notepad.
[GLOBAL]
MAX_SESSIONS=1
MAX_CUTS=5
MAX_PASTES=10
NUMBER_CNPS=1
NUMBER_VARS=5
AUTO_INTERVAL=3
AUTO_ENABLED=N
VERSION=0
[SHELL]
HTERM0=telnet.exe mosaix
S_DELAY0=3
HTERM1=notepad.exe c:\Program Files\Vlterm\host.txt
S_DELAY1=3
[WIN_TITLE]
HWIN0= Telnet - Mosaix
HWIN1=Host.txt - Notepad
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=
HOST_TOPIC0=
HOST_ITEM0=
USE_DDE0=N
DDE_CONFIG_SESSION0=
DDE_DELAY1=3
HOST_SERVER1=

HOST_TOPIC1=
HOST_ITEM1=
USE_DDE1=N
DDE_CONFIG_SESSION1=
[CNP1]
CNP_NAME=Main host record lookup
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=2
NUMBER_PASTE_COMMANDS=8
CUT_CMD1=ClipCut(%ea%ec~(1,1,4))
CUT_CMD2=ClipCut(~(2,1,12))
PASTE_CMD1=Delay(.5)
PASTE_CMD2=SendKeys=C(1)
PASTE_CMD3=Delay(.5)
PASTE_CMD4=SendKeys={Enter}
PASTE_CMD5=Delay(1)
PASTE_CMD6=SendKeys=C(2)
PASTE_CMD7=Delay(.5)
PASTE_CMD8=SendKeys={Enter}
Emulator Specifics 143

144 Vlterm Programmer’s Reference
Teknekron On Demand Software DDE Interface
Teknekron On Demand has been tested as an application with a DDE server with
which Vlterm can communicate. The tested communications consists of sending
commands to invoke three functions in On Demand:
• Start Recording
• Stop Recording
• Save the Recording
No cut or any other paste commands have been tested.
The following list describes the format of the three functions:
• Start recording button (Caption ‘OD Start’). This button POKEs data to the
DDE server in the following format:
RECSTART;600;
Where:
RECSTART is the message header, and 600 is a timeout after which recording
stops automatically.
• Stoprecordingbutton(Caption‘ODStop’).ThisbuttonPOKEsdatatothe
DDE server in the following format:
RECSTOP;
• Save recording button (Caption ‘OD Save’). This button POKEs data to the
DDE server in the following format:
RECSAVE;3451238590;ABTRHS;
Where:
RECSAVE is the message header. 3451238590 is the account number for the
current call (this can be a caller phone number or a unique database
identifier). ABTHRS is the job number.
Example Vlterm.ini File From Thaya Communications
NOTE The use of the OnD_DDE.ini file supports a VARn paste command only.
The VARn paste command sends a DDE Execute command with the parameters
specified in the CNPn paste commands.
[SHELL]
HTERM1=C:\Program Files\Teknekron Infoswitch\On
Demand\OnDemandClient.exe
S_DELAY1=3

[WIN_TITLE]
HWIN1=DDE Server Window
[DDE_SESSION]
DDE_DELAY1=3
HOST_SERVER1=Ondemand
HOST_TOPIC1=sound
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=Ond_DDE.ini
[CNP15]
CNP_NAME=On Demand Start Recording
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=2
PASTE_CMD1=SetVar1=RECSTART;600;
PASTE_CMD2=VAR1
[CNP16]
CNP_NAME=On Demand Stop Recording
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=2
PASTE_CMD1=SetVar1=RECSTOP;
PASTE_CMD2=VAR1
[CNP17]
CNP_NAME=On Demand Save Recording
CUT_SESSION=0
PASTE_SESSION=1
Emulator Specifics 145

146 Vlterm Programmer’s Reference
NUMBER_CUT_COMMANDS=2
NUMBER_PASTE_COMMANDS=7
;Lead number
CUT_CMD1=ClipCut(%ea%ec~(3,14,15))
;Client description NOTE: ADJUST LOCATION!
CUT_CMD2=ClipCut(~(3,14,4))
;Keyword for save function
PASTE_CMD1=SetVar1=RECSAVE;
PASTE_CMD2=SetVar2=;
;Append Lead number
PASTE_CMD3=StrCat(VAR1~CUT1)
PASTE_CMD4=StrCat(VAR1~VAR2)
;Append Client description
PASTE_CMD5=StrCat(VAR1~CUT2)
PASTE_CMD6=StrCat(VAR1~VAR2)
;Send the result
PASTE_CMD7=VAR1
OND_DDE.INI file
[DDE_PASTECUTS]
NumberOfLines=1
Line1=LinkExecute &PvarVar1&
[DDE_PVAR]
NumberOfLines=1
Line1=LinkExecute &PvarVar1&

Upstanding Systems FASTerm for Windows
Emulator Specifics 147
Upstanding Systems FASTerm Version 40.108.081 has been tested in a Windows
95 environment with Vlterm version 4.x 32-bit edition. FASTerm supports DDE
server. Vlterm acts as the DDE client to initiate and maintain a DDE session.
Vlterm also sends commands to FASTerm to put characters to and get characters
from the FASTerm window.
You can paste special keys by using the information in the following table.
Windows Key Name Description Notes
LeftMouseButton Left mouse button unused
RightMouseButton Right mouse button unused
MiddleMouseButton Middle mouse button unused
Alt Alternate key modifier
Ctrl Control key modifier
Shift Shift key modifier
NumLock NumLock key
ScrollLock Scroll lock key
Backspace BACKSPACE key
Break Used for control-break
Clear CLEAR key not on most keyboards
Delete DEL key
DownArrow DOWN ARROW key
End END key
Enter ENTER key
Escape ESC key
Execute EXECUTE key not on most keyboards
Help HELP key not on most keyboards
Home HOME key
Insert INS key
LeftArrow LEFT ARROW key
NumPad0 Numeric keypad 0 key

148 Vlterm Programmer’s Reference
Windows Key Name Description Notes
NumPad1 Numeric keypad 1 key
NumPad2 Numeric keypad 2 key
NumPad3 Numeric keypad 3 key
NumPad4 Numeric keypad 4 key
NumPad5 Numeric keypad 5 key
NumPad6 Numeric keypad 6 key
NumPad7 Numeric keypad 7 key
NumPad8 Numeric keypad 8 key
NumPad9 Numeric keypad 9 key
NumPadAdd Numeric keypad Add key
NumPadDecimal Numeric keypad Decimal key
NumPadDivide Numeric keypad Divide key
NumPadEnter Numeric keypad Enter key
NumPadMultiply Numeric keypad Multiply key
NumPadSubtract Numeric keypad Subtract key
PageDown PAGE DOWN key
PageUp PAGE UP key
Pause PAUSE key
PrintScreen PRINT SCREEN key preempted by Windows
RightArrow RIGHT ARROW key
Select SELECT key not on most keyboards
Separator Separator key not on most keyboards
Space SPACEBAR
Tab TAB key
UpArrow UP ARROW key
F1 F1 key
F2 F2 key
F3 F3 key

Windows Key Name Description Notes
F4 F4 key
F5 F5 key
F6 F6 key
F7 F7 key
F8 F8 key
F9 F9 key
F10 F10 key
F11 F11 key
F12 F12 key
Example Vlterm.ini File for FASTerm
[SHELL]
HTERM0=c:\PROGRA~1\walldata\VT\rumbavt.exe
c:\PROGRA~1\walldata\VT\mosaix.wdu
s_delay0=3
HTERM1=H:\BIN\fastwin\FTWIN.EXE Environment:1
s_delay1=3
Emulator Specifics 149
F13 F13 key not on most keyboards
F14 F14 key not on most keyboards
F15 F15 key not on most keyboards
F16 F16 key not on most keyboards
F17 F17 key not on most keyboards
F18 F18 key not on most keyboards
F19 F19 key not on most keyboards
F20 F20 key not on most keyboards
F21 F21 key not on most keyboards
F22 F22 key not on most keyboards
F23 F23 key not on most keyboards
F24 F24 key not on most keyboards

150 Vlterm Programmer’s Reference
[WIN_TITLE]
HWIN0=MOSAIX*
HWIN1= FASTerm - Environment:1
[DDE_SESSION]
HOST_SERVER0=rumbavt
HOST_TOPIC0=MOSAIX.vtp
HOST_ITEM0=
USE_DDE0=Y
DDE_CONFIG_SESSION0=RUM_DDE.INI
HOST_SERVER1=FASTerm
HOST_TOPIC1=Environment:1
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=FAS_DDE.INI
DDE_TIMEOUT=5
[CNP35]
CNP_NAME=Main host record lookup
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=6
;(RowStart,ColStart,RowEnd,ColEnd)
CUT_CMD1=(5,19,5,30)
PASTE_CMD1=SetVar1=MidString(C(1)~1~12)
PASTE_CMD2=Other(CursorHome)
PASTE_CMD3=I
PASTE_CMD4=Other(Tab)
PASTE_CMD5=SENDKEYS=VAR1
PASTE_CMD6=Other(Transmit)

[CNP36]
CNP_NAME=Reverse Cut and Paste
CUT_SESSION=1
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=3
CUT_CMD1=(10,44 to 10,46)
PASTE_CMD1 =C(1)
;PASTE_CMD2=SetVar1=abc
;PASTE_CMD3=Var1
Emulator Specifics 151

152 Vlterm Programmer’s Reference
Wall Data Rumba Office
Rumba for the Mainframe Classic configuration uses a DDE connection.
Configure a Rumba profile setting to specify a DDE topic name. Under the menu
option for Options API, specify a DDE Topic Name such as mosaix.vtp. Save the
configuration to the profile file.
The following vlterm.ini files are sample configurations for Rumba Office 95/NT
and Rumba Office 2000.
Rumba Office 95/NT V5.1 Vlterm.ini Example
[SHELL]
;Site path
HTERM0=c:\apps\walldata\rumba\vt\rumbavt.exe
c:\apps\walldata\rumba\vt\mosaix.wdu
S_DELAY0=3
HTERM1=c:\apps\walldata\rumba\mframe\rumbadsp.exe
c:\apps\walldata\rumba\SessionA.wdm
S_DELAY1=3
HTERM2=c:\apps\walldata\rumba\mframe\rumbadsp.exe
c:\apps\walldata\rumba\SessionB.wdm
S_DELAY2=3
HTERM3=c:\apps\walldata\rumba\mframe\rumbadsp.exe
c:\apps\walldata\rumba\SessionC.wdm
S_DELAY3=3
[WIN_TITLE]
HWIN0=mosaix - RUMBA UNIX Display
HWIN1=sessiona - RUMBA Mainframe Display
HWIN2=sessionb - RUMBA Mainframe Display
HWIN3=sessionc - RUMBA Mainframe Display
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=rumbavt
HOST_TOPIC0=mosaix.wdu
HOST_ITEM0=
USE_DDE0=Y

DDE_CONFIG_SESSION0=Rum_dde.ini
DDE_DELAY1=3
HOST_SERVER1=rumbadsp
HOST_TOPIC1=sessiona.dsp
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=Rum_dde.ini
DDE_DELAY2=3
HOST_SERVER2=rumbadsp
HOST_TOPIC2=sessionb.dsp
HOST_ITEM2=
USE_DDE2=Y
DDE_CONFIG_SESSION2=RUM_DDE.INI
DDE_DELAY3=3
HOST_SERVER3=rumbadsp
HOST_TOPIC3=sessionc.dsp
HOST_ITEM3=
USE_DDE3=Y
DDE_CONFIG_SESSION3=RUM_DDE.INI
DDE_TIMEOUT=10
[CNP1]
CNP_NAME=Main cut and paste
CUT_SESSION=0
PASTE_SESSION=3
NUMBER_CUT_COMMANDS=2
NUMBER_PASTE_COMMANDS=11
;account number (row1,col1, row2,col2)
CUT_CMD1=(6,18,6,34)
;location code
CUT_CMD2=(7,11,7,16)
PASTE_CMD1=@0
Emulator Specifics 153

154 Vlterm Programmer’s Reference
PASTE_CMD2=@T
PASTE_CMD3=UPD
PASTE_CMD4=@T
PASTE_CMD5=PRI
PASTE_CMD6=@T
PASTE_CMD7=C(1)
PASTE_CMD8=Cursor(5,45)
PASTE_CMD9=C(2)
PASTE_CMD10=@E
PASTE_CMD11=OIA,*0*
Rumba Office 2000 Vlterm.ini Example
[GLOBAL]
;DEBUG=ON
MAX_SESSIONS=1
MAX_CUTS=20
MAX_PASTES=10
NUMBER_CNPS=1
NUMBER_VARS=5
AUTO_INTERVAL=3
AUTO_ENABLED=N
VERSION=0
[SHELL]
HTERM0=C:\Rumba200\Vt\Rumbavt.exe C:\Rumba200\Vt\MOSAIX1.VTP
S_DELAY0=50
HTERM1=C:\Rumba200\MFrame\Rumbadsp.exe
C:\Rumba200\MFrame\COllECT1.DSP
S_DELAY1=50

[WIN_TITLE]
HWIN0=MOSAIX1 - RUMBA*
HWIN1=COLLECT1*
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=rumbavt
HOST_TOPIC0=mosaix1.vtp
HOST_ITEM0=
USE_DDE0=Y
DDE_CONFIG_SESSION0=RUM_DDE.INI
DDE_DELAY1=3
HOST_SERVER1=rumbadsp
HOST_TOPIC1=collect1.dsp
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=RUM_DDE.INI
Emulator Specifics 155
[CONTROL_PANEL]
; The control panel is maintained for prior compatibility
only.
; Use the FKEY_BUTTONS instead.
DISPLAY_PANEL=N
NUMBER_BUTTONS=0
[FKEY_BUTTONS]
DISPLAY_FKEYS=Y
FKEYS_FILE=
FKEYS_ON_TOP=Y
CAPTION= Vlterm - MOSAIX RUMBA

156 Vlterm Programmer’s Reference
ROW1=Y
ROW2=Y
ROW3=Y
ROW4=Y
ROW5=N
ROW6=N
[CNP1]
CNP_NAME=C&P
CUT_SESSION=0
PASTE_SESSION=1
CNP_TYPE=2
AUTO_CUT_COMPARE=
AUTO_CUT_COMPARE=
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=11
CUT_CMD1=(14,2,14,18)
PASTE_CMD1=UPDPRIIL
PASTE_CMD2=@F
PASTE_CMD3=C(1),NUMERIC
PASTE_CMD4=@B
PASTE_CMD5=@B
PASTE_CMD6=@B
PASTE_CMD7=@B
PASTE_CMD8=@B
PASTE_CMD9=@B
PASTE_CMD10=@B
PASTE_CMD11=@E

WRQ Reflection
Emulator Specifics 157
For Vlterm to interact with a single copy of Reflection software using the DDE
API, use the default DDE settings that are stored in the Reflection software
profile. For example, configure the vlterm.ini file with the following parameters
to communicate to R2 using DDE:
[DDE_SESSION]
HOST_SERVER1=R2WIN
HOST_TOPIC1=RCL
HOST_SERVERx is the value configured in the WRQ profile for the WRQ DDE
server name for that session. HOST_TOPICx is the required macro language “rcl”
sub-topic. The default server name is the executable name, for example, R2WIN
for the r2win.exe.
For Vlterm to interact with multiple Reflection windows, you must modify the
configuration of at least one of the session profiles to ensure the DDE connection
names are unique among the Reflection windows.
To change the server name for Reflection version 6.x and earlier
For versions of Reflection earlier than 7.0, choose SETUP, DDE from the
emulator menu to configure the DDE SERVER NAME. Specify a unique server
name, for example:
DDE SERVER NAME=MOSAIX
or
DDE SERVER NAME=HOST
To change the server name for Reflection version 7
1 Choose the Setup/View settings selection on the toolbar.
2 Search for DDE Server Name.
3 Select DDE Server Name.
By default, Reflection sets R1WIN as the server name.
4 Changethenametoauniqueidentifier.
The recommended name is the name of the session, for example MOSAIX for
the Mosaix system session.
5 Search for Multipage Terminal.

158 Vlterm Programmer’s Reference
6 Select Multipage Terminal.
By default, Reflection sets Multipage Terminal to On.
7 Change the selection to Off.
Multipage Terminal set to off allows the session to store only one page of
history. If more than one page of history is stored, Vlterm doesn’t cut the
correct information the Mosaix session screen.
8 Save the session and restart it.
The DDE Server Enable option should be selected. Save the profile with this
configuration, then use this profile on all agent stations.
To send special characters to Reflection sessions, use the ASCII equivalents. For
example, to send an Enter key, send the ASCII control sequence as:
PASTE_CMD2=^M
See Appendix E, “ASCII and VT100 Control Sequences,” beginning on page 111
for more information.
WRQ R1 Sample
The following is a sample portion of a vlterm.ini file set up for WRQ R1.
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=TERM
HOST_TOPIC0=RCL
HOST_ITEM0=
USE_DDE0=Y
DDE_CONFIG_SESSION0=Ref_dde.ini
[CNP2]
CNP_NAME=Paste ordinary and special characters
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=2
PASTE_CMD1=abc123
PASTE_CMD2=^M

Emulator Specifics 159
[CNP3]
CNP_NAME=CNP to R1 to R1
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=1
NUMBER_PASTE_COMMANDS=1
;(row1,column1,row2,column2) counting from 0..79, 0..23
CUT_CMD1=(0,8,0,16)
PASTE_CMD1=C(1)
WRQ R2 Sample
To configure WRQ R2:
Choose SETUP, DDE from the emulator menu to configure the DDE SERVER
NAME.
Specify a unique server name, for example,
DDE SERVER NAME=MOSAIX
or
DDE SERVER NAME=HOST
Ensure that DDE Server Enable is selected.
WRQ R8 Reflection for Windows Sample
The following is a partial vlterm.ini file set up for WRQ R8, Reflection for
Windows version 4.10.
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=R8WIN
HOST_TOPIC0=CONTROL
HOST_ITEM0=
USE_DDE0=Y
DDE_CONFIG_SESSION0=R841_DDE.INI

160 Vlterm Programmer’s Reference
[CNP21]
;R8 format (RnCn:RnCn)
CUT_CMD1=(R1C1:R1C15)
PASTE_CMD1=C(1)
PASTE_CMD2=Other(RC_ENTERKEY)
PASTE_CMD3=OIA
PASTE_CMD4=some text
Specify the R841_DDE.ini file as the DDE_CONFIG_SESSION. Note the syntax
for Vlterm as a DDE client to execute a Reflection Basic command in
PASTE_CMD2=Other() in the preceding example.
R841_DDE.ini File
[DDE_PASTECUTS]
NumberOfLines=1
Line1=LinkExecute rcTransmitANSI(“&PasteVar1&”)
R8 Version 4.10 Special Keystroke Commands
RC_ALTCURSORKEY RC_ATTNKEY RC_AU1KEY RC_AU2KEY
RC_AU3KEY RC_AU4KEY RC_AU5KEY RC_AU6KEY
RC_AU7KEY RC_AU8KEY RC_AU9KEY RC_AU10KEY
RC_AU11KEY RC_AU12KEY RC_AU13KEY RC_AU14KEY
RC_AU15KEY RC_AU16KEY RC_BACKSPACEKEY RC_BACKTABKEY
RC_BACKWARDKEY RC_CLEARKEY RC_CLEARPARTITIONKEY RC_CURSORBLINKKEY
RC_CURSORSELECTKEY RC_DELETECHARKEY RC_DELETEKEY RC_DELETEWORDKEY
RC_DEVICECANCELKEY RC_DOWNDOUBLEKEY RC_DOWNKEY RC_DUPKEY
RC_DUPLICATEKEY RC_ENTERKEY RC_ERASEEOFKEY
RC_ERASEINPUTKEY RC_EXTGRKEY RC_F1KEY RC_F2KEY
RC_F3KEY RC_F4KEY RC_F5KEY RC_F6KEY
RC_F7KEY RC_F8KEY RC_F9KEY RC_F10KEY
RC_F11KEY RC_F12KEY RC_F13KEY RC_F14KEY
RC_F15KEY RC_F16KEY RC_F17KEY RC_F18KEY
RC_F19KEY RC_F20KEY RC_F21KEY RC_F22KEY
RC_F23KEY RC_F24KEY RC_FIELDADVANCEKEY RC_FIELDBACKSPACEKEY
RC_FIELDDELIMKEY RC_FIELDEXITKEY RC_FIELDMARKKEY RC_FIELDMINUSKEY
RC_FIELDPLUSKEY RC_FORWARDKEY RC_HELPKEY RC_HEXKEY
RC_HOMEKEY RC_IDENTKEY RC_INSERTKEY

R8 Version 4.10 Special Keystroke Commands (Continued)
Copyright © 1994 Walker Richer & Quinn, Inc.
WRQ R8 Reflection for IBM for Windows 95 Sample
Emulator Specifics 161
RC_JUMPKEY RC_KEYCLICKKEY RC_KP0KEY RC_KP1KEY
RC_KP2KEY RC_KP3KEY RC_KP4KEY RC_KP5KEY
RC_KP6KEY RC_KP7KEY RC_KP8KEY RC_KP9KEY
RC_KPDECIMALKEY RC_KPDIVIDEKEY RC_KPENTERKEY RC_KPMINUSKEY
RC_KPMULTIPLYKEY RC_KPNUMLOCKKEY RC_KPPLUSKEY RC_LEFTDOUBLEKEY
RC_LEFTKEY RC_LOCALHELPKEY RC_LUJUMPKEY RC_NEWLINEKEY
RC_PA1KEY RC_PA2KEY RC_PA3KEY RC_PAGEDOWNKEY
RC_PAGEUPKEY RC_PANLEFTKEY RC_PANRIGHTKEY RC_PARTITIONJUMPKEY
RC_PAUSEKEY RC_PF1KEY RC_PF2KEY
RC_PF3KEY RC_PF4KEY RC_PF5KEY RC_PF6KEY
RC_PF7KEY RC_PF8KEY RC_PF9KEY RC_PF10KEY
RC_PF11KEY RC_PF12KEY RC_PF13KEY RC_PF14KEY
RC_PF15KEY RC_PF16KEY RC_PF17KEY RC_PF18KEY
RC_PF19KEY RC_PF20KEY RC_PF21KEY RC_PF22KEY
RC_PF23KEY RC_PF24KEY RC_PLAYKEY RC_PLUSCRKEY
RC_PRINTKEY RC_PRINTPARTKEY RC_QUITKEY RC_RECORDKEY
RC_RESETKEY RC_RIGHTDOUBLEKEY RC_RIGHTKEY RC_RULEKEY
RC_SCREENFORMAT
CHANGEKEY
RC_SCROLLDOWNKEY RC_SCROLLLEFTKEY RC_SCROLLRIGHTKEY
RC_SCROLLUPKEY RC_SETUPKEY RC_SLPAUTOENTERKEY
RC_SYSREQSTKEY
RC_UPKEY
RC_TABKEY RC_TESTKEY RC_UPDOUBLEKEY
The following is a sample of a vlterm.ini file set up for WRQ R8, Reflection for
IBM for Windows 95, version 6.10.
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=R8WIN
HOST_TOPIC0=CONTROL
HOST_ITEM0=
USE_DDE0=Y
DDE_CONFIG_SESSION0=R861_DDE.INI

162 Vlterm Programmer’s Reference
[CNP21]
;R8 format (RnCn:RnCn)
CUT_CMD1=(R1C1:R1C15)
PASTE_CMD1=C(1)
PASTE_CMD2=Other(rcIbmEnterKey)
PASTE_CMD3=OIA
PASTE_CMD4=some text
Specify the R861_DDE.ini file as the DDE_CONFIG_SESSION. Note the syntax
for Vlterm as a DDE client to execute a Reflection Basic command in
PASTE_CMD2=Other() in the above example.
Application is the Reflection object, with various methods to invoke such as
transmit an ANSI character string.
R861_DDE.ini File
[DDE_PASTECUTS]
NumberOfLines=1
Line1=LinkExecute Application.TransmitANSI “&PasteVar1&”
R8 Version 6.10 Special Keystroke Commands
rcIbmAltCursorKey rcIbmAttnKey rcIbmAu1Key rcIbmAu2Key
rcIbmAu3Key rcIbmAu4Key rcIbmAu5Key rcIbmAu6Key
rcIbmAu7Key rcIbmAu8Key rcIbmAu9Key rcIbmAu10Key
rcIbmAu11Key rcIbmAu12Key rcIbmAu13Key rcIbmAu14Key
rcIbmAu15Key rcIbmAu16Key rcIbmBackspaceKey rcIbmBackTabKey
rcIbmClearKey rcIbmClearPartitionKey rcIbmCursorBinkKey rcIbmCursorSelectKey
rcIbmDeleteCharKey rcIbmDeleteKey rcIbmDeleteWordKey rcIbmDeviceCancelKey
rcIbmDownDubleKey rcIbmDownKey rcIbmDupKey
rcIbmDuplicateKey rcIbmEnterKey rcIbmEraseEofKey rcIbmEraseInputKey
rcIbmExtGrKey rcIbmF1Key rcIbmF2Key rcIbmF3Key
rcIbmF4Key rcIbmF5Key rcIbmF6Key rcIbmF7Key
rcIbmF8Key rcIbmF9Key rcIbmF10Key rcIbmF11Key
rcIbmF12Key rcIbmF13Key rcIbmF14Key rcIbmF15Key
rcIbmF16Key rcIbmF17Key rcIbmF18Key rcIbmF19Key
rcIbmF20Key rcIbmF21Key rcIbmF22Key rcIbmF23Key
rcIbmF24Key rcIbmFieldDelimKey rcIbmFieldExitKey rcIbmFieldMarkKey
rcIbmFieldMinusKey rcIbmFieldPlusKey rcIbmHelpKey

R8 Version 6.10 Special Keystroke Commands
Copyright © 1994-1997 WRQ, Inc.
Emulator Specifics 163
rcIbmHexKey rcIbmHomeKey rcIbmIdentKey rcIbmInsertKey
rcIbmKeyClickKey rcIbmLeftDoubleKey rcIbmLeftKey rcIbmNewLineKey
rcIbmPa1Key rcIbmPa2Key rcIbmPa3Key rcIbmPageDownKey
rcIbmPageUpKey rcIbmPanLeftKey rcIbmPanRightKey rcIbmPartitionJumpKey
rcIbmPf1Key rcIbmPf2Key rcIbmPf3Key rcIbmPf4Key
rcIbmPf5Key rcIbmPf6Key rcIbmPf7Key rcIbmPf8Key
rcIbmPf9Key rcIbmPf10Key rcIbmPf11Key rcIbmPf12Key
rcIbmPf13Key rcIbmPf14Key rcIbmPf15Key rcIbmPf16Key
rcIbmPf17Key rcIbmPf18Key rcIbmPf19Key
rcIbmPf20Key rcIbmPf21Key rcIbmPf22Key rcIbmPf23Key
rcIbmPf24Key rcIbmPlusCrKey rcIbmPrintKey rcIbmPrintPartKey
rcIbmResetKey rcIbmRightDoubleKey rcIbmRightKey rcIbmRuleKey
rcIbmScrollDownKey rcIbmScrollLeftKey rcIbmScrollRightKey rcIbmScrollUpKey
rcIbmSetupKey rcIbmSlpAutoEnterKey rcIbmSysReqstKey rcIbmTabKey
rcIbmTestKey rcIbmUpDoubleKey rcIbmUpKey

164 Vlterm Programmer’s Reference
Zephyr Development Passport 3270 Client
The Passport 3270 Client Version 5.0 by Zephyr Development Corporation is for
Windows 95 systems. This section deals with issues specific to the Passport
emulator and Vlterm. As with Chameleon’s Hostlink, Vlterm can communicate
with Passport two different ways: SendKeys() and HLLAPI.
Because the Passport package doesn’t support VT100 emulation, set up the
configuration to run an alternate emulator for the VT100 connection to the Mosaix
system.
NOTE The Passport driver connection to Vlterm fails if the other applications
(terminal or printer sessions) are not already open. In order to connect to such a
window, use a wildcard(*) in the [WIN_TITLE] section of the vlterm.ini file.
Examples
[WIN_TITLE]
;This line is for the Zephyr driver
HWIN0= Hllapi*
;This is the Passport session connection to MOSAIX.
HWIN1=(A) Passport*
;This is the Telnet connection to the Host.
HWIN2= Telnet*
Pasting regular text works by using SendKeys with the command:
Paste_Cmd1=SendKeys =This is sample text.
To paste of special keys is possible by de-referencing the key with the @ character.
The example below illustrates the special character @ preceding E for
[CNP1]
CNP_NAME=Paste Special key for ENTER to Host
CUT_SESSION=0
PASTE_SESSION=1
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=1
PASTE_CMD1=@E
The HLLAPI driver Session Name should be A, it must be one character in length.
HTERM0=c:\Program Files\Vlterm\ZWHLDR32.EXE /SN=A /Debug=OFF

Emulator Specifics 165
NOTE The .dll file for the driver must be installed to c:\Program
Files\Vlterm\passhll.dll. This is the same directory for the HLLAPI driver.
Sample Vlterm.ini File for Passport 3270 Client
[GLOBAL]
DEBUG=OFF
MAX_SESSIONS=2
MAX_CUTS=3
MAX_PASTES=15
NUMBER_CNPS=4
NUMBER_VARS=3
AUTO_INTERVAL=3
AUTO_ENABLED=
[SHELL]
HTERM0=C:\WINDOWS\TELNET.EXE
s_delay0=3
HTERM1=c:\Program Files\Vlterm\ZWHLDR32.EXE /SN=A /Debug=OFF
s_delay1=3
HTERM2=\PASSPORT.EXE C:\PROGRAM
FILES\PASSPORT\PASSPORT.ZWS
s_delay2=3
[WIN_TITLE]
; MOSAIX
HWIN0=Telnet*
; HLLAPI driver
HWIN1=Hllapi*
; HOST
HWIN2=(A) Passport*
[DDE_SESSION]
DDE_DELAY0=3
HOST_SERVER0=

166 Vlterm Programmer’s Reference
HOST_TOPIC0=
HOST_ITEM0=
USE_DDE0=N
DDE_CONFIG_SESSION0=
DDE_DELAY1=3
HOST_SERVER1=zwhldr32
HOST_TOPIC1= A
HOST_ITEM1=
USE_DDE1=Y
DDE_CONFIG_SESSION1=DRV_DDE.INI
DDE_DELAY2=3
HOST_SERVER2=
HOST_TOPIC2=
HOST_ITEM2=
USE_DDE2=N
DDE_CONFIG_SESSION2=
; DDE session timeout in seconds
DDE_TIMEOUT=20
[FKEY_BUTTONS]
DISPLAY_FKEYS = Y
ROW1=N
ROW2=Y
ROW3=Y
ROW4=N
FKEYS_ON_TOP=N
CAPTION=Vlterm
[CNP1]
CNP_NAME=Paste only to Host
CUT_SESSION=0
PASTE_SESSION=1

NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=3
CUT_CMD1=ClipCut(%ea%ec~(2,4,30))
PASTE_CMD1=C(1)
PASTE_CMD2=Hello
PASTE_CMD3=@E
Emulator Specifics 167

168 Vlterm Programmer’s Reference

Special EXTRA! Key Sequences G
Use the following table to identify the Attachmate EXTRA! mnemonic command
that represents a particular VT function key. When you specify a mnemonic in a
Vlterm script, enclose it in angle brackets (). An online help file in the Macro
Editor describes using Keyboard Mnemonics against emulator sessions. From the
Macro Editor, select Help | Index | Key Mnemonics, PC-Host | VTFunction Keys.
3270 Function
Key Mnemonic
5250 Function
Key Mnemonic
VT Function
Key Mnemonic
Attention Attn Attention Attn Backspace Backspace
Backspace BackSpace Backspace BackSpace Break Signal Break
Backtab (Left
Tab)
BackTab Backtab (Left
Tab)
BackTab Compose
Sequence
Compose
Caps Lock CapsLock Begin Line BeginLine Cursor Down Down
Clear Clear Clear Clear Cursor Left Left
Cursor Down Down Command 1 PF1 Cursor Right Right
Cursor Left Left Command 2 PF2 Cursor Up Up
Cursor Left 2
Columns
Left2 Command 3 PF3 Escape Esc
Cursor Right Right Command 4 PF4 F1 F1
Cursor Right 2
Columns
Right2 Command 5 PF5 F2 F2
Cursor Select CursorSelect Command 6 PF6 F3 F3
Cursor Up Up Command 7 PF7 F4 F4
Delete Char Delete Command 8 PF8 F5 F5
Duplicate Dup Command 9 PF9 F6 F6
169

170 Vlterm Programmer’s Reference
3270 Function
Key Mnemonic
Enter Enter Command 10 PF10 F7 F7
Erase EOF EraseEOF Command 11 PF11 F8 F8
Erase Input EraseInput Command 12 PF12 F9 F9
FieldMark FieldMark Command 13 PF13 F10 F10
Home Home Command 14 PF14 F11 F11
Insert Insert Command 15 PF15 F12 F12
Left Tab (Back
Tab)
BackTab Command 16 PF16 F13 F13
New Line NewLine Command 17 PF17 F14 F14
Pen Select PenSel Command 18 PF18 F15 F15
Print Print Command 19 PF19 F16 F16
Reset Reset Command 20 PF20 F17 F17
Shift ShiftOn Command 21 PF21 F18 F18
System Request SysReq Command 22 PF22 F19 F19
Tab (Right Tab) Tab Command 23 PF23 F20 F20
PA1 PA1 Command 24 PF24 Find Find
PA2 PA2 Cursor Down Down Insert Insert Here
PA3 PA3 Cursor Down 2
rows
Down2 Hold Hold
PF1 PF1 Cursor Left Left Keypad - Keypad -
PF2 PF2 Cursor Left 2
columns
Left2 Keypad , Keypad ,
PF3 PF3 Cursor Right Right Keypad Enter Keypad
Enter
PF4 PF4 Cursor Right 2
columns
5250 Function
Key Mnemonic
VT Function
Key Mnemonic
Right2 Keypad . Keypad .
PF5 PF5 Cursor Select CursorSelect Keypad 0 Keypad 0
PF6 PF6 Cursor Up Up Keypad 1 Keypad 1

3270 Function
Key Mnemonic
PF7 PF7 Cursor Up 2
rows
Special EXTRA! Key Sequences 171
Up2 Keypad 2 Keypad 2
PF8 PF8 Delete Char Delete Keypad 3 Keypad 3
PF9 PF9 Duplicate Dup Keypad 4 Keypad 4
PF10 PF10 End of Line EndLine Keypad 5 Keypad 5
PF11 PF11 Enter Enter Keypad 6 Keypad 6
PF12 PF12 Erase EOF EraseEOF Keypad 7 Keypad 7
PF13 PF13 Erase EOL EraseEOL Keypad 8 Keypad 8
PF14 PF14 Erase Input EraseInput Keypad 9 Keypad 9
PF15 PF15 Field Exit FieldExit Next Screen Next
PF16 PF16 Field Mark FieldMark PF1 PF1
PF17 PF17 Field Minus FieldMinus PF2 PF2
PF18 PF18 Field Plus FieldPlus PF3 PF3
PF19 PF19 Help Help PF4 PF4
PF20 PF20 Home Home Previous Screen Prev
PF21 PF21 Insert Mode InsertMode Print Screen Print
PF22 PF22 Insert Toggle Insert Remove Remove
PF23 PF23 Left Tab (Back
Tab)
5250 Function
Key Mnemonic
BackTab Select Select
PF24 PF24 New Line NewLine Setup Setup
PA1 @x Tab Tab
PA2 @y Enter Ctrl+M
PA3 @z
Print Print
Reset Reset
Right Tab (Tab) Tab
Roll Down RollDown
VT Function
Key Mnemonic

172 Vlterm Programmer’s Reference
3270 Function
Key Mnemonic
5250 Function
Key Mnemonic
Roll Up RollUp
System Request SysReq
Tab (Right Tab) Tab
Copyright © 1996, Attachmate Corporation. All Rights Reserved.
VT Function
Key Mnemonic

Configuring For Driver Files H
If the emulator you use communicates with HLLAPI, COM, or another
proprietary API, you need to use a driver to communicate between Vlterm and the
emulator. When this is the case, there are special vlterm.ini configuration
considerations. Consider the following recommendations when setting up a
Vlterm system that uses a driver:
• The PASTE_SESSION= for a CNPn section should reference the driver
session number instead of the emulator session.
• After a paste, set the focus to the appropriate window using the ToggleTo(n)
command with the FocusRemain(Y) command. This is necessary because
the PASTE_SESSION= parameter in a CNPn section determines what
session receives focus, yet the session to which you issue the paste
commands is the hidden driver session, not the user display session.
• Do not use the TGL9 action entry in the vlkeys.ini file. Use a specific TGLn
to set the focus to a specific session. Otherwise, the toggle will switch
between all sessions, including the hidden driver interface.
• Configure an EXIT button to close the driver processes. See the following
excerpt from a vlterm.ini file that shows an Attachmate EXTRA! driver
example.
[CNP2]
CNP_NAME=Stop Extra driver to host session
CUT_SESSION=2
PASTE_SESSION=2
NUMBER_CUT_COMMANDS=0
NUMBER_PASTE_COMMANDS=2
PASTE_CMD1=Other([exit()])
PASTE_CMD2=CNP3
173

174 Vlterm Programmer’s Reference
• Note the relationship among the following (the example shows an
Attachmate EXTRA! setup):
The [SHELL] section entry to start the driver interface must specify a unique
/SN= parameter for each instance:
C:\Program Files\Vlterm\extdrv.exe /SN=MOSAIX /Debug=Off
This parameter must be used in the corresponding [DDE_SESSION] section
entries:
HOST_SERVER0=ExtDrv
HOST_TOPIC0=MOSAIX
The [WIN_TITLE] section must include:
Extra Personal Client Driver - MOSAIX

Error Messages I
Vlterm displays error messages in the following format.
STARTUP.BAS Module
CONFIG.CNP Procedure Errors
Text(6) To MAX_SESSIONS MUST be added to CP.FRM!
Issued when MAX_SESSIONS is greater than five. A text box is defined in
CP.FRM for each session to pass DDE data between the DDE client (Vlterm) and
the DDE server. Currently 6 text boxes, TEXT0 - TEXT 5 are defined as a control
array. These can’t be added dynamically at run time and must be added to the form
at design time.
Error in VLKEYS.INI key &i& is missing a comma. Every key entry must have 3
commas.
Issued when a key file is not found or three commas aren’t present for each key,
1-48.
175

176 Vlterm Programmer’s Reference
Error in Fkeys.ini key &i& is missing a comma. Every key entry must have 3
commas.
FKEYS.INI entries are in the same format as VLKEYS.INI for compatability.The
same rules apply.
Error Reading Configuration Files: &Error(Err)& &Err&
Error exit for CONFIG.CNP. Check according to the Visual Basic error. One
common error is Type Mismatch, which frequently occurs when a non-numeric
field is used to subscript an array. The base cause is usually an incorrect format or
omitted field.
FOCUS_APPS Procedure Errors
Error activating “ & HWIN(i) - &Err& &Error(Err)& . Check [WIN_TITLE] entry in
vlterm.ini
The ini title doesn’t match the emulator title. Check for exact window title
description, including spacing.
HOST_LINK Procedure Errors
Unable to initiate DDE conversation with &HWIN(i)& &Error(Err)& &Err&. Check
[DDE_SESSION] entries for HOST_SERVER and HOST_TOPIC in VLTERM.INI.
When Vlterm issues a DDE error message, it has started the emulator sessions and
is attempting to establish a DDE conversation with the emulators. The error
message reports which session it is having trouble with, either session0 or
session1.
There may be several reasons for this error message:
• The emulators have been launched, but the connections to the respective
hosts have not been established. The emulator DDE server typically will not
run unless the session is connected to a host system and ready for use.
Test this by manually starting each session and logging in to each host, then
run Vlterm. If Vlterm can start after manually starting each emulator, it is a
timing issue with the [SHELL] section automatic launch of the emulators.

Error Messages 177
Increase the delay entries between starting each emulator and trying to DDE
link to the first one by changing:
s_delay0=1000
s_delay1=1000
• The HOST_SERVER and HOST_TOPIC entries in the vlterm.ini file for the
emulator session generating the error are incorrect. The HOST_SERVER
entry is typically the executable name, the HOST_TOPIC entry is the profile
name. For example, for Wall Data Rumba, it is:
HOST_SERVER0=rumbavt
HOST_TOPIC0=mosaix.vtp
INIT_CNP Procedure Errors
Incorrect command line parameter: Expected name of initialization file: (ex.
C:\DSI \VLTERM.INI)
The default location for the vlterm.ini is the current path with the name vlterm.ini.
This message is issued if the optional file name specified on the command line
does not have the extension .ini.
An instance of Vlterm is currently running.
Vlterm is already running. Check the Windows task list. Multiple copies of Vlterm
may not be run on the same workstation.
Error setting window as Topmost &rc&
The “loading” message could not be set as topmost, probably indicating that a
window was already set as topmost. This message also appears when the Control
Panel is used and could not be set as topmost.
Unable to start Host session: &(i)& &Error(Err)&. Check [SHELL] entry for
HTERM &i& in VLTERM.INI.
An error occurred trying to Shell a session. Try running the exact command line
from Program Manager to verify correct names.

178 Vlterm Programmer’s Reference
FOCUS_APPS Procedure Error
Error activating session” &(i)& - &Err& &Error(Err)& . Check [WIN_TITLE] entry
in VLTERM.INI.
The WIN_TITLE entry does not match the actual window title. Check spaces and
exact spelling of the name.
CNP.BAS Module
CUT_DATA Procedure Error
Unable to cut data for CNP &cur_CNP_num& CUT_CMD &i& . &Error(Err)&
&Err&
An error occurred during the cut. Note the complete error message and notify
Custom Engineering.
PASTE_DATA Procedure Errors
Error Pasting to Host: Unable to clear OIA
The host did not respond and unlock the keyboard in a 3270 session. Verify that
the host is active.
Error Pasting to Host: Wait command did not find selected text
Reflections only. The time limit expired without receiving the expected text on a
Wait command. Verify that the host is active and the text should be received on
that screen.
Error Pasting to &HWIN(cur_paste_sess)& . &Err& &Error(Err)& . CNP
&cur_CNP_num& CMD &I&
This message may appear for many reasons. Verify that the session is active and
on the correct screen and that the command syntax is valid. Processing continues.

SendDDEMessage Procedure Error
Error Messages 179
The function “&sPasteCmd&” is not supported going to the
“&ghWinCaptions(Session)&” emulator.
The paste command cannot be executed because of a problem communicating to
the intended session. Verify the xxx_DDE.ini file entries for the paste command
task type. Invalid or missing DDE communications handling sections within a
xxx_DDE.ini file will generate this error.
SEND_KEY Procedure Errors
Session &HWIN(0)& not active. Unable to continue processing.
An attempt was made to send a release to Mosaix, but the Mosaix session was not
active. Processing terminates and Vlterm must be restarted.
Unable to send key to Mosaix: &Err& &Error(Err)&
An error was trapped during the DDE send to the Mosaix session. Processing
continues. If the error is 285 or another DDE type error, try the menu command
RELINK DDE, particularly if a Telnet session may have timed out.
SEND_KEY Error in SetActiveWindow
An attempt was made to focus on the Mosaix window but Windows indicated that
the task was not active. Find out why the Mosaix emulator isn't running.
SEND_PFKEY Procedure Errors
Session &HWIN(cur_focus_flag)& not active. Unable to continue processing.
An attempt was made to send a PF Key to a host session, but the emulator task was
not active.

180 Vlterm Programmer’s Reference
Unable to send PF key to host: &Err& &Error(Err) & An error occurred during
the DDE send.
Processing continues.
SETUP_CNP Procedure Errors
Session &HWIN(cur_cut_sess)& not active. Unable to continue processing.
The cut session in a CNP is not active.
Session &HWIN(cur_paste_sess)& not active. Unable to continue processing.
The paste session in a CNP is not active.
TOGGLE_HOST Procedure Error
Session &HWIN(key_event_ number)& not active. Unable to continue
processing.
The selected session in a TGL is not active.
CP.FRM Module
AUTO_CNP.TIMER Procedure Error
Error in Auto CNP
An error occurred in the automatic CNP timer routine. Call Mosaix Customer
Support.

Form.Resize Procedure Errors
Error Messages 181
Error setting window as NONTopmost &rc&
An error occurred when the Control Panel was minimized. Call Mosaix Customer
Support.
Error setting window as Topmost “ &rc&
An error occurred when the Control Panel was maximized. Call Mosaix Customer
Support.
Menu_exit.Click Procedure Error
Exit Vlterm: Are you sure?
Exit verification from the popup menu.
FKEYS.FRM Module
KeyButton.Click Procedure Errors
Error in KeyButton_Click
This error may be caused by bad initialization data for the NUMBER_CNPS
parameter in the vlterm.ini file. When VLTERM uses a key parameter to allocate
memory for the program’s execution, it has the potential for an error. The value in
the number of CNPS parameter, is used to dimension an array. When this number
is too small, the array is not allocated with enough memory. This, in turn, causes
a crash when the array is de-referenced beyond its bounds.
This line from a vlterm.ini file shows such an example.
NUMBER_CNPS=1 ;Thisline is insufficient for 27 cut and paste actions.
The fact that the NUMBER_CNPS is one, means that the array only has one array
item. When the array item for CNP5 is accessed, the KeyButton_Click routine
brings up an error message.

182 Vlterm Programmer’s Reference
The error is solved with the correct number setting in vlterm.ini:
NUMBER_CNPS=27 ;This line is the correct setting.
The number used should match exactly the number of CNPs defined.
LOGON.FRM Module
cmdLOGON.Click Procedure Errors
Mosaix LOGON and Password are required. Please retry.
For the predefined host logon form, the host Logon and Password are required.
Please retry.
VERIFY PASSWORD must be entered.
For the predefined host logon form, a change to the password requires an entry in
theVERIFYPASSWORDfield.
Your NEW PASSWORD is not the same as the VERIFY PASSWORD! Please
reenter.
For the predefined host logon form, a change in the new password field requires a
matching entry in the VERIFY PASSWORD field.

Symbols
@x
paste command 39
special keys 107–110
A
Action setting
formn.ini 79
vlkeys.ini 12
API
configuration considerations 173
inter-application communications
tool 5
Application Programming Interface See
API
ASCII control sequences 111
Attachmate
emulator specifics 113–120
EXTRA! @x keys 107–110
EXTRA! Bundle for TCP/IP 116–120
EXTRA! Cursor() paste command 42
EXTRA! cut command format 36
EXTRA! Enterprise 5
EXTRA! for Windows 5
EXTRA! key sequences 169
EXTRA! mnemonic commands 169
EXTRA! Personal Client 116–120
EXTRA! v4.3 115
KEA! 5, 27, 28
KEA! cut command format 35
Netware LAN WS 113–114
OLE communications 116
SendKeys communications 116
AUTO_CUT_COMPARE setting,
vlterm.ini 32
AUTO_ENABLED setting, vlterm.ini 23
AUTO_INTERVAL setting, vlterm.ini 23
automatic cut and paste 63
B
Button object type, forms 75
Index
C
C() paste command 39
Cancel setting, formn.ini 79
Caption setting
formn.ini 79
vlterm.ini 29
CheckBox object type, forms 75
ClipCopyBlock() paste command 40
ClipCut() cut command 37
ClipGet() paste command 41
ClipSet() paste command 41
CloseForm setting, formn.ini 80
CNP_TYPE setting, vlterm.ini 31
183

184 Index
[CNPn] section, vlterm.ini
cut command formats 35–37
paste commands 39–61
settings 30–33
Color setting, vlkeys.ini 13
COM configuration considerations 173
ComboField object type, forms 75
configuration files 10
vlkeys.ini 11–17
vlterm.ini 19–33
See also vlkeys.ini sample files
See also vlterm.ini sample files
Contents setting, formn.ini 80
control sequences 111
ControlFocus setting, formn.ini 77
copyblock, DDE.ini file variable 69
Currency numeric format 92
Cursor() paste command 42
custom forms, loading 75
cut commands
formats 35–37
SendKeys 101
CUT_CMDn setting, vlterm.ini 32, 35–37
CUT_SESSION setting, vlterm.ini 31
CUTn|CVRn paste command 43
CutVarn, DDE.ini file variable 69
D
date formats, FORMAT function 96–100
General Date 97
Long Date 97
Medium Date 97
sample format expressions 99
Short Date 97
user-defined date formats 97–100
Date()
paste command 44
SetVarn subroutine 55
DDE
configuration files 10
description 6
inter-application communication
tool 5
vlterm.ini settings 26–29
DDE.ini
additional variables 72
configuration settings 70–72
copyblock variable 69
CutVarn variable 69
[DDE_CURSOR] section 70
[DDE_CUTS] section 70
[DDE_FINDS] section 71
[DDE_OIAKBD] section 70
[DDE_OTHER] section 71
[DDE_PASTECUTS] section 70
[DDE_PAUSE] section 71
[DDE_PVAR] section 70
[DDE_SENDFKEYS] section 72
[DDE_SENDPFKEYS] section 72
[DDE_SENDTHRU] section 71
[DDE_WAITS] section 71
file variables 68
introducing 67
Line variable 68
LinkItem variable 68
NumberOfLines variable 68
sample file 72–74
DDE_CONFIG_SESSIONn setting,
vlterm.ini 29, 68
DDE_DELAYn setting, vlterm.ini 28
[DDE_SESSION] section, vlterm.ini
settings 26–29

DDE_TIMEOUT setting, vlterm.ini 28
DEBUG setting, vlterm.ini 22
Delay() paste command 44
DISPLAY_FKEYS setting, vlterm.ini 29
DISPLAY_TOOLTIPS setting,
vlterm.ini 30
driver files
configuration considerations 173
EXTRA! recommendations 116
DRV cut command format 36
DynamicDataExchangeSee DDE
E
emulation applications
@x Keys 107
application names 27
cut command formats 35–36
emulator specifics 113–167
Exceed 121–122
EXTRA! Bundle for TCP/IP 116–120
EXTRA! Personal Client 116–120
EXTRA! v4.3 115
Host systems 5
IBM Pcomm 123
identifier 28
Irma 3270 124–125
MiniSoft PowerTerm 126–127
Mosaix system 5
Netmanage Chameleon
HostLink 128–130
Netmanage Chameleon
UnixLink 131–132
Netware LAN WS 113–114
PDSI Psched 133–137
Persoft SmarTerm 138–139
profile name 28
Quarterdeck Procomm Plus 140–141
Index 185
SendKeys 142–143
Teknekron On Demand 144–146
Upstanding FASTerm for
Windows 147–151
Wall Data Rumba Office 152–156
WRQ Reflection 157–163
Zephyr Passport 3270 164–167
error messages 175
ERROR_LOG setting, vlterm.ini 25
Exceed
emulator specifics 121–122
vlterm.ini sample file 121
Exit_Vlterm paste command 45
EXTRA!
@x keys 107–110
Bundle for TCP/IP 116–120
Cursor() paste command 42
cut command format 36
driver file recommendations 116
Enterprise 5
for Windows 5
mnemonic commands 169
OLE communications 116
Personal Client 116–120
SendKeys communications 116
special key sequences 169
version 4.3 details 115
vlterm.ini sample files 115, 117
F
File() paste command 45
Find() paste command 46
Fixed numeric format 92
[FKEY_BUTTONS] section, vlterm.ini
settings 29–30
FKEYS_ON_TOP setting, vlterm.ini 29
FKEYS_POSITION setting, vlterm.ini 30

186 Index
Focus setting, vlkeys.ini 13
FocusRemain() paste command 47
FontBold setting, formn.ini 80
FontSize setting, formn.ini 80
ForeColor setting, formn.ini 81
FORMAT function 91–100
date formats 96–100
numeric formats 91–96
string formats 100
syntax 91
time formats 96–100
FormatStr() paste command 47
FormLoad() paste command 47
formn.ini
Action setting 79
Cancel setting 79
Caption setting 79
CloseForm setting 80
configuration settings 76–85
Contents setting 80
ControlFocus setting 77
FontBold setting 80
FontSize setting 80
ForeColor setting 81
[GLOBAL] section 77–78
Height setting 81
Left setting 81
Mask setting 81
MaxButton setting 78
MinButton setting 78
MultiDelimiter setting 82
NumObjects setting 77
Object setting 82
object types 75
[Objectn] section 79–85
Parameters setting 82
Password setting 83
PasteIndex setting 83
Position setting 77
Required setting 83
sample file 86–89
SQLContents setting 84
TabIndex setting 84
Top setting 84
Type setting 84
UnloadOtherForms setting 78
UseContentsData setting 85
UserSetSize setting 77
Value setting 85
Width setting 85
WindowStyle setting 78
WindowTitle setting 78
forms, loading 75
function keys, toolbar equivalents 11
FunctionKeys setting, vlterm.ini 25
G
General Date format 97
General Number numeric format 92
[GLOBAL] section
vlterm.ini settings 22–25
formn.ini 77–78
H
Height setting, formn.ini 81
Hide_Fkeys paste command 48
Hide_Logon paste command 48
HLLAPI
configuration 173
Netmanage Chameleon HostLink 128
Netmanage Chameleon
UnixLink 131
Netware LAN WS 113
Zephyr Passport 3270 164
Host systems emulation applications 5

HOST_SERVERn setting, vlterm.ini 27
HOST_TOPICn setting, vlterm.ini 28
HTERMn setting, vlterm.ini 25
Hummingbird Communications Exceed
emulator specifics 121–122
HWINn setting, vlterm.ini 26
I
IBM
Personal Communications
emulator 123
vlterm.ini sample file 123
Input paste command 48
installing Vlterm
command line options 9
methods 9
shortcut locations 10
InString, SetVarn subroutine 56
inter-application communications tools 5
Irma
@x keys 107–110
emulator specifics 124–125
Mainframe Display 27, 28
multiple 3270 sessions 125
single 3270 session 124
K
KEA! 5, 27, 28
cut command format 35
L
Label object type, forms 75
Label setting, vlkeys.ini 13
Left setting, formn.ini 81
LeftStr() paste command 49
Like operator
pattern matching rules 106
syntax 105
Line, DDE.ini file variable 68
LinkItem, DDE.ini file variable 68
ListField object type, forms 75
Literal, SetVarn parameter 55
Long Date format 97
Long Time format 97
Lookup() paste command 49
Index 187
M
Mask setting, formn.ini 81
MaskTextField object type, forms 75
MathOnVars() paste command 50
MAX_CUTS setting, vlterm.ini 23
MAX_PASTES setting, vlterm.ini 23
MAX_SESSIONS setting, vlterm.ini 22
MaxButton setting, formn.ini 78
Medium Date format 97
Medium Time format 97
Midstring, SetVarn subroutine 57
MinButton setting, formn.ini 78
MiniSoft
PowerTerm 126–127
vlterm.ini sample file 126
Mosaix system emulation applications 5
Msg paste command 50
MultiDelimiter setting, formn.ini 82
N
Netmanage
Chameleon HostLink 128–130
Chameleon UnixLink 131–132
HLLAPI 128, 131
vlterm.ini sample files 128, 131

188 Index
Netware LAN WS 113–114
vlterm.ini sample file 113
Non-Reserved Word paste command 50
NUMBER_CNPS setting, vlterm.ini 23
NUMBER_CUT_COMMANDS setting,
vlterm.ini 31
NUMBER_PASTE_COMMANDS
setting, vlterm.ini 31
NUMBER_VARS setting, vlterm.ini 24
NumberOfLines, DDE.ini file variable 68
numeric formats, FORMAT function 91–
96
Currency 92
Fixed 92
General Number 92
On/Off 92
Percent 92
predefined numeric formats 92
sample format expressions 96
Scientific 92, 94
Standard 92
True/False 92
user-defined numeric formats 93–96
Yes/No 92
NumObjects setting, formn.ini 77
O
Object Linking and Embedding See OLE
Object setting, formn.ini 82
object types, forms 75
[Objectn] section, formn.ini 79–85
OIA paste command 51
OLE
Attachmate EXTRA! 116
inter-application communications
tool 7
On/Off numeric format 92
Other() paste command 52
P
Parameters setting, formn.ini 82
Password setting, formn.ini 83
paste commands 39–61
@x 39
C() 39
ClipCopyBlock() 40
ClipGet 41
ClipSet() 41
Cursor() 42
CUTn|CVRn 43
Date() 44
Delay() 44
Exit_Vlterm 45
File() 45
Find() 46
FocusRemain() 47
FormatStr() 47
FormLoad() 47
Hide_Fkeys 48
Hide_Logon 48
Input 48
LeftStr() 49
Lookup() 49
MathOnVars() 50
Msg 50
Non-Reserved Word 50
OIA 51
Other() 52
Pause() 53
Release 53
Relink 53

RightStr() 53
SendKeys 54, 101
SetVarn 54–57
Date() subroutine 55
InString subroutine 56
Literal parameter 55
Midstring subroutine 57
UserID subroutine 55
Variable parameter 55
ShellApp() 58
Show_Fkeys 58
Start_Auto_CNP 59
Stop_Auto_CNP 59
StrCat() 59
TitleCaption 59
ToggleTo() 60
VARn 60
Wait() 60
WaitForKey() 60
WinFocus() 61
PASTE_CMDn
paste commands 39–61
vlterm.ini setting 33
PASTE_SESSION setting, vlterm.ini 31
PasteIndex setting, formn.ini 83
Pause() paste command 53
PDSI
Psched Software DDE Interface 133–
137
vlterm.ini sample file 133
Percent numeric format 92
Persoft
SmarTerm emulation
application 138–139
vlterm.ini sample file 138
Position setting, formn.ini 77
Index 189
Q
Quarterdeck
Procomm Plus 32 details 140–141
vlterm.ini sample file 140
R
Reflection
cut command format 36
emulation details 157–163
R1 158
R2 5, 27, 28, 159
R4 27
R8 27, 28, 159, 161
special keystroke commands 160,
162
Release paste command 53
Relink paste command 53
Required setting, formn.ini 83
requirements 4
RightStr() paste command 53
ROWn setting, vlterm.ini 30
Rumba
@x keys 107–110
Cursor() paste command 42
cut command format 36
emulator details 152–156
for AS/400 5
for AS400 27, 28
for Mainframe 5, 27, 28
for UNIX/VAX 5, 27, 28
Office 5
S
S_DELAY setting, vlterm.ini 26
Scientific numeric format 92, 94

190 Index
SendKeys
Attachmate EXTRA! 116
ClipCut() command 37
description 6
paste command 54
sample configuration 102
usage 103
vlterm.ini sample file 142–143
vlterm.ini script commands 101
Zephyr Passport 3270 164
Session setting, vlkeys.ini 13
SetVarn paste command 54–57
Date() subroutine 55
InString subroutine 56
Literal parameter 55
Midstring subroutine 57
UserID subroutine 55
Variable parameter 55
[SHELL] section, vlterm.ini
settings 25–26
ShellApp() paste command 58
Short Date format 97
Short Time format 97
Show_Fkeys paste command 58
ShowSplashScreen setting, vlterm.ini 24
SQLContents setting, formn.ini 84
Standard numeric format 92
Start_Auto_CNP paste command 59
Stop_Auto_CNP paste command 59
StrCat() paste command 59
string formats, FORMAT function 100
system requirements 4
T
TabIndex setting, formn.ini 84
TblName setting, vlterm.ini 24
Teknekron
On Demand 144–146
vlterm.ini sample file 144
TextField object type, forms 75
time formats, FORMAT function 96–100
Long Time 97
Medium Time 97
sample format expressions 99
Short Time 97
user-defined time formats 97–100
TitleCaption paste command 59
ToggleTo() paste command 60
toolbar
button definitions 11–14
configuration syntax 12
function key equivalents 11
Tooltip setting, vlkeys.ini 13
Top setting, formn.ini 84
True/False numeric format 92
Type setting, formn.ini 84
U
UnloadOtherForms setting, formn.ini 78
Upstanding Systems
FASTerm for Windows 147–151
special FASTerm keys 147
vlterm.ini sample file 149
USE_DDEn setting, vlterm.ini 26
UseContentsData setting, formn.ini 85
UserID, SetVarn subroutine 55
UserSetSize setting, formn.ini 77
V
Value setting, formn.ini 85
Variable, SetVarn parameter 55

VARn
paste command 60
vlterm.ini setting 24
vlkeys.ini
Action setting 12
Color setting 13
configuring for a driver 173
description 11
Focus setting 13
Label setting 13
sample file 14
Session setting 13
syntax 12
Tooltip setting 13
[VOICELINK_KEYS] section 11–14
vlkeys.ini sample files
automatic cut and paste 65
basic 14
loading forms 76
Vlterm
command line options 9
configuration files 10
DDE configuration files 10
executable files 10
file reference 10
installation methods 9
shortcut locations 10
Vlterm toolbar
button definitions 11–14
configuration syntax 12
function key equivalents 11
vlterm.ini
AUTO_CUT_COMPARE setting 32
AUTO_ENABLED setting 23
AUTO_INTERVAL setting 23
automatic cut and paste 63
CAPTION setting 29
CNP_TYPE setting 31
[CNPn] section 30–33
Index 191
configuring for a driver 173
cut command formats 35–37
CUT_CMDn setting 32, 35–37
CUT_SESSION setting 31
DDE_CONFIG_SESSIONn 29, 68
DDE_DELAYn setting 28
[DDE_SESSION] section 26–29
DDE_TIMEOUT setting 28
DEBUG setting 22
description 19
DISPLAY_FKEYS setting 29
DISPLAY_TOOLTIPS setting 30
ERROR_LOG setting 25
[FKEY_BUTTONS] section 29–30
FKEYS_ON_TOP setting 29
FKEYS_POSITION setting 30
FunctionKeys setting 25
[GLOBAL] section 22–25
HOST_SERVERn setting 27
HOST_TOPICn setting 28
HTERMn setting 25
HWINn setting 26
MAX_CUTS setting 23
MAX_PASTES setting 23
MAX_SESSIONS setting 22
NUMBER_CNPS setting 23
NUMBER_CUT_COMMANDS
setting 31
NUMBER_PASTE_COMMANDS
setting 31
NUMBER_VARS setting 24
PASTE_CMDn 33, 39–61
PASTE_SESSION setting 31
ROWn setting 30
S_DELAY setting 26
sample file 19
[SHELL] section 25–26
ShowSplashScreen setting 24
TblName setting 24

192 Index
USE_DDEn setting 26
VARn setting 24
[WIN_TITLE] section 26
vlterm.ini sample files
automatic cut and paste 64
basic 19
Chameleon HostLink 128
Chameleon UnixLink 131
Exceed 121
EXTRA! 4.3 115
EXTRA! OLE 117
FASTerm 149
loading forms 76
Netware LAN WA 113
On Demand 144
Passport 3270 165
Pcomm 123
PowerTerm 126
Procomm Plus 140
Psched 133
Reflection R1 158
Reflection R8 159, 161
Rumba Office 2000 154
Rumba Office 95/NT 152
SendKeys 102, 142
SmarTerm 138
vt100 control sequences 111
W
Wait() paste command 60
WaitForKey() paste command 60
Wall Data
Rumba @x keys 107–110
Rumba Cursor() paste command 42
Rumba cut command format 36
Rumba for AS/400 5, 27, 28
Rumba for Mainframe 5, 27, 28
Rumba for UNIX/VAX 5, 27, 28
Rumba Office 5, 152–156
vlterm.ini sample files 152, 154
Width setting, formn.ini 85
[WIN_TITLE] section, vlterm.ini
settings 26
WindowStyle setting, formn.ini 78
WindowTitle setting, formn.ini 78
WinFocus() paste command 61
WRQ
Reflection cut command format 36
Reflection emulation details 157–163
Reflection R2 5, 27, 28
Reflection R4 27
Reflection R8 27, 28
special keystroke commands 160,
162
vlterm.ini sample files 158, 159, 161
Y
Yes/No numeric format 92
Z
Zephyr Development
HLLAPI 164
Passport 3270 Client 164–167
vlterm.ini sample file 165