emulation commands reference - …docs.rocketsoftware.com/nxt/gateway.dll/rkbnew20/wintegrate... ·...

Rocket wIntegrate

Emulation Commands Reference

Version 6.4.0

February 2016WIN-640-EC-RM-01

2

NoticesEdition

Publication date: February 2016Book number: WIN-640-EC-RM-01Product version: Version 6.4.0

Copyright© Rocket Software, Inc. or its affiliates 1996-2016. All Rights Reserved.

Trademarks

Rocket is a registered trademark of Rocket Software, Inc. For a list of Rocket registered trademarks goto: www.rocketsoftware.com/about/legal. All other products or services mentioned in this documentmay be covered by the trademarks, service marks, or product names of their respective owners.

Examples

This information might contain examples of data and reports. The examples include the names ofindividuals, companies, brands, and products. All of these names are fictitious and any similarity tothe names and addresses used by an actual business enterprise is entirely coincidental.

License agreement

This software and the associated documentation are proprietary and confidential to Rocket Software,Inc. or its affiliates, are furnished under license, and may be used and copied only in accordance withthe terms of such license.

Note: This product may contain encryption technology. Many countries prohibit or restrict theuse, import, or export of encryption technologies, and current use, import, and export regulationsshould be followed when exporting this product.

http://www.rocketsoftware.com/about/legal

3

Corporate informationRocket Software, Inc. develops enterprise infrastructure products in four key areas: storage, networks,and compliance; database servers and tools; business information and analytics; and applicationdevelopment, integration, and modernization.

Website: www.rocketsoftware.com

Rocket Global Headquarters77 4th Avenue, Suite 100Waltham, MA 02451-1468USA

To contact Rocket Software by telephone for any reason, including obtaining pre-sales informationand technical support, use one of the following telephone numbers.

Country Toll-free telephone number

United States 1-855-577-4323Australia 1-800-823-405Belgium 0800-266-65Canada 1-855-577-4323China 800-720-1170France 08-05-08-05-62Germany 0800-180-0882Italy 800-878-295Japan 0800-170-5464Netherlands 0-800-022-2961New Zealand 0800-003210South Africa 0-800-980-818United Kingdom 0800-520-0439

Contacting Technical Support

The Rocket Customer Portal is the primary method of obtaining support. If you have currentsupport and maintenance agreements with Rocket Software, you can access the Rocket CustomerPortal and report a problem, download an update, or find answers to in the U2 Knowledgebase.To log in to the Rocket Customer Portal or to request a Rocket Customer Portal account, go towww.rocketsoftware.com/support.

In addition to using the Rocket Customer Portal to obtain support, you can send an email [email protected] or use one of the following telephone numbers.

Country Telephone number

North America +1 800 729 3553United Kingdom/France +44 (0) 800 773 771 or +44 (0) 20 8867 3691Europe/Africa +44 (0) 20 8867 3692Australia +1 800 707 703 or +61 (0) 29412 5450New Zealand +0800 505 515

http://www.rocketsoftware.com

http://www.rocketsoftware.com/support

mailto:[email protected]

4

Contents

Notices................................................................................................................................................................................... 2

Corporate information......................................................................................................................................................... 3

Chapter 1: wIntegrate overview.......................................................................................................................................... 7wIntegrate features.................................................................................................................................................. 7Introduction to terminal emulation........................................................................................................................ 7Common emulation elements................................................................................................................................. 8

Chapter 2: Emulation file syntax....................................................................................................................................... 10

Chapter 3: Emulation commands......................................................................................................................................12AddTaggedAttr........................................................................................................................................................ 12AlarmMessage......................................................................................................................................................... 12AlarmOff...................................................................................................................................................................13AlarmOn...................................................................................................................................................................13AssignFont............................................................................................................................................................... 14AttributeEffect......................................................................................................................................................... 14AttributeMode......................................................................................................................................................... 14AttributeMode Char................................................................................................................................................ 15AttributeMode Line................................................................................................................................................. 16AttributeMode Page................................................................................................................................................16AttributeMode Wrap............................................................................................................................................... 17AttributeOff..............................................................................................................................................................17AttributeOn..............................................................................................................................................................18AutoFF......................................................................................................................................................................18AutoScroll................................................................................................................................................................ 19AutoScrollOff........................................................................................................................................................... 19AutoScrollOn........................................................................................................................................................... 19AutoWrap................................................................................................................................................................. 20AutoWrapOff............................................................................................................................................................ 20AutoWrapOn............................................................................................................................................................ 21BackSpace............................................................................................................................................................... 21BackTab................................................................................................................................................................... 22Bell........................................................................................................................................................................... 22ChangeColorOff.......................................................................................................................................................22ChangeColorOn....................................................................................................................................................... 23CharacterMapTable................................................................................................................................................ 23ChgTaggedAttr........................................................................................................................................................ 24ClearAllUnprotected............................................................................................................................................... 24ClearAOL.................................................................................................................................................................. 25ClearEOF.................................................................................................................................................................. 25ClearEOL.................................................................................................................................................................. 26ClearEOP..................................................................................................................................................................26ClearScreen............................................................................................................................................................. 26ClearSOL.................................................................................................................................................................. 27ClearSOP..................................................................................................................................................................27Color Back............................................................................................................................................................... 28Color Fore................................................................................................................................................................28CR............................................................................................................................................................................. 29CursorCode..............................................................................................................................................................29CursorDown.............................................................................................................................................................30CursorHome............................................................................................................................................................ 31CursorLeft................................................................................................................................................................ 31

Contents

5

CursorOff..................................................................................................................................................................32CursorOn..................................................................................................................................................................32CursorRight..............................................................................................................................................................33CursorUp..................................................................................................................................................................33DelayNewLine..........................................................................................................................................................34DeleteChar............................................................................................................................................................... 34DeleteLine................................................................................................................................................................35DestructiveBackspace.............................................................................................................................................35DisableProtect.........................................................................................................................................................36DisplayChar............................................................................................................................................................. 36DisplayMap.............................................................................................................................................................. 37DisplayNulls.............................................................................................................................................................37DisplayOff................................................................................................................................................................ 38DisplayOn................................................................................................................................................................ 38DoubleHeightLineBottom.......................................................................................................................................39DoubleHeightLineTop.............................................................................................................................................39DoubleSizeLineBottom...........................................................................................................................................39DoubleSizeLineTop................................................................................................................................................. 40DoubleWidthLine.....................................................................................................................................................40Effect........................................................................................................................................................................ 40Effect All...................................................................................................................................................................41Effect ANSI...............................................................................................................................................................41Effect CharacterRange............................................................................................................................................42Effect Mask.............................................................................................................................................................. 42Effect Order............................................................................................................................................................. 43EffectExtent............................................................................................................................................................. 43EffectIgnoreBold..................................................................................................................................................... 44EffectIgnoreReverse................................................................................................................................................ 44EmbeddedAttributes...............................................................................................................................................45EmulationMode....................................................................................................................................................... 45EnableProtect..........................................................................................................................................................46EraseCharsInLine.................................................................................................................................................... 47EraseScreen.............................................................................................................................................................47EraseUsingWriteAttr................................................................................................................................................47FormFeed.................................................................................................................................................................48ForwardSpace......................................................................................................................................................... 48GraphicMapTable....................................................................................................................................................49GraphicModeOff...................................................................................................................................................... 49GraphicModeOn...................................................................................................................................................... 50HardReset................................................................................................................................................................ 50HostCommandMapChars....................................................................................................................................... 50Ignore.......................................................................................................................................................................51IgnoreErrors.............................................................................................................................................................51InsertChar................................................................................................................................................................ 52InsertLine.................................................................................................................................................................52InsertModeOff..........................................................................................................................................................52InsertModeOn..........................................................................................................................................................53Key_......................................................................................................................................................................... 53KeyboardLock......................................................................................................................................................... 54KeyboardUnlock......................................................................................................................................................55Library......................................................................................................................................................................55LineFeed.................................................................................................................................................................. 56LockShiftGLFont......................................................................................................................................................56LockShiftGRFont..................................................................................................................................................... 57MapSequence.......................................................................................................................................................... 57MapTable................................................................................................................................................................. 58

Contents

6

MarginBell................................................................................................................................................................58MarginBellOff...........................................................................................................................................................59MarginBellOn...........................................................................................................................................................59MarginBellPsn..........................................................................................................................................................59MoveX.......................................................................................................................................................................60MoveXY.....................................................................................................................................................................60MoveY.......................................................................................................................................................................61NewLine................................................................................................................................................................... 61NormalVideo............................................................................................................................................................62PrinterIgnore........................................................................................................................................................... 62PrinterMap...............................................................................................................................................................63ProtectEffect............................................................................................................................................................63ProtectFullIntensity................................................................................................................................................ 64ProtectHalfIntensity................................................................................................................................................64ProtectOff................................................................................................................................................................ 64ProtectOn................................................................................................................................................................ 65ProtectTab...............................................................................................................................................................65RemoveSequence................................................................................................................................................... 66RestoreCursor..........................................................................................................................................................66ReverseLF................................................................................................................................................................ 67ReverseNewLine......................................................................................................................................................67ReverseVideo........................................................................................................................................................... 68SaveCursor.............................................................................................................................................................. 68ScrollDown.............................................................................................................................................................. 69ScrollUp................................................................................................................................................................... 69SetMarginBell.......................................................................................................................................................... 69SingleLine................................................................................................................................................................ 70SingleShift............................................................................................................................................................... 70SoftReset................................................................................................................................................................. 71StartCommand........................................................................................................................................................71Tab........................................................................................................................................................................... 71TabClear.................................................................................................................................................................. 72TabClearAll.............................................................................................................................................................. 72TabSet......................................................................................................................................................................73TaggedAttr............................................................................................................................................................... 73TaggedAttrOff..........................................................................................................................................................73TaggedAttrOn.......................................................................................................................................................... 74TekGraphic.............................................................................................................................................................. 74TelnetTerminal........................................................................................................................................................75TermId......................................................................................................................................................................75TerminalCommand................................................................................................................................................. 75Xoff........................................................................................................................................................................... 76Xon........................................................................................................................................................................... 77

Appendix A: ANSI escape sequences.................................................................................................................................78

Appendix B: Receiving long text strings from the host....................................................................................................79

7

Chapter 1: wIntegrate overviewwIntegrate is a connectivity tool that integrates host-based applications with the desktop. Theinitial interface is a terminal emulator with data transfer features designed for the multi-valuedenvironments of UniVerse, UniData, D3, and mvBase. You can share data with popular Windowsapplications, including Microsoft Word and Excel.

For developers, a comprehensive programming language enables a range of options for integratinghost environments with the desktop. You can add GUI features incrementally or create full GUIapplications driven from the host.

A suite of host-based subroutines is supplied to control the PC. These subroutines are created formulti-valued environments, but the techniques used can be adapted to any host.

Developer tools include the Editor and a Tools menu with useful utilities. You can choose to displaythe Tools menu in Setup > Preferences. Select the Scripts tab and then use the Menu Bar Scriptdrop-down list.

wIntegrate featuresAll wIntegrate features are supported with Rocket’s UniVerse, UniData, D3, and mvBase databases.

With wIntegrate, you can do the following tasks:

▪ Run concurrent sessions

▪ Customize a wIntegrate session

▪ Control any aspect of the application using powerful scripting language

▪ Optionally deploy a thin client on Windows or Java

▪ Run scripts from supplied host-based subroutines

▪ Define terminal emulations

▪ Export files from your PC to a host computer

▪ Import host computer files to your PC

▪ Transfer files from one host computer to another host computer

▪ Simplify deployment through optional thin client and browser interfaces

Introduction to terminal emulationMuch of the information sent to a terminal by a host computer is not the text that you see on thescreen, but the instructions as to where the text should be positioned, and text attributes such as dimand bright.

There is no single standard for these instructions. They differ between terminal manufacturers andspecific models from the same manufacturer, according to the features available on each terminal.The instructions usually include unprintable characters such as "Escape" (ASCII character 27).

To ensure maximum compatibility, most dumb terminals were supplied with several emulations sothey can work with instructions designed for other terminals. The host computer must be set to matchthe emulation for the desktop so that it can send instructions in the appropriate format.

If the desktop emulator and the host do not match, text will not be displayed properly, and might evenappear as a single unformatted block. At worst, the COM port will hang, and you might need to closeand restart wIntegrate.

Chapter 1: wIntegrate overview

8

Terminal emulations are stored as text files with the .WIT extension in the WINTSYS\WIT folder.This means that you can create terminal emulations or modify the supplied files to match the host.To do so, analyze the received control codes and set them to the appropriate keywords as defined inthis manual. The Control codes option in Edit > Record is invaluable for analyzing terminal emulationfiles. If you record incoming sequences in the Raw data format, they can be "replayed" later using Edit> Play to reproduce the same display. This can be helpful when you are debugging but not connectedto the host.

Terminal definitions are applied to a session only when a session is first started or when changingthe terminal emulation in Setup > Terminal. The Terminal dialog box that is accessed from Setup >Terminal also has a list of available extensions, which are stored in the WINTSYS\WIT_EXT folder.These are blocks of emulation functionality that are appended to the selected terminal. You can createyour own extensions. Incoming control sequences can be configured to trigger scripts, typically storedin the WINTSYS\WIT_SCR folder. Some of the regular emulation functionality is implemented asscripts, for example, sending the screen to the printer is the printscr.wis script.

Common emulation elementsThis section gives a brief overview of the most common elements of an emulation.

Terminal attributes

Terminal attributes control the way characters are displayed on the screen, for example, Dim,Reverse, and Underline. The following list describes the different ways of handling terminal attributes,depending on the terminal type:

▪ The AttributeMode command specifies how many characters an attribute sequence affects,and if the attribute character itself takes up a space on the screen.

▪ The EmulationMode command sets the AttributeMode command for the type of terminalthat is specified.

▪ The tagged attribute on/off method marks certain cells as using a non-specific terminal attribute.The actual terminal attribute to be applied is set separately, and is applied to all cells with the flagset. When this method is used, it is possible to display only one terminal attribute on screen at onetime.

▪ The TaggedAttrOn command sets the flag for the character positions in subsequent PRINTor CRT statements. The TaggedAttrOff command turns off the flag. The terminal display forall character positions with the flag set is subsequently changed by use of TaggedAttr Dim,TaggedAttr Reverse, or TaggedAttr Normal. Some terminals combine the taggedattribute on/off method with the embedded attributes method.

Cursor addressing

Cursor addressing defines the way the parameters in the MoveXY, MoveX, and MoveY functions areprocessed. It positions the cursor at a specific character “cell” on the screen.

The EmulationMode command automatically sets the correct cursor addressing code for a specifictype of emulation. The CursorCode command can be used to change the cursor addressing for theremaining commands in the emulation file. The cursor addressing code itself can be appended as anoptional argument to an individual Move command.

Character graphics

Certain terminals allow individual characters to be displayed as either the “real” character from thefont, or a graphics character such as a vertical line. To switch between these two character sets, theterminal reacts to the GraphicModeOn and GraphicModeOff control sequences.

Common emulation elements

9

To emulate these terminals, wIntegrate stores the “real” and graphics characters in theGraphicMapTable keyword. Other terminals use a sequence of control characters to define eachgraphics character. wIntegrate stores these as DisplayMap commands. Some terminals, such as theWyse 50 terminal, use both.

The mapping between a character on the host and the character that is used for display is defined in amapping table. A mapping table is defined using the MapTable command. Each emulation can havemultiple numbered map tables. Map table 0 is used for mapping the standard characters and maptable 1 is used to provide the mapping for the graphics characters set.

10

Chapter 2: Emulation file syntaxThe files in the WIT and WIT_EXT directory are plain text formatted files. This section explains thesyntax of these files.

The first line of the file must always consist of the text "[Terminal]". Each line in these files is either acommand, comment, or empty line. Comment lines start with an asterisk and can be added to the endof command lines by using a semicolon followed by an asterisk, but not all commands support end ofline comments.

Tab stops or spaces can be used to align the commands on different lines; these characters areignored unless they appear between quotation marks.

Any pair of quotation marks—single, back, or double—can be used to surround the host sequence. It isalso possible to double the quotation mark character, for example, '\e''' is the same as `\e'` or "\e'".

The host sequences and other strings in the command lines are in the backslash format. See Backslashformat strings, on page 10.

Many host sequences also contain string or numeric information. To allow these encoded parametersto be identified, the host sequence can contain special instructions that consist of a percent signfollowed by a character. See Host sequence parsing commands, on page 11.

There are several commands that require a parameter, such as MoveX. Other commands mighthave an optional parameter, such as CursoeLeft and LineFeed, while others do not require aparameter, such as KeyboardLock.

After the parameters are extracted from the host sequence, they are ignored if they are not requiredby the command. For example, KeyboardUnlock = “\e%fu” means that the host needs to senda three character sequence to unlock the keyboard, and it does not matter what the second characteris. The TerminalCommand sequence also uses a percent sequence in the second argument, scriptcommand, but those should not be confused with “host sequence” percent parameters.

The order of the host sequences in the WIT file is important. For example, if a WIT file contains thelines:- CursorLeft = “\e[%dL”;* then KeyboardLock = “\e[L”;*then the host could not lock the keyboard. This is because every time the host sends the sequence“\e[L” to lock the keyboard, the cursor would move one position to the left. If the lines werereversed, then the host could lock the keyboard but would need to send either “\e[0L” or “\e1L”to move the cursor one space to the left.

A keyword can be defined more than once, which allows several control sequences to have the sameeffect. It also simplifies the definition of graphic character translation tables. For example, if yourhost application has some programs that use FormFeed to clear the screen, and others use theCursorhome and ClearEOP, when the former method is used, data on the screen is moved to theback pages in memory. However, the latter method results in the screen being lost. With wIntegrate,you can define both of these sequences as FormFeed so that both result in the same action.

Normally, syntax errors in an emulation file are ignored and result in the invalid line being ignored. Forstricter error checking, turn off the IgnoreErrors flag by executing "Set IgnoreErrors = 0"from a script or with the example\script\wc.wis example script.

Backslash format strings

The following table describes the backslash format that is used for all the strings within the emulationfile.

Sequence Description

\z ASCII character 0 (NULL)

Emulation file syntax

11

Sequence Description

\f ASCII character 12 (Form feed)\t ASCII character 9 (Tab)\n ASCII character 10 (Line feed)\r ASCII character 13 (Carriage Return)\e ASCII character 27 (Escape)\ddd ASCII character ddd, where ddd is three decimal digits in the range 000 – 255\xhh ASCII character hh, where hh is two hexadecimal digits in the range 00 – FF\\ A single backslash character\cdddd Use the character number dddd from the characters embedded inside

the wIntegrate program, where dddd is four digits in the range 0000-1023.This is only valid in a few commands such as MapTable. If you selectedDeveloper Additions during installation, you can see the available charactersby running the chrset2.wis script in the C:\Program Files(x86)\wIntegrate\Example\Script folder.

\uhhhh Unicode character hhhh, where hhhh is four hexadecimal digits in the range0000 – FFFF

\m Only valid for key definitions and is used to indicate the key data should beexecuted by script, not transmitted to the host

Host sequence parsing commands

The following table describes the percentage commands to parse out variable sections of the receivedescape sequence.

Command Description

%f Single character parameter%v Variable length string parameter; must be fewer than 230 characters. See

Receiving long text strings from the host, on page 79.%d Variable length decimal parameter%a Variable number of variable length decimal parameters that are separated by

semicolons%h Variable length string parameter; unlike %v, the data is not mapped into the

local character set

12

Chapter 3: Emulation commandsThis chapter details each of the emulation commands that are provided with wIntegrate. You can usethese commands to modify or create a new emulation.

AddTaggedAttrThis sequence adds effects to the tagged character attribute effect, changing the way that it isdisplayed.

Syntax

AddTaggedAttr effect_list = seq

Parameters

The following table describes the parameters of the AddTaggedAttr command:

Parameter Description

effect_list The effects to add; can be "Normal" or one or more of "Dim," "Bold,""Reverse," "UnderLine," "Flash," or "Secret"

= Equals signseq The control sequence to invoke this command

Examples

The following example shows tagged attribute display sequences from the Wyse 50 emulation.

ChgTaggedAttr Normal = "\e`A"AddTaggedAttr Flash = "\e`B"AddTaggedAttr Secret = "\e`C"AddTaggedAttr Underline = "\e`E"AddTaggedAttr Reverse = "\e`F"AddTaggedAttr Dim = "\e`G"

Related commands

ChgTaggedAttr

AlarmMessageThis sequence sets the alarm message that appears in the status line every second when the alarm ison.

Syntax

AlarmMessage [=] seq

Parameters

The following table describes the parameters of the AlarmMessage command:

AlarmOff

13


= Equals signseq The control sequence to invoke this command; must contain one string

argument that is used for the alarm message

Related commands

AlarmOn, AlarmOff

AlarmOffThis sequence turns off the alarm started by the AlarmOn command.

Syntax

AlarmOff [=], seq

Parameters

The following table describes the parameters of the AlarmOff command:



Related commands

AlarmMessage, AlarmOn

AlarmOnThis sequence turns on the alarm that sounds a bell every second and shows the alarm message if oneis defined.

Syntax

AlarmOn [=] seq

Parameters

The following table describes the parameters of the AlarmOn command:



Related commands

AlarmMessage, AlarmOff

Chapter 3: Emulation commands

14

AssignFontThis sequence assigns the character map table to use for an emulation font bank.

Syntax

AssignFont [=] seq, bank, map_table

Parameters

The following table describes the parameters of the AssignFont command:


= Equals signseq The control sequence to invoke this commandbank The emulation character bank (0-3)map_table The character map table for the font bank (0-31)

Related commands

MapTable

AttributeEffectThis sequence changes the display of the tagged attribute.

Note: This sequence is obsolete and kept for backward compatibility only. Use ChgTaggedAttrinstead.

Syntax

AttributeEffect effect_list = seq

Parameters

The following table describes the parameters of the AttributeEffect command:


effect_list The effects to change; can be "Normal" or one or more of "Dim," "Bold,""Reverse," "UnderLine," "Flash," or "Secret"


Related commands

ChgTaggedAttr

AttributeModeThis sequence sets how attributes are placed on the screen.

AttributeMode Char

15

This setting is also set by the EmulationMode command.

Syntax

AttributeMode = state

Parameters

The following table describes the parameters of the AttributeMode command:


= Equals signstate The startup attribute state; see the following table

Value for state:

Value Description

Char Each character can have a different attributeLine Attributes continue until the next attribute or the end of the linePage Attributes continue until the next attribute or the end of the pageWrap Attributes continue until the next attribute, wrapping at the end of the pageEmbedded Add this word with Line, Page, or Wrap if the attribute takes up a space on the

screen; this value is the default if not specifiedNonEmbedded Add this word with Line, Page, or Wrap if the attribute does not take up a

space

Related commands

EmulationMode

AttributeMode CharThis command specifies the sequence to change the emulations attributing to character attributing.Each character can have a different attribute.

Syntax

AttributeMode Char [=] seq

Parameters

The following table describes the parameters of the AttributeMode Char command:


= Equals signseq Escape sequence that is received from the host


16

Examples

The following example shows the Wyse 60 sequence to change to character attributing.

AttributeMode Char = "\ee1"

Related commands

AttributeMode, AttributeMode Line, AttributeMode Page, AttributeMode Wrap

AttributeMode LineThis sequence changes the emulation to line attributing, where an attribute continues until the nextattribute or the end of the line.

Syntax

AttributeMode Line [embed] = seq

Parameters

The following table describes the parameters of the AttributeMode Line command:


embed Use the word "Embedded" if an attribute uses a space on the screen. Use theword "NonEmbedded" if an attribute does not use a space on the screen. Thedefault is "Embedded."


Related commands

AttributeMode, AttributeMode Char, AttributeMode Page, AttributeMode Wrap

AttributeMode PageThis sequence changes the emulation to page attributing, where an attribute continues until the nextattribute or the end of the page.

Syntax

AttributeMode Page [embed] = seq

Parameters

The following table describes the parameters of the AttributeMode Page command:



= Equals sign

AttributeMode Wrap

17


seq The control sequence to invoke this command

Related commands

AttributeMode, AttributeMode Char, AttributeMode Line, AttributeMode Wrap

AttributeMode WrapThis sequence changes the emulation to wrap attributing, where an attribute continues until the nextattribute, wrapping around at the end of the page.

Syntax

AttributeMode Wrap [embed] = seq

Parameters

The following table describes the parameters of the AttributeMode Wrap command:




Related commands

AttributeMode, AttributeMode Char, AttributeMode Line, AttributeMode Page

AttributeOffThis sequence turns off the tagged attribute.

Note: This sequence is obsolete and kept for backward compatibility only. Use TaggedAttrOffinstead.

Syntax

AttributeOff [=] seq

Parameters

The following table describes the parameters of the AttributeOff command:




18

Related commands

TaggedAttrOff

AttributeOnThis sequence turns on the tagged attribute. Characters that are written to the screen after thissequence include the tagged attribute.

Note: This sequence is obsolete and kept for backward compatibility only. Use TaggedAttrOninstead.

Syntax

AttributeOn [=] seq

Parameters

The following table describes the parameters of the AttributeOn command:



Related commands

TaggedAttrOn

AutoFFThis sequence causes a home command followed immediately by a clear to end of page commandto act as if a form feed is received. This sequence allows the current screen to be saved in back pagememory when the host does not use a clear screen or form feed sequence.

Syntax

AutoFF [=] flag

Parameters

The following table describes the parameters of the AutoFF command:


= Equals signflag To turn on this feature, use True, Yes, On, or 1. To turn off this feature, use

False, No, Off, or 0.

Related commands

CursorHome, ClearEOP, FormFeed, ClearScreen, EraseScreen, ClearAllUnprotected

AutoScroll

19

AutoScrollThis sequence allows the screen to scroll up when the cursor attempts to move down when at thebottom of the screen.


Syntax

AutoScroll [=] flag

Parameters

The following table describes the parameters of the AutoScroll command:




Related commands

EmulationMode, AutoScrollOn, AutoScrollOff

AutoScrollOffThis sequence disables automatic scrolling. This stops the screen from scrolling when a line feedoccurs at the bottom of the screen, a reverse line feed occurs at the top of the screen, or theScrollUp or ScrollDown sequences are used.

Syntax

AutoScrollOff [=] seq

Parameters

The following table describes the parameters of the AutoScrollOff command:



Related commands

AutoScrollOn, AutoScroll

AutoScrollOnThis sequence enables automatic scrolling when a line feed occurs at the bottom of the screen, areverse line feed occurs at the top of the screen, or the ScrollUp or ScrollDown sequences areused.


20

Syntax

AutoScrollOn [=] seq

Parameters

The following table describes the parameters of the AutoScrollOn command:



Related commands

AutoScrollOff, AutoScroll

AutoWrapThis sequence allows the cursor to go to the start of the next row when the last character in a line iswritten.


Syntax

AutoWrap [=] flag

Parameters

The following table describes the parameters of the AutoWrap command:




Related commands

EmulationMode, AutoWrapOn, AutoWrapOff

AutoWrapOffThis sequence disables auto-wrap so that a character displayed in the last column of the screen doesnot automatically move the cursor to the next line.

Syntax

AutoWrapOff [=] seq

Parameters

The following table describes the parameters of the AutoWrapOff command:

AutoWrapOn

21



Related commands

AutoWrapOn, AutoWrap

AutoWrapOnThis sequence enables autowrap so that a character displayed in the last column of the screenautomatically moves the cursor to the next line.

Syntax

AutoWrapOn [=] seq

Parameters

The following table describes the parameters of the AutoWrapOn command:



Related commands

AutoWrapOff, AutoWrap

BackSpaceThis sequence moves the cursor back, positioning the cursor at the last column of the previous line ifthe cursor is at the beginning of the line.

Syntax

BackSpace [=] seq

Synonyms

BS

Parameters

The following table describes the parameters of the BackSpace command:




22

Related commands

CursorLeft, ForwardSpace, DestructiveBackspace

BackTabThis sequence moves the cursor to a previous tab stop.

For the TVI range of emulations and emulation that specify TVI in the emul parameter, this commandmoves to the beginning of the previous unprotected area of the screen.

Syntax

BackTab [=] seq, [emul]

Parameters

The following table describes the parameters of the BackTab command:


= Equals signseq The control sequence to invoke this command. If this sequence contains a

numeric argument, the number specifies the number of tab stops to go back.emul For non-televideo emulation, this can be set to "TVI" to use the TVI version of

the back tab command.

Related commands

Tab, TabClear, TabClearAll, TabSet

BellThis sequence sounds the bell.

Syntax

Bell [=] seq

Parameters

The following table describes the parameters of the Bell command:



ChangeColorOffThis sequence modifies the behavior of the emulation so that the current write attributes colorcomponent is unaffected by the monochrome AttributeOff sequence.

ChangeColorOn

23

Syntax

ChangeColorOff [=] seq

Parameters

The following table describes the parameters of the ChangeColorOff command:



Related commands

ChangeColorOn

ChangeColorOnThis sequence modifies the behavior of the emulation so the current write attributes color componentis overwritten with the default colors when the monochrome AttributeOff sequence is received.

Syntax

ChangeColorOn [=] seq

Parameters

The following table describes the parameters of the ChangeColorOn command:



Related commands

ChangeColorOff

CharacterMapTableThis sequence is kept for backwards compatibility only. It is identical to using the MapTablecommand for table 0.

Syntax

CharacterMapTable host_char, local_char, [...]

Parameters

The following table describes the parameters of the CharacterMapTable command:


host_char The character received from the host (or sent to the host for characters 32 -255)


24


local_char The character that is displayed locally on the PC... Additional host_char and local_char pairs can be added to the same line

Examples

The following example maps the # symbol to the UK currency symbol.

CharacterMapTable = "#", "\163"

Related commands

MapTable

ChgTaggedAttrThis sequence changes the display of the tagged attribute.

Syntax

ChgTaggedAttr effect_list = seq

Parameters

The following table describes the parameters of the ChgTaggedAttr command:




Related commands

AddTaggedAttr

ClearAllUnprotectedThis sequence clears the unprotected characters on the screen with the current write attribute andmoves the cursor to the first unprotected character.

Syntax

ClearAllUnprotected [=] seq

Parameters

The following table describes the parameters of the ClearAllUnprotected command:


= Equals sign

ClearAOL

25



Related commands

ClearScreen, FormFeed, EraseScreen

ClearAOLThis sequence clears the unprotected characters in the current line.

Syntax

ClearAOL [=] seq

Parameters

The following table describes the parameters of the ClearAOL command:



Related commands

ClearSOL, ClearEOL

ClearEOFThis sequence clears the characters until the end of the current field or the end of the line (whicheveris sooner).

The end of the field is the next protected character.

Syntax

ClearEOF [=] seq

Synonyms

ClearLTP

Parameters

The following table describes the parameters of the ClearEOF command:




26

ClearEOLThis sequence clears the unprotected characters from the current cursor position until the end of theline.

Syntax

ClearEOL [=] seq

Parameters

The following table describes the parameters of the ClearEOL command:



Related commands

ClearAOL, ClearSOL

ClearEOPThis sequence clears the unprotected characters from the current cursor position until the end of thescreen.

Syntax

ClearEOP [=] seq

Parameters

The following table describes the parameters of the ClearEOP command:



Related commands

ClearSOP

ClearScreenThis sequence clears the screen with the current clear attributes.

Syntax

ClearScreen [=] seq

ClearSOL

27

Parameters

The following table describes the parameters of the ClearScreen command:



Related commands

FormFeed, EraseScreen, ClearAllUnprotected

ClearSOLThis sequence clears the screen from the current cursor position to the start of the current line.

Syntax

ClearSOL [=] seq

Parameters

The following table describes the parameters of the ClearSOL command:



Related commands

ClearAOL, ClearEOL

ClearSOPThis sequence clears the screen from the current cursor position to the start of the screen.

Syntax

ClearSOP [=] seq

Parameters

The following table describes the parameters of the ClearSOP command:



Related commands

ClearEOP


28

Color BackThis sequence sets the write attribute background color.

Syntax

Color Back number = seq

Synonyms

Colour Back

Parameters

The following table describes the parameters of the Color Back command:


number The color number that is chosen by this sequence (0 - 15); represents the colorthat is defined in Setup > Colors


Related commands

Color Fore

Color ForeThis sequence sets the write attribute foreground color.

Syntax

Color Fore number = seq

Synonyms

Colour Fore

Parameters

The following table describes the parameters of the Color Fore command:


number The color number that is chosen by this sequence (0 - 15); represents the colorthat is defined in Setup > Colors


Related commands

Color Back

CR

29

CRThis sequence moves the cursor to the beginning of the line.

Syntax

CR [=] seq

Parameters

The following table describes the parameters of the CR command:



CursorCodeThis command sets how following lines in the emulation file decode cursor positioning parameters.

The EmulationMode command automatically sets the correct mode for its emulation; theCursorCode command is only required to override this.

The cursor movement commands can also take an extra parameter that allows the cursor code to beoverridden for just one command.

Syntax

CursorCode [=] mode

Parameters

The following table describes the parameters of the CursorCode command:


= Equals signmode The cursor positioning mode; see the following table

The following table shows the calculations that are made to the parameters in the move sequenceto calculate the row and column. P1 is the first parameter in the escape sequence, p2 is the secondparameter in the sequence, x is the final column, and y is the final row.

Value Description

L y = p1 - 32 and x = p2 - 32A y = p1 - 64 and x = p2. p2 is encoded as binary coded decimalH x = p1 and y = p2S x = p1 - 32 and y = p2 - 32V y = p1 and x = p2. If x or y is greater than zero, their value is decreased by one.D x = p1 and y = p2 where p1 and p2 are encoded as ASCII digits.B y = p1 - 64 and x = p2. p2 is encoded as binary coded decimal, except for

character 128 that is used for column 0.


30

Examples

The following examples show the control sequences generated for the Basic statement “PRINT@(X, Y)” for different CursorCodes.

MoveXY = \eY%f%f %f bytes represent Y&XPRINT @(12,10) returns: (027)Y(042)(044)

CursorCode 'A'

MoveXY = \011%f\016%f %f bytes represent Y&XPRINT @(12,10) returns: (011)(074)(016)(018)

CursorCode 'H'

MoveXY = \e=%f%f %f represent X & YPRINT @(12,10) returns: (027)=(012)(010)

CursorCode 'V'

MoveXY = \e[%v;%vH %v represent Y&XPRINT @(12,10) returns: (027)[13;11H which is the same as: (027)[(049)(052);(049)(049)H

CursorCode 'B'

MoveX = "\016%f" %f byte represent XPRINT @(12) returns: (016)(018)PRINT @(0) returns: (016)(128)PRINT @(1) returns: (016)(001)

Related commands

MoveX, MoveXY, MoveY, EmulationMode

Version

6.2.3 Added cursor code B

CursorDownThis sequence moves the cursor down. The cursor does not move below the bottom scroll row.

Syntax

CursorDown [=] seq

Parameters

The following table describes the parameters of the CursorDown command:


= Equals sign

CursorHome

31


seq The control sequence to invoke this command. If the sequence contains anumeric parameter, this parameter specifies the number of lines to movedown

Examples

The following example moves the cursor down from ANSI emulation.

CursorDown = "\e[%dB"

The following example moves the cursor down from Wyse 50 emulation.

CursorDown = "\022"

Related commands

CursorUp, LineFeed

CursorHomeThis sequence moves the cursor to the home position. The home position is the upper left corner ofthe screen or current scroll area.

If this sequence is used in a TVI emulation or with the emul parameter set to TVI, the cursor is moved tothe first unprotected character after the home position.

Syntax

CursorHome [=] seq, [emul]

Parameters

The following table describes the parameters of the CursorHome command:


= Equals signseq The control sequence to invoke this commandemul The literal "TVI" to use the CursorHome functionality from the TVI emulation

CursorLeftThis sequence moves the cursor left.

Syntax

CursorLeft [=] seq

Parameters

The following table describes the parameters of the CursorLeft command:


32


= Equals signseq The control sequence to invoke this command. If the sequence contains a

numeric parameter, this parameter specifies the number of columns to moveleft

Examples

The following example moves the cursor left from ANSI emulation.

CursorLeft = "\e[%dD"

The following example moves the cursor left from ADDSVP emulation.

CursorLeft = "\021"

Related commands

CursorRight, BackSpace

CursorOffThis sequence hides the cursor.

Syntax

CursorOff [=] seq

Parameters

The following table describes the parameters of the CursorOff command:



Related commands

CursorOn

CursorOnThis sequence redisplays the screen cursor after it has been hidden by the CursorOff sequence.

Syntax

CursorOn [=] seq

Parameters

The following table describes the parameters of the CursorOn command:

CursorRight

33



Related commands

CursorOff

CursorRightThis sequence moves the cursor right.

Syntax

CursorRight [=] seq

Parameters

The following table describes the parameters of the CursorRight command:



numeric parameter, this parameter specifies the number of columns to moveright

Examples

The following example moves the cursor right from ANSI emulation.

CursorRight = "\e[%dC"

The following example moves the cursor right from ADDSVP emulation.

CursorRight = "\006"

Related commands

CursorLeft, ForwardSpace

CursorUpThis sequence moves the cursor up. The cursor does not move above the top scroll row.

Syntax

CursorUp [=] seq

Parameters

The following table describes the parameters of the CursorUp command:


34



numeric parameter, this parameter specifies the number of lines to move up

Examples

The following example moves the cursor up from ANSI emulation.

CursorUp = "\e[%dA"

The following example moves the cursor up from Wyse 50 emulation.

CursorUp = "\011"

Related commands

CursorDown

DelayNewLineThis sequence stops the cursor from auto-wrapping at the end of a line until the next character isreceived. This applies only when the auto-wrap mode is enabled.


Syntax

DelayNewLine [=] flag

Parameters

The following table describes the parameters of the DelayNewLine command:




Related commands

EmulationMode

DeleteCharThis sequence is used to delete one or more characters from the current line.

Syntax

DeleteChar [=] seq

DeleteLine

35

Parameters

The following table describes the parameters of the DeleteChar command:



numeric parameter, this parameter specifies the number of characters todelete

Related commands

InsertChar

DeleteLineThis sequence deletes one or more lines from the current cursor position.

Syntax

DeleteLine [=] seq

Parameters

The following table describes the parameters of the DeleteLine command:



numeric parameter, this parameter specifies the number of lines to delete

Related commands

InsertLine

DestructiveBackspaceThis sequence moves the cursor back and erases any character at the new position. The cursor ispositioned at the last column of the previous line if the cursor is at the beginning of the line.

Syntax

DestructiveBackspace [=] seq

Parameters

The following table describes the parameters of the DestructiveBackspace command:




36

Related commands

BackSpace, CursorLeft

Version

6.3.4 Original version

DisableProtectThis sequence disables protected characters that are enabled with the EnableProtect sequence.When the protect status is disabled, protected characters can be cleared or overwritten.

Syntax

DisableProtect [=] seq

Parameters

The following table describes the parameters of the DisableProtect command:



Related commands

EnableProtect

DisplayCharThis sequence maps an escape sequence from the host to a character on the screen. The characterto be displayed on the screen can be from any of the characters built into the wIntegrate program. Ifyou selected Developer Additions during installation, you can see the available characters by runningthe chrset2.wis script in the C:\Program Files (x86)\wIntegrate\Example\Scriptfolder.

This command replaces the DisplayMap command used previously.

Syntax

DisplayChar [=] seq, char

Parameters

The following table describes the parameters of the DisplayChar command:



DisplayMap

37


char The character to display on the screen from the characters built into thewIntegrate program. Use the format "\cdddd" where dddd is four digits in therange 0000-1023.

Examples

The following is the single-line character mapping from the ADDSVP emulation.

DisplayChar = "\eH:", "\c0256" ;* Single horizontalDisplayChar = "\eH6", "\c0257" ;* Single verticalDisplayChar = "\e1L", "\c0258" ;* Single top leftDisplayChar = "\e1H", "\c0259" ;* Single top rightDisplayChar = "\e1D", "\c0260" ;* Single bottom leftDisplayChar = "\e1@", "\c0261" ;* Single bottom right

Related commands

DisplayChar, DisplayMap, MapTable

DisplayMapThis sequence displays the specified character.

This command has been replaced by the DisplayChar command that allows translation to anycharacter embedded in the wIntegrate program.

Syntax

DisplayMap [=] seq, char

Parameters

The following table describes the parameters of the DisplayMap command:


= Equals signseq The control sequence to invoke this commandchar The character to display

Related commands

MapTable, DisplayMap

DisplayNullsThis sequence allows received character zeroes to be displayed.

If this command is not in the emulation character, zeroes are not displayed.


38

Syntax

DisplayNulls [=] flag

Parameters

The following table describes the parameters of the DisplayNulls command:




DisplayOffThis sequence turns off the screen display. When the display is off, the session shows an empty blackscreen.

The display is turned back on with the DisplayOn sequence.

Syntax

DisplayOff [=] seq

Parameters

The following table describes the parameters of the DisplayOff command:



Related commands

DisplayOn

DisplayOnThis sequence turns on the display after it is hidden by a DisplayOff sequence.

Syntax

DisplayOn [=] seq

Parameters

The following table describes the parameters of the DisplayOn command:



DoubleHeightLineBottom

39

Related commands

DisplayOff

DoubleHeightLineBottomThis sequence changes the current row into double height bottom characters.

Syntax

DoubleHeightLineBottom [=] seq

Parameters

The following table describes the parameters of the DoubleHeightLineBottom command:



Related commands

DoubleHeightLineTop

DoubleHeightLineTopThis sequence changes the current row into double height top characters.

Syntax

DoubleHeightLineTop [=] seq

Parameters

The following table describes the parameters of the DoubleHeightLineTop command:



Related commands

DoubleHeightLineBottom

DoubleSizeLineBottomThis sequence changes the current row into double size bottom characters.

Syntax

DoubleSizeLineBottom [=] seq


40

Parameters

The following table describes the parameters of the DoubleSizeLineBottom command:



Related commands

DoubleSizeLineTop

DoubleSizeLineTopThis sequence changes the current row into double size top characters.

Syntax

DoubleSizeLineTop [=] seq

Parameters

The following table describes the parameters of the DoubleSizeLineTop command:



Related commands

DoubleSizeLineBottom

DoubleWidthLineThis sequence changes the current row into double width characters.

Syntax

DoubleWidthLine [=] seq

Parameters

The following table describes the parameters of the DoubleWidthLine command:



EffectThis sequence changes to the specific write attribute.

Effect All

41

Syntax

Effect effect_list = seq

Parameters

The following table describes the parameters of the Effect command:




Related commands

Effect All

Effect AllThis sequence changes the current write attributes.

The sequence should contain one parameter that is decoded by the current emulation mode toproduce the required effect.

Syntax

Effect All [=] seq, [1]

Parameters

The following table describes the parameters of the Effect All command:


= Equals signseq The control sequence to invoke this command; must contain one parameter

that is decoded to decide which effect to use1 Used to specify an alternative attributing scheme and should only be used

after an Effect ANSI command

Related commands

Effect, Effect ANSI, EmulationMode

Effect ANSIThis sequence defines the effect mode to be ANSI compatible. This is used with the EffectAllsequence to specify how the effect parameters are decoded.

For a list of the ANSI effect codes, see ANSI escape sequences, on page 78.


42

Syntax

Effect ANSI

Related commands

Effect All, Effect Mask, Effect Order

Effect CharacterRangeThis sequence sets the range of characters that change the write attribute. This new attribute isdetermined by the mask that is used in the EffectMask command.


Syntax

Effect CharacterRange [=] lower_char, upper_char

Parameters

The following table describes the parameters of the Effect CharacterRange command:


= Equals signlower_char The effect character at the beginning of the rangeupper_char The effect character at the end of the range

Related commands

EmulationMode, Effect Mask, Effect All

Effect MaskThis sequence defines the effect mode to match each bit of the byte parameter from the EffectAllcommand with an effect.

Syntax

Effect Mask effect_list

Parameters

The following table describes the parameters of the Effect Mask command:


effect_list The list of effects in the order they appear in the byte parameter (first bit0, second bit 1 ... last bit 7). Use the effect names separated by spaces withthe word “unused” placed for any unused bits. The effect names are "Dim,""Bold," "Reverse," "UnderLine," "Flash," or "Secret."

Effect Order

43

Examples

The following example defines the effect sequence for Wyse 50.

Effect Mask Secret Flash Reverse Underline Unused Unused DimEffect All = "\eG%f"

Related commands

Effect All, Effect ANSI, Effect Order, Effect CharacterRange

Effect OrderThis sequence is used with the EffectAll command to define the effect decoding of the parameterso that each effect is a value.

Syntax

Effect Order effect_list

Parameters

The following table describes the parameters of the Effect Order command:


effect_list The list of effects in the order they appear in the byte parameter (first bit0, second bit 1 ... last bit 7). Use the effect names separated by spaces withthe word “unused” placed for any unused bits. The effect names are "Dim,""Bold," "Reverse," "UnderLine," "Flash," or "Secret."

Related commands

Effect All, Effect Mask, Effect ANSI

EffectExtentThis sequence sets how many characters are affected when the current attribute is changed.


Note: This command is obsolete; use the AttributeMode or EmulationMode commandsinstead.

Syntax

EffectExtent extent

Parameters

The following table describes the parameters of the EffectExtent command:


44


extent The extent of the screen that is affected by an attribute change; see thefollowing table

Values for extent:

Value Description

0 The character that is written1 The characters until the next attribute change or the end of the page2 The characters until the next attribute change or the end of the line

Related commands

EmulationMode, AttributeMode

EffectIgnoreBoldThis sequence allows the bold attribute to be treated as an effect or color brightener.

Syntax

EffectIgnoreBold [=] flag

Parameters

The following table describes the parameters of the EffectIgnoreBold command:




EffectIgnoreReverseThis sequence allows the reverse attribute to be treated as an effect or color modifier.

Syntax

EffectIgnoreReverse [=] flag

Parameters

The following table describes the parameters of the EffectIgnoreReverse command:




EmbeddedAttributes

45

EmbeddedAttributesThis sequence specifies whether a change of write attributes uses a space on the screen.


Note: This command is obsolete; use the AttributeMode or EmulationMode commandsinstead.

Syntax

EmbeddedAttributes flag

Parameters

The following table describes the parameters of the EmbeddedAttributes command:


flag To turn on this feature, use True, Yes, On, or 1. To turn off this feature, useFalse, No, Off, or 0.

Related commands

EmulationMode, AttributeMode

EmulationModeThis sequence sets the base mode for the emulation. This defines the initial states and attribute masksfor the emulation.

This command also enables additional and different processing for adding characters to the screenand any command variations necessary.

It should only be used once in an emulation file and placed at, or near to, the beginning of the file.

Syntax

EmulationMode terminal_type

Parameters

The following table describes the parameters of the EmulationMode command:


terminal_type See the following table for the valid terminal types

Values for terminal_type:

Value Description

NONE Basic settings compatible with version 3.x and higherANSI ANSI emulationDG DG413SM SM4407


46

Value Description

PRIME PT250PRISM Prism 9WYSE Wyse 60TVI TVI 955IBM IBM 3151QUME QVT 119AT386 AT386VT100 VT100VT220 VT220VT420 VT420SCOANSI SCO ANSITVI910 TeleVideo 910TVI920 TeleVideo 920TVI925 TeleVideo 925TVI950 TeleVideo 950TVI955 TeleVideo 955TVI965 TeleVideo 965WYSE50 Wyse 50WYSE60 Wyse 60DG413 DG 413PT200 Prime PT200PT250 Prime PT250PRISM5 Prism 5PRISM8 Prism 8PRISM9 Prism 9IBM3151 IBM3151SM4407 SM 4407QVT119 Qume QVT119

EnableProtectThis sequence enables protected characters. When the protected characters are enabled, they cannotbe overwritten or cleared until a DisableProtect sequence is executed.

Syntax

EnableProtect [=] seq

Parameters

The following table describes the parameters of the EnableProtect command:


= Equals sign

EraseCharsInLine

47



Related commands

DisableProtect

EraseCharsInLineThis sequence clears a number of characters from the current cursor position.

Syntax

EraseCharsInLine [=] seq

Parameters

The following table describes the parameters of the EraseCharsInLine command:



numeric parameter, this parameter specifies the number of characters toerase

EraseScreenThis sequence clears the screen and resets all of the attributes and scroll region.

Syntax

EraseScreen = seq

Parameters

The following table describes the parameters of the EraseScreen command:



Related commands

ClearScreen, ClearAllUnprotected, FormFeed

EraseUsingWriteAttrThis sequence uses write attributes instead of erase attributes when erasing.



48

Syntax

EraseUsingWriteAttr [=] flag

Parameters

The following table describes the parameters of the EraseUsingWriteAttr command:




Related commands

EmulationMode

FormFeedThis sequence clears the screen always using the current write attributes.

Syntax

FormFeed [=] seq

Synonyms

FF

Parameters

The following table describes the parameters of the FormFeed command:



Related commands

ClearScreen, ClearAllUnprotected, EraseScreen

ForwardSpaceThis sequence moves the cursor forward. This sequence will move to the next line if auto-wrap is on.

Syntax

ForwardSpace = seq

Parameters

The following table describes the parameters of the ForwardSpace command:

GraphicMapTable

49



numeric parameter, this parameter specifies the number of columns to moveright

Related commands

CursorRight

GraphicMapTableThis sequence is obsolete and kept for backwards compatibility only. It is identical to using theMapTable command for table number 1.

Syntax

GraphicMapTable host_char, local_char, [...]

Parameters

The following table describes the parameters of the GraphicMapTable command:




Related commands

MapTable

GraphicModeOffThis sequence switches the emulation to use map table 0 for its character mapping.

Syntax

GraphicModeOff [=] seq

Parameters

The following table describes the parameters of the GraphicModeOff command:




50

Related commands

GraphicModeOn

GraphicModeOnThis sequence switches the emulation to use map table 1 for its character mapping.

Syntax

GraphicModeOn [=] seq

Parameters

The following table describes the parameters of the GraphicModeOn command:



Related commands

GraphicModeOff

HardResetThis sequence performs a hard reset.

Syntax

HardReset [=] seq

Parameters

The following table describes the parameters of the HardReset command:



Related commands

SoftReset

HostCommandMapCharsThis command controls whether characters in host commands are mapped.

If you are transferring data from the host to PC using WIN.COMSUB, characters are mapped (orchanged) according to any active mapping tables. This is the default behavior.

However, if you are using, for example, the terminal extension for German, then the "\" character isdisplayed as "Ö" (with an umlaut–character 214). This is the correct behavior for on-screen displays,

Ignore

51

but corrupts any commands sent by the host which include the "\" character in folder specifications.In these circumstances, set HostCommandMapChars to "No" to prevent character mapping in hostcommands.

For more information:

▪ see German.wit in C:\Program Files (x86)\wIntegrate\wIntSys\Wit_Ext

▪ run the ChrSet.wis script in C:\Program Files (x86)\wIntegrate\Example\Script

Syntax

HostCommandMapChars = flag

Parameters

The following table describes the parameters of the HostCommandMapChars command:


= Equals signflag To enable this feature, use Yes (the default value if this flag is not specified).

To disable this feature, use No.

IgnoreThis sequence is ignored by the emulation.

Syntax

Ignore [=] seq

Parameters

The following table describes the parameters of the Ignore command:



IgnoreErrorsThis sequence ignores errors on loading WIT files.

The default state is “on” because previous versions of this application did not perform as much syntaxchecking. This allows you to keep the same WIT files between versions even if there are errors in theWIT files.

Syntax

IgnoreErrors [=] flag

Parameters

The following table describes the parameters of the IgnoreErrors command:


52




InsertCharThis sequence inserts one or more spaces at the current cursor position.

Syntax

InsertChar [=] seq

Parameters

The following table describes the parameters of the InsertChar command:



numeric parameter, this parameter specifies the number of spaces to insert

Related commands

DeleteChar

InsertLineThis sequence inserts one or more blank lines at the current cursor position.

Syntax

InsertLine [=] seq

Parameters

The following table describes the parameters of the InsertLine command:



numeric parameter, this parameter specifies the number of lines to insert

Related commands

DeleteLine

InsertModeOffThis sequence turns off insert mode so that characters placed on the screen are overwritten.

InsertModeOn

53

Syntax

InsertModeOff [=] seq

Parameters

The following table describes the parameters of the InsertModeOff command:



Related commands

InsertModeOn

InsertModeOnThis sequence turns on insert mode so that when characters are displayed on the screen, they shiftexisting characters to the right.

Syntax

InsertModeOn [=] seq

Parameters

The following table describes the parameters of the InsertModeOn command:



Related commands

InsertModeOff

Key_This sequence programs a soft key for use with the emulation.

These commands are only executed if the Load Keys check box is selected in Setup > Terminal, or theKey LoadEmulation script command is used.

If the same key is defined twice, for example, in an emulation and in an emulation extension file, thelast definition is used.

Unlike other commands, the state and name parameters are part of the Key_ command name.

Syntax

Key_[state]name [=] value


54

Parameters

The following table describes the parameters of the Key_ command:


state The Shift state for the key. Can be Shift, Ctrl, Alt, or a combination of thethree. These can also be abbreviated to S, C, or A, respectively.

name The name of the key to program. The key name can be found by lookingat the name in the Setup > Keyboard menu option or in the list forSetupKeyboard command in the Client Scripting Reference.

= Equals signvalue The key definition. If this is prefixed with \m. The rest of the value is treated

as script; otherwise the value is sent to the host after being converted frombackslash format.

Examples

The following example definitions are from the key_norm emulation extension that defines keys forscrolling around the back pages.

Key_PageUp = "\mInvoke ScrollPrevPage"Key_PageDown = "\mInvoke ScrollNextpage"Key_UpArrow = "\mInvoke ScrollUpLine"Key_DownArrow = "\mInvoke ScrollDownLine"Key_Control_PageDown = "\mInvoke ScrollBackWidth"Key_Control_PageUp = "\mInvoke ScrollAcrossWidth"Key_End = "\mInvoke ScrollEndPage"Key_Home = "\mInvoke ScrollTopPage"Key_Shift_Insert = "\mInvoke EditPaste"Key_Control_Insert = "\mInvoke EditCopy"

KeyboardLockThis sequence locks the keyboard so that it stops unprogrammed keys from being sent to the host.Instead, a bell is sounded.

Programmed keys such as edit or function keys cannot be locked.

Syntax

KeyboardLock [=] seq

Parameters

The following table describes the parameters of the KeyboardLock command:



Related commands

KeyboardUnlock

KeyboardUnlock

55

KeyboardUnlockThis sequence unlocks the keyboard after it is locked with the KeyboardLock escape sequence.

Syntax

KeyboardUnlock [=] seq

Parameters

The following table describes the parameters of the KeyboardUnlock command:



Related commands

KeyboardLock

LibraryThis sequence loads a script library into memory, allowing the direct use of any subroutines orfunctions as if they are part of the script language.

This is useful as it allows more complicated scripting to be run as part of a TerminalCommandcommand without having to run another script file or specifically include the Library scriptcommand in the TerminalCommand statement. Because the library is cached in memory, it does notneed to be reloaded to be ran, which means it also executes faster.

Syntax

Library [=] filename

Parameters

The following table describes the parameters of the Library command:


= Equals signfilename The name of the script library. If the name consists only of a leaf name, it is

loaded from the wintsys\wit_ext folder. If the name contains a partialpath, it is assumed to be in a subfolder of the folder where the applicationwas installed.

Examples

The following example is a line in the ansi.wit emulation, which includes the library wintsys\wit_ext\Ansiext.wis.

Library = "Ansiext"


56

Related commands

TerminalCommand

LineFeedThis sequence moves the cursor down and scrolls the screen when it reaches the bottom line.

Syntax

LineFeed [=] seq

Synonyms

LF

Parameters

The following table describes the parameters of the LineFeed command:



Related commands

CursorDown

LockShiftGLFontThis sequence selects the emulation character bank to use for the display of 7-bit characters(characters with ASCII codes 32 - 127).

Syntax

LockShiftGLFont [=] seq, bank

Parameters

The following table describes the parameters of the LockShiftGLFont command:


= Equals signseq The control sequence to invoke this commandbank The emulation character bank (0-3)

Related commands

LockShiftGRFont

LockShiftGRFont

57

LockShiftGRFontThis sequence select an emulation (character set) bank to use for 8-bit characters (characters withASCII codes 160 - 255).

Syntax

LockShiftGRFont [=] seq

Parameters

The following table describes the parameters of the LockShiftGRFont command:



Related commands

LockShiftGLFont

MapSequenceThis sequence replaces the specified received characters that are at the beginning of a sequence, andthen passes this on to be interpreted by the emulation.

Syntax

MapSequence [=] seq, new_seq

Parameters

The following table describes the parameters of the MapSequence command:


= Equals signseq The control sequence to invoke this commandnew_seq The replacement start of the sequence

Examples

The following example is a line from the VT100 emulation that converts the 8-bit version of theCommand Sequence Introducer to the 7-bit version. This prevents the need to define each sequencetwice for 7-bit and 8-bit emulation.

MapSequence = "\155", "\e[" ;* CSI


58

MapTableThis sequence sets up character mapping between the characters on the host and the characters fromthe font that are displayed on the screen. For ASCII codes 32-255, the character mapping also convertscharacters that are entered by the keyboard to the value on the host.

The command can be repeated multiple times with each command adding more character mappingsto the specified character mapping table.

Syntax

MapTable [table], host_char, local_char, [...]

Parameters

The following table describes the parameters of the MapTable command:


table The table number to add character mappings to; if omitted, this parameterdefaults to table 0



Examples

The following example maps the English pound currency symbol.

MapTable = "#", "\163"

Related commands

DisplayChar

MarginBellThis sequence is the Margin bell position. If the column is zero, then the margin bell is turned off. Anyother value is taken as the position to sound the bell as the user types a character at this column. Ifthis command is not specified, the margin bell is turned off.

Syntax

MarginBell [=] column

Parameters

The following table describes the parameters of the MarginBell command:


= Equals sign

MarginBellOff

59


column The column position to sound the margin bell; 0 to turn off the margin bell

Related commands

MarginBellOn, MarginBellOff, MarginBellPsn, SetMarginBell

MarginBellOffThis sequence turns off the margin bell.

Syntax

MarginBellOff [=] seq

Parameters

The following table describes the parameters of the MarginBellOff command:



Related commands

MarginBellOn, MarginBellPsn, MarginBell, SetMarginBell

MarginBellOnThis sequence enables the margin bell to sound when a character is typed at the margin bell column.

Syntax

MarginBellOn [=] seq

Parameters

The following table describes the parameters of the MarginBellOn command:



Related commands

MarginBellOff, MarginBellPsn, MarginBell, SetMarginBell

MarginBellPsnThis sequence sets the column for the margin bell.


60

Syntax

MarginBellPsn [=] seq

Parameters

The following table describes the parameters of the MarginBellPsn command:


= Equals signseq The control sequence to invoke this command; must include one numeric

parameter to specify the margin bell column

Related commands

MarginBellOn, MarginBellOff, MarginBell, SetMarginBell

MoveXThis sequence moves the cursor to the specified column position on the current line.

Syntax

MoveX [=] seq, [cursor_code]

Parameters

The following table describes the parameters of the MoveX command:



that is used to specify the column position.cursor_code Specifies how to interpret the parameter. Entered as a CursorCode letter

or an emulation mode name. If this parameter is omitted, the code for theEmulationMode or the last CursorCode command is used.

Related commands

MoveY, MoveXY, CursorCode, EmulationMode

MoveXYThis sequence moves the cursor to the specified line and column.

Syntax

MoveXY [=] seq, [cursor_code]

Parameters

The following table describes the parameters of the MoveXY command:

MoveY

61


= Equals signseq The control sequence to invoke this command; must contain two parameters

to specify the line and column positions.cursor_code Specifies how to interpret the parameter. Entered as a CursorCode letter


Related commands

MoveX, MoveY, CursorCode, EmulationMode

MoveYThis sequence moves the cursor to the specified line without changing the column position.

Syntax

MoveY [=] seq, [cursor_code]

Parameters

The following table describes the parameters of the MoveY command:



that is decoded to specify the line to move to.cursor_code Specifies how to interpret the parameter. Entered as a CursorCode letter


Related commands

MoveX, MoveXY, CursorCode, EmulationMode

NewLineThis sequence moves the cursor to the start of the next line.

Syntax

NewLine [=] seq

Synonyms

NL

Parameters

The following table describes the parameters of the NewLine command:


62



numeric parameter, this parameter specifies the number of lines to movedown

Related commands

LineFeed

NormalVideoThis sequence disables reverse video.

Syntax

NormalVideo [=] seq

Parameters

The following table describes the parameters of the NormalVideo command:



Related commands

ReverseVideo

PrinterIgnoreThis sequence stops the specified characters from being sent to the printer.

Syntax

PrinterIgnore [=] seq

Parameters

The following table describes the parameters of the PrinterIgnore command:



Related commands

PrinterMap

PrinterMap

63

PrinterMapThis command changes a sequence of characters that are sent by the host to a different sequenceduring printing.

This is implemented to allow ANSI-based emulations such as VT100 to throw a new page properlywhen an on-screen report is sent to the printer.

Syntax

PrinterMap [=] seq, printer_seq

Parameters

The following table describes the parameters of the PrinterMap command:


= Equals signseq The control sequence to invoke this commandprinter_seq The sequence of characters to send to the printer

Examples

The following example is from the ANSIprt emulation extension. It ignores the home sequence andmaps ANSI form feeds to ASCII code 12 for printing.

PrinterIgnore = "\e[%aH"PrinterMap = "\e[%dJ", "\012"

Related commands

PrinterIgnore

ProtectEffectThis sequence changes the display of the tagged attribute.

Note: This sequence is obsolete and kept for backward compatibility only. Use ChgTaggedAttrinstead.

Syntax

ProtectEffect effect_list = seq

Parameters

The following table describes the parameters of the ProtectEffect command:



= Equals sign


64



Related commands

ChgTaggedAttr

ProtectFullIntensityThis sequence causes protected characters to be written with normal intensity.

Syntax

ProtectFullIntensity [=] seq

Parameters

The following table describes the parameters of the ProtectFullIntensity command:



Related commands

ProtectHalfIntensity

ProtectHalfIntensityThis sequence causes protected characters to be written using dim intensity.

Syntax

ProtectHalfIntensity [=] seq

Parameters

The following table describes the parameters of the ProtectHalfIntensity command:



Related commands

ProtectFullIntensity

ProtectOffThis sequence turns off the tagged attribute.

ProtectOn

65

Note: This sequence is obsolete and kept for backward compatibility only. Use TaggedAttrOffinstead.

Syntax

ProtectOff [=] seq

Parameters

The following table describes the parameters of the ProtectOff command:



Related commands

TaggedAttrOff

ProtectOnThis sequence turns on the tagged attribute. Characters that are written to the screen after thissequence include the tagged attribute.

Note: This sequence is obsolete and kept for backward compatibility only. Use TaggedAttrOninstead.

Syntax

ProtectOn [=] seq

Parameters

The following table describes the parameters of the ProtectOn command:



Related commands

TaggedAttrOn

ProtectTabThis sequence moves the cursor to the next tab stop unless protect mode is enabled, in which case thecursor is moved to the next unprotected field.


66

Syntax

ProtectTab [=] seq

Parameters

The following table describes the parameters of the ProtectTab command:



Related commands

Tab

RemoveSequenceThis command removes a previously added sequence from an emulation. It is used in emulationextensions to remove an escape sequence from the main emulation file, so it can be replaced withsomething else.

If the sequence is not defined previously, this command does nothing.

Syntax

RemoveSequence [=] seq

Parameters

The following table describes the parameters of the RemoveSequence command:


= Equals signseq The sequence to remove from the emulation

Examples

The following example replaces char 127 with a destructive Backspace.

RemoveSequence = "\127"DestructiveBackspace = "\127"

Version

6.3.4 Original version

RestoreCursorThis sequence restores the cursor to its position and the attributes to their state when the lastSaveCursor sequence was executed.

ReverseLF

67

Syntax

RestoreCursor [=] seq

Parameters

The following table describes the parameters of the RestoreCursor command:



Related commands

SaveCursor

ReverseLFThis sequence moves the cursor up the screen one or more lines, scrolling the screen down if it isalready at the top of the scroll area.

Syntax

ReverseLF [=] seq

Parameters

The following table describes the parameters of the ReverseLF command:



numeric parameter, this parameter specifies the number of lines to move up

Related commands

LineFeed, CursorUp

ReverseNewLineThis sequence moves the cursor up one or more lines and positions the cursor at the left side of theline. If the cursor is already at the top of the scroll area, the scroll area is scrolled down.

Syntax

ReverseNewLine [=] seq

Parameters

The following table describes the parameters of the ReverseNewLine command:


= Equals sign


68


seq The control sequence to invoke this command. If the sequence contains anumeric parameter, this parameter specifies the number of lines to move up

Related commands

NewLine, ReverseLF

ReverseVideoThis sequence reverses the appearance of the screen.

Note: This sequence is not implemented and is ignored.

Syntax

ReverseVideo [=] seq

Parameters

The following table describes the parameters of the ReverseVideo command:



Related commands

NormalVideo

SaveCursorThis sequence saves the cursor position and current attributes. These are then later restored by theRestoreCursor sequence.

Syntax

SaveCursor [=] seq

Parameters

The following table describes the parameters of the SaveCursor command:



Related commands

RestoreCursor

ScrollDown

69

ScrollDownThis sequence scrolls the screen down without changing the cursor position.

Syntax

ScrollDown [=] seq

Parameters

The following table describes the parameters of the ScrollDown command:



numeric parameter, this parameter specifies the number of lines to scrolldown

Related commands

ScrollUp

ScrollUpThis sequence scrolls the screen up without changing the cursor position.

Syntax

ScrollUp [=] seq

Parameters

The following table describes the parameters of the ScrollUp command:



numeric parameter, this parameter specifies the number of lines to scroll up

Related commands

ScrollDown

SetMarginBellThis sequence sets the column that rings the margin bell to the current column.

Syntax

SetMarginBell [=] seq


70

Parameters

The following table describes the parameters of the SetMarginBell command:



Related commands

MarginBellOn, MarginBellOff, MarginBellPsn, MarginBell

SingleLineThis sequence changes the current cursor line to normal characters.

Syntax

SingleLine [=] seq

Parameters

The following table describes the parameters of the SingleLine command:



Related commands

DoubleHeightLineTop, DoubleHeightLineBottom, DoubleSizeLineTop, DoubleSizeLineBottom,DoubleWidthLine

SingleShiftThis sequence sets the bank (character set) for the next 7-bit character (characters with ASCII code 32 -127).

Syntax

SingleShift [=] seq, bank

Parameters

The following table describes the parameters of the SingleShift command:


= Equals signseq The control sequence to invoke this commandbank The emulation character bank (0-3)

SoftReset

71

Related commands

LockShiftGLFont, GraphicModeOn, GraphicModeOff

SoftResetThis sequence performs a soft reset.

Syntax

SoftReset [=] seq

Parameters

The following table describes the parameters of the SoftReset command:



Related commands

HardReset

StartCommandThis sequence specifies a script line to be run when the emulation is first run or when the emulation isreset.

This command can be repeated multiple times to specify multiple script lines to run.

Syntax

StartCommand [=] script

Parameters

The following table describes the parameters of the StartCommand command:


= Equals signscript The script line to execute

TabThis sequence moves the cursor to the next tab stop.

Syntax

Tab [=] seq


72

Parameters

The following table describes the parameters of the Tab command:



Related commands

ProtectTab, TabClear, TabClearAll, TabSet

TabClearThis sequence clears the tab stop at the current column.

Syntax

TabClear [=] seq

Parameters

The following table describes the parameters of the TabClear command:



Related commands

TabSet, TabClearAll, Tab, ProtectTab

TabClearAllThis sequence clears all of the horizontal tab stops.

Syntax

TabClearAll [=] seq

Parameters

The following table describes the parameters of the TabClearAll command:



Related commands

TabClear, TabSet, Tab, ProtectTab

TabSet

73

TabSetThis sequence sets a tab stop at the current cursor position.

Syntax

TabSet [=] seq

Parameters

The following table describes the parameters of the TabSet command:



Related commands

TabClear, TabClearAll, Tab, ProtectTab

TaggedAttrThis sequence sets how the tagged attribute appears on the screen.


Syntax

TaggedAttr [=] effect

Parameters

The following table describes the parameters of the TaggedAttr command:


= Equals signeffect_list The effects to change; can be "Normal" or one or more of "Dim," "Bold,"

"Reverse," "UnderLine," "Flash," or "Secret"

Related commands

EmulationMode

TaggedAttrOffThis sequence turns off the tagged attribute.

Syntax

TaggedAttrOff [=] seq


74

Parameters

The following table describes the parameters of the TaggedAttrOff command:



Related commands

TaggedAttrOn

TaggedAttrOnThis sequence turns on the tagged attribute. Characters that are written to the screen after thissequence include the tagged attribute.

Syntax

TaggedAttrOn [=] seq

Parameters

The following table describes the parameters of the TaggedAttrOn command:



Related commands

TaggedAttrOff

TekGraphicThis sequence puts the emulation into TEK graphics mode, where the following characters andsequences are interpreted as TEK graphic sequences, and draws lines and shapes on the screen.

Syntax

TekGraphic [=] seq

Parameters

The following table describes the parameters of the TekGraphic command:



TelnetTerminal

75

TelnetTerminalThis sequence sets the default telnet terminal type that is used for telnet negotiation. This is the samevalue as seen in the Setup > Communications > Windows Sockets > Telnet > Terminal Type menuoption.

Syntax

TelnetTerminal [=] terminal_type

Parameters

The following table describes the parameters of the TelnetTerminal command:


= Equals signterminal_type Terminal type to use

TermIdThis sequence sends the characters that are specified back to the host when it is received.

Syntax

TermId [=] seq, response

Parameters

The following table describes the parameters of the TermId command:


= Equals signseq The control sequence to invoke this commandresponse The data to send back to the host

TerminalCommandThis sequence executes a script statement when the sequence is received.

Syntax

TerminalCommand [=] seq, script_command, [option]

Parameters

The following table describes the parameters of the TerminalCommand command:


= Equals signseq The control sequence to invoke this command; if parameters are included in

this sequence, they can be passed on to the script command that is run


76


script_command The text of the script command to run; see the following script_commandtable

option Single character option to modify the execution behavior of the command;see the following option table

Values for script_command:

The following values can be placed into the script_command parameter, and are replaced whenthe sequence is received from the host. In the following table, p is the parameter number, and n is anumeric adjustment.

Value Description

%p[+/-n]b Substitute the ASCII code of the byte from the parameter, optionally addingor subtracting n from it.

%pd Substitute the number (ASCII digits) from the parameter.%p[+n]s Substitute the bytes of the parameter, optionally starting from the nth byte%p[+n]f Substitute the bytes of the parameter after converting it to backslash format,

optionally starting from the nth byte.

Values for option:

Value Description

I Immediate. This command executes the script command immediately andcontinues processing the characters received. It should not be used withscripts that multi-task or take a long time to process.

P Execute this command even when terminal command processing is turned offwhen printing.

Examples

The following example runs a script to define the numeric keypad in the VT100 emulation.

TerminalCommand= "\e=","Script 'wintsys\\wit_scr\\vtnumkey',1"

The following example is a command with a parameter substitution to move the cursor on the sameline.

TerminalCommand = "\e[%db", "x=0%1s;if x<1 then x=1;Display AT x-1,Cursor(GET_Y)"

The following example implements printing in the VT100 emulation.

TerminalCommand = "\e[i", "Script 'wintsys\\wit_scr\\PrintScr'"TerminalCommand = "\e[0i", "Script 'wintsys\\wit_scr\\PrintScr'"TerminalCommand = "\e[4i", "Chain 'wintsys\\wit_scr\\printOff'" ,PTerminalCommand = "\e[?4i", "Chain 'wintsys\\wit_scr\\PrintOff'" ,PTerminalCommand = "\e[5i", "Script 'wintsys\\wit_scr\\printOn'"TerminalCommand = "\e[?5i", "Script 'wintsys\\wit_scr\\CopyPrt'"

XoffThis sequence stops data from being sent to the host when Xon is defined.

Xon

77

Normally this is set to \019 if used.

See the Xon entry for when this command should be used.

Syntax

Xoff [=] seq

Parameters

The following table describes the parameters of the Xoff command:



Related commands

Xon

XonThis sequence re-enables the sending of data to the host after it is stopped by the Xoff sequence.

Normally this is set to \017 if used.

Including this sequence disables the software flow control from the serial communications andinstead implements it within the emulation.

This command should only be used if Xon/Xoff cannot be enabled as part of the serialcommunications setup, for example, if the emulation uses the Xon or Xoff characters.

Syntax

Xon [=] seq

Parameters

The following table describes the parameters of the Xon command:



Related commands

Xoff

78

Appendix A: ANSI escape sequencesThe following section provides a reference for the ANSI effect sequences that can be received from thehost.

An emulation specifies that it uses ANSI effects by using the Effect ANSI command followed by anEffect All command to specify the sequence that generates the ANSI effect.

For example, VT100 uses the line Effect All "\e[%am". The %a is a placeholder for the ANSIeffect sequence. To display text as Underline Flash Reverse, the received sequence would be:"\e[4;5;7m".

The ANSI attributes are described in the following table.

Code Effect

0 Normal (turns off all others)1 Bold2 Normal intensity4 Underline5 Flash7 Reverse8 Secret22 Normal intensity24 Underline off25 Flash off27 Reverse off30 Foreground Black31 Foreground Red32 Foreground Green33 Foreground Brown34 Foreground Blue35 Foreground Magenta36 Foreground Cyan37 Foreground Light Gray40 Background Black41 Background Red42 Background Green43 Background Brown44 Background Blue45 Background Magenta46 Background Cyan47 Background Light Gray

79

Appendix B: Receiving long text strings from thehost

This section describes how to receive long strings from the host as part of a custom development.This is discussed in relation to using a serial device connected to the PC. For information oncontrolling a serial device from the host, please see the sample files in folder C:\Program Files(x86)\wIntegrate\Example\SerialControl.

When receiving strings from the host, be aware that the %v command is limited to 230 characters. Itmay be safer to use the scripting command GetFromHost RawData instead.

For example, if you have a serial device connected to the PC, and your host Basic program will neversend more than a dozen characters to the PC to be sent on to the serial device. The following exampleshows how to add a line to an emulation .WIT file (or extension) to receive data encapsulated in acustom escape sequence, beginning <esc>!&3 and ending with a carriage return.

TerminalCommand = "\e!&3%v\r" , "SendDataToCOM1 '%1s'"

%v represents variable length data which is passed to the script function SendDataToCOM1 as astring (%s).

The syntax to begin the script function is:

Sub SendDataToCom1(ReceivedData)If COM1IsConnected Then ;* do something with the data...

If more than 230 characters are received they will be truncated. To receive longer strings, change theemulation .WIT file (or extension) as follows:

TerminalCommand = "\e!&3" , "SendDataToCOM1"

And update the script to receive the data as follows:

Sub SendDataToCom1GetFromHost RawData ReceivedData, 999, "10s", TRUE, CHAR(13)If COM1IsConnected Then ;* do something with the data...

The script now receives the data using the GetFromHost RawData command. In this example upto 999 characters will be captured to the variable ReceivedData.

emulation commands reference - …docs.rocketsoftware.com/nxt/gateway.dll/rkbnew20/wintegrate... ·...

Documents