<![CDATA[
<HTML><HEAD>
<!-- Begin Header Records ========================================== -->
<!-- F:\DCCONN\help\e9gwbase.scr converted by B2H R3.11 (313) (OS2) -->
<!-- on 6 Sep 2007 at 02:16:37 -->
<META HTTP-EQUIV="updated" CONTENT="Fri, 06 Sep 1907 02:16:28">
<META HTTP-EQUIV="review" CONTENT="Sun, 06 Sep 1908 02:16:28">
<META HTTP-EQUIV="expires" CONTENT="Mon, 06 Sep 1909 02:16:28">
</HEAD><BODY BGCOLOR="ffffff">
<!-- End Header Records ============================================ -->
<A NAME=Top_Of_Page></A>
<H1>7524 ETS Reference</H1>
<HR><H2><A NAME=ToC>Table of Contents</A></H2>
<MENU>
<P><B><LI><A NAME=ToC_1 HREF="#Header_1" >7524 Extended Terminal Services / DCConnect Client Technical Reference</A></B>
<P><B><LI><A NAME=ToC_2 HREF="#HDRNOTICES" >Notices</A></B>
<MENU>
<LI><A NAME=ToC_3 HREF="#Header_3" >Trademarks and Service Marks</A>
</MENU>
<P><B><LI><A NAME=ToC_4 HREF="#Header_4" >About this Manual</A></B>
<MENU><MENU>
<LI><A NAME=ToC_5 HREF="#Header_5" >Who Should Read this Manual</A>
<LI><A NAME=ToC_6 HREF="#Header_6" >What You Need to Know to Use This Manual</A>
<LI><A NAME=ToC_7 HREF="#Header_7" >How to Use This Manual</A>
</MENU>
<LI><A NAME=ToC_8 HREF="#Header_8" >What This Manual Contains</A>
<LI><A NAME=ToC_9 HREF="#Header_9" >Related Publications</A>
</MENU></MENU>
<HR><P><I><B><A NAME=ToC_10 HREF="#HDRPART1" >Interface</A></B></I><BR>
<MENU>
<P><B><LI><A NAME=ToC_11 HREF="#HDROVER" >Extended Terminal Services Overview</A></B>
<MENU>
<LI><A NAME=ToC_12 HREF="#Header_12" >Data Flow</A>
</MENU>
<P><B><LI><A NAME=ToC_13 HREF="#HDRINSTALL" >Installing and Downloading the 7524 Extended Terminal Services Flash</A></B>
<MENU>
<LI><A NAME=ToC_14 HREF="#HDRHWSWREQ" >Hardware and Software Requirements</A>
<MENU>
<LI><A NAME=ToC_15 HREF="#HDRHRDWREQ" >Hardware Requirements</A>
<LI><A NAME=ToC_16 HREF="#HDRSFTWREQ" >Software Requirements</A>
</MENU>
<LI><A NAME=ToC_17 HREF="#Header_17" >Installing the 7524 Extended Terminal Services Program</A>
</MENU>
<P><B><LI><A NAME=ToC_18 HREF="#HDRMODES" >Modes of Operation</A></B>
<MENU>
<LI><A NAME=ToC_19 HREF="#Header_19" >Transaction Queue Modes</A>
<MENU>
<LI><A NAME=ToC_20 HREF="#HDRINTER" >Interactive Mode</A>
<LI><A NAME=ToC_21 HREF="#HDRINTBUF" >Interactive/Buffered Mode</A>
<LI><A NAME=ToC_22 HREF="#HDRBMM" >Buffered Mode</A>
</MENU></MENU>
<P><B><LI><A NAME=ToC_26 HREF="#HDRCOMMPRO" >Modified Communications Control Protocol 1283</A></B>
<MENU>
<LI><A NAME=ToC_27 HREF="#Header_27" >Performance Modification for Terminals on an RF or TCP/IP Network</A>
<LI><A NAME=ToC_28 HREF="#Header_28" >Ramifications for the Elimination of Polling</A>
<LI><A NAME=ToC_29 HREF="#Header_29" >Initial File Loading</A>
<LI><A NAME=ToC_30 HREF="#HDRLOGCH" >Logical Channels</A>
<LI><A NAME=ToC_31 HREF="#HDRMSGSQ" >Message Sequence Number</A>
<LI><A NAME=ToC_32 HREF="#HDRMSGLN" >Additional Fields for Stream Sockets</A>
<LI><A NAME=ToC_33 HREF="#Header_33" >Terminal Addressing</A>
<LI><A NAME=ToC_34 HREF="#Header_34" >Modified Packet Formats</A>
<LI><A NAME=ToC_35 HREF="#HDRUNSMF" >Unsolicited Message Flow Control</A>
<LI><A NAME=ToC_36 HREF="#Header_36" >ASCII Characters</A>
<LI><A NAME=ToC_37 HREF="#Header_37" >Control Characters</A>
<LI><A NAME=ToC_38 HREF="#Header_38" >Maximum Message Lengths</A>
<LI><A NAME=ToC_39 HREF="#Header_39" >Command Structure</A>
<LI><A NAME=ToC_40 HREF="#Header_40" >Broadcast Command</A>
<LI><A NAME=ToC_41 HREF="#Header_41" >Checksum Characters</A>
</MENU>
<P><B><LI><A NAME=ToC_42 HREF="#HDRPFTCCC" >DCT Communications Control Commands</A></B>
<MENU>
<LI><A NAME=ToC_43 HREF="#HDRCMDPRI" >Command Processing Rules</A>
<LI><A NAME=ToC_44 HREF="#HDRDETAIL" >DCT Control Command Details</A>
<MENU>
<LI><A NAME=ToC_45 HREF="#HDRCMD0SET" >CMD 0--Reset Terminal</A>
<LI><A NAME=ToC_46 HREF="#HDRCMD1STA" >CMD 1--Transmit Terminal Status to Terminal Server</A>
<LI><A NAME=ToC_47 HREF="#HDRCMD2WRT" >CMD 2--Write to Terminal Display</A>
<LI><A NAME=ToC_48 HREF="#HDRCMD3ROM" >CMD 3--Transmit ROM Microcode Version and Revision to Terminal Server</A>
<LI><A NAME=ToC_49 HREF="#HDRCMD4TIM" >CMD 4--Set Terminal Time and Date</A>
<LI><A NAME=ToC_50 HREF="#HDRCMD5AUD" >CMD 5--Activate Terminal Audible Tone</A>
<LI><A NAME=ToC_51 HREF="#HDRCMD6FEA" >CMD 6--Transmit Terminal Features to Terminal Server</A>
<LI><A NAME=ToC_52 HREF="#HDRCMD7TOD" >CMD 7--Transmit Terminal TOD to Terminal Server</A>
<LI><A NAME=ToC_53 HREF="#HDRCMD8POL" >CMD 8--Specify Current Polled Buffer or File</A>
<LI><A NAME=ToC_54 HREF="#HDRCMD9XTX" >CMD 9x--Terminal Text or Data File Management</A>
<LI><A NAME=ToC_55 HREF="#HDRCMD9AFS" >CMD 9A--Send File Status to Terminal Server</A>
<LI><A NAME=ToC_56 HREF="#HDRCMD9BIN" >CMD 9B--Initialize Specified Text File</A>
<LI><A NAME=ToC_57 HREF="#HDRCMD9CLD" >CMD 9C--Load Text File</A>
<LI><A NAME=ToC_58 HREF="#Header_58" >CMD 9F--Transmit Data File Contents to Terminal Server</A>
<LI><A NAME=ToC_59 HREF="#Header_59" >CMD 9G--Erase Files</A>
<LI><A NAME=ToC_60 HREF="#HDRCMDALIN" >CMD A--Set Terminal In Service or Out of Service</A>
<LI><A NAME=ToC_61 HREF="#HDRCMDALIX" >CMD AnX--Set Unsolicited Transaction Flow Control</A>
<LI><A NAME=ToC_62 HREF="#HDRCMDBPOS" >CMD B--Positive Response from Terminal Server</A>
<LI><A NAME=ToC_63 HREF="#HDRCMDCNEG" >CMD C--Negative Response from Terminal Server</A>
<LI><A NAME=ToC_64 HREF="#HDRCMDDIDC" >CMD D--Initiate Data Collection from Terminal Server</A>
<LI><A NAME=ToC_65 HREF="#HDRCMDFSTO" >CMD F--Storage Query</A>
<LI><A NAME=ToC_66 HREF="#HDRCMDGEVN" >CMD G--Execute Transaction Program in Simulated Mode</A>
<LI><A NAME=ToC_67 HREF="#Header_67" >CMD I--Set User Variable</A>
<LI><A NAME=ToC_68 HREF="#Header_68" >CMD IM--Set Multiple User Variables</A>
<LI><A NAME=ToC_69 HREF="#HDRCMDJ0MB" >CMD J0--Allocate RAM Memory Block</A>
<LI><A NAME=ToC_70 HREF="#HDRCMDJ1LD" >CMD J1--Load Data into Allocated Memory</A>
<LI><A NAME=ToC_71 HREF="#HDRCMDJ2FL" >CMD J2--Force Load Data into Memory</A>
<LI><A NAME=ToC_72 HREF="#HDRCMDJ3SD" >CMD J3--Start Memory Dump</A>
<LI><A NAME=ToC_73 HREF="#HDRCMDJ4HL" >CMD J4--Halt and Wait for Next Command</A>
<LI><A NAME=ToC_74 HREF="#HDRCMDJ5PX" >CMD J5--Start Program Execution</A>
<LI><A NAME=ToC_75 HREF="#HDRCMDJ6ER" >CMD J6--Terminal Error Return (Response Only)</A>
<LI><A NAME=ToC_76 HREF="#HDRCMDJ7NX" >CMD J7--Send Next Data Dump Record</A>
<LI><A NAME=ToC_77 HREF="#HDRCMDJ8UV" >CMD J8--Terminal Unavailable (Response Only)</A>
<LI><A NAME=ToC_78 HREF="#HDRCMDJ9CF" >CMD J9--Configuration Query</A>
<LI><A NAME=ToC_79 HREF="#Header_79" >CMD K--Transaction Release</A>
<LI><A NAME=ToC_80 HREF="#Header_80" >CMD L--Loopback for Communications Verification</A>
<LI><A NAME=ToC_81 HREF="#Header_81" >CMD MA--Request CFR Status</A>
<LI><A NAME=ToC_82 HREF="#Header_82" >CMD MB--Allocate Space for CFR</A>
<LI><A NAME=ToC_83 HREF="#Header_83" >CMD MC--Load CFR Image</A>
<LI><A NAME=ToC_84 HREF="#Header_84" >CMD MD--Start CFR</A>
<LI><A NAME=ToC_85 HREF="#Header_85" >CMD NA--Send Validation File Status to the Host</A>
<LI><A NAME=ToC_86 HREF="#Header_86" >CMD NB--Initialize Specified Validation File</A>
<LI><A NAME=ToC_87 HREF="#Header_87" >CMD NC--Load Validation File</A>
<LI><A NAME=ToC_88 HREF="#Header_88" >CMD ND--Validation File Load Complete</A>
<LI><A NAME=ToC_89 HREF="#Header_89" >CMD O--Write to Display with Attributes</A>
<LI><A NAME=ToC_90 HREF="#Header_90" >CMD Q--Query (Read) User Variable</A>
<LI><A NAME=ToC_91 HREF="#Header_91" >CMD V--Positive or Negative Response to Remote Validation</A>
</MENU></MENU>
<P><B><LI><A NAME=ToC_92 HREF="#HDRPOWERUP" >Powerup and Download Specifications</A></B>
<MENU>
<LI><A NAME=ToC_93 HREF="#Header_93" >7524 Powerup Requirements</A>
<LI><A NAME=ToC_94 HREF="#HDRFILEINT" >Parameter File Initialization Sequence</A>
<LI><A NAME=ToC_95 HREF="#HDRFILEDWN" >Parameter File Download Sequence</A>
<LI><A NAME=ToC_96 HREF="#HDREVFDS" >Extended Validation File Download Sequence</A>
<LI><A NAME=ToC_97 HREF="#HDRCRDS" >CFR File Download Sequence</A>
<MENU>
<LI><A NAME=ToC_98 HREF="#Header_98" >Redownload of a CFR</A>
</MENU></MENU>
<P><B><LI><A NAME=ToC_99 HREF="#HDRVALID" >Validation of Device Input Data</A></B>
<MENU>
<LI><A NAME=ToC_100 HREF="#HDRNUMERIC" >Numeric Data Entry Field</A>
<LI><A NAME=ToC_101 HREF="#HDRALPHANM" >Alphanumeric Data Entry Field</A>
<LI><A NAME=ToC_102 HREF="#HDRVDATA" >Validation of Data Entered</A>
</MENU>
<P><B><LI><A NAME=ToC_103 HREF="#HDRKEYPD" >Keypad Operation</A></B>
<MENU>
<LI><A NAME=ToC_104 HREF="#Header_104" >Keyboard Usage for 7524 Terminals (and their Intermec/Norand equivalents)</A>
<LI><A NAME=ToC_105 HREF="#Header_105" >Keyboard Usage for Terminals Running the DCConnect Client</A>
</MENU>
<P><B><LI><A NAME=ToC_106 HREF="#HDRBADGE" >Badge-Initiated Transactions</A></B>
<P><B><LI><A NAME=ToC_107 HREF="#HDRSTRINGS" >Character String Construction and Manipulation</A></B>
<P><B><LI><A NAME=ToC_108 HREF="#HDRRAMS" >RAM Files</A></B>
<MENU>
<LI><A NAME=ToC_109 HREF="#HDRFILERUL" >General File Rules</A>
<LI><A NAME=ToC_110 HREF="#HDRRAMFILE" >File Descriptions</A>
<MENU>
<LI><A NAME=ToC_111 HREF="#HDRFIL0DSC" >File 0--Terminal Operating Parameters/Program Storage</A>
<LI><A NAME=ToC_115 HREF="#HDRFIL1FCT" >File 1--Fast Clocking Times</A>
<LI><A NAME=ToC_118 HREF="#HDRFIL27US" >Files 2-7--User Validation Files</A>
<LI><A NAME=ToC_119 HREF="#HDRFIL8MSG" >File 8--Message File</A>
<LI><A NAME=ToC_120 HREF="#HDRFUNID" >File 9--Transaction Queue File</A>
<LI><A NAME=ToC_123 HREF="#Header_123" >File c--Custom Function Routine Support</A>
<LI><A NAME=ToC_124 HREF="#Header_124" >File e--Extended Validation Support</A>
</MENU></MENU>
<P><B><LI><A NAME=ToC_125 HREF="#HDRERROR" >Error Reporting</A></B>
<MENU>
<LI><A NAME=ToC_126 HREF="#HDRDEVCERR" >Device Errors and System Software Failures</A>
<LI><A NAME=ToC_127 HREF="#HDRINTFERR" >Interfacing Errors</A>
<LI><A NAME=ToC_128 HREF="#HDRAPLXMPL" >Application Exceptions</A>
<LI><A NAME=ToC_129 HREF="#HDRLOCLERR" >Local Errors</A>
</MENU></MENU>
<HR><P><I><B><A NAME=ToC_130 HREF="#HDRPART2" >C Language Programming for Extended Terminal Services</A></B></I><BR>
<MENU>
<P><B><LI><A NAME=ToC_131 HREF="#HDRCH1" >Introduction to C Programming on terminals running 7524 ETS or the DCConnect Client</A></B>
<MENU>
<LI><A NAME=ToC_132 HREF="#Header_132" >General Requirements</A>
<LI><A NAME=ToC_133 HREF="#Header_133" >Non-Volatile Storage</A>
<LI><A NAME=ToC_134 HREF="#Header_134" >Memory Models</A>
<LI><A NAME=ToC_135 HREF="#Header_135" >Function Prototypes</A>
<LI><A NAME=ToC_136 HREF="#Header_136" >C Library Function Usage</A>
<LI><A NAME=ToC_137 HREF="#Header_137" >Program Development</A>
</MENU>
<P><B><LI><A NAME=ToC_138 HREF="#HDRCFR" >Writing Custom Function Routines</A></B>
<MENU>
<LI><A NAME=ToC_139 HREF="#HDRTOOLS" >CFR Programming Tools</A>
<LI><A NAME=ToC_140 HREF="#Header_140" >CFR Operating Modes</A>
<LI><A NAME=ToC_141 HREF="#Header_141" >Examples of CFR Usage</A>
<MENU>
<LI><A NAME=ToC_142 HREF="#Header_142" >Mode 1 CFRs</A>
<LI><A NAME=ToC_143 HREF="#Header_143" >Mode 2 CFRs</A>
</MENU>
<LI><A NAME=ToC_144 HREF="#Header_144" >Operating with a Mode 1 CFR</A>
<MENU>
<LI><A NAME=ToC_145 HREF="#Header_145" >Calling the CFR</A>
<LI><A NAME=ToC_146 HREF="#Header_146" >CFR APIs to ETS</A>
<LI><A NAME=ToC_147 HREF="#Header_147" >CFR Functions</A>
<LI><A NAME=ToC_148 HREF="#Header_148" >Creating and Sending Transactions</A>
<LI><A NAME=ToC_149 HREF="#Header_149" >Example Mode 1 CFR</A>
</MENU>
<LI><A NAME=ToC_150 HREF="#Header_150" >Operating with a Mode 2 CFR</A>
<MENU>
<LI><A NAME=ToC_151 HREF="#Header_151" >Calling the CFR</A>
<LI><A NAME=ToC_152 HREF="#Header_152" >CFR APIs to ETS</A>
<LI><A NAME=ToC_153 HREF="#Header_153" >CFR Functions</A>
<LI><A NAME=ToC_154 HREF="#HDRM2SEND" >Creating and Sending Transactions</A>
<LI><A NAME=ToC_155 HREF="#Header_155" >Example Mode 2 CFR</A>
</MENU>
<LI><A NAME=ToC_156 HREF="#Header_156" >Power-Failure Recovery Considerations</A>
<LI><A NAME=ToC_157 HREF="#Header_157" >Returning to the Transaction Program</A>
<LI><A NAME=ToC_158 HREF="#Header_158" >Battery Operation Time Considerations</A>
<LI><A NAME=ToC_159 HREF="#Header_159" >Using CFRs Developed for the 7526 and 7527</A>
<LI><A NAME=ToC_160 HREF="#Header_160" >Compiling and Linking a CFR</A>
<MENU>
<LI><A NAME=ToC_161 HREF="#Header_161" >General</A>
<LI><A NAME=ToC_162 HREF="#Header_162" >Required Compiler/Linker</A>
<LI><A NAME=ToC_163 HREF="#Header_163" >Compile Command for IBM C/2</A>
<LI><A NAME=ToC_164 HREF="#Header_164" >Link Command for IBM C/2</A>
<LI><A NAME=ToC_165 HREF="#Header_165" >Compile Command for Borland Turbo C++ 3.0 for DOS</A>
<LI><A NAME=ToC_166 HREF="#Header_166" >Link Command for Borland Turbo C++ 3.0 for DOS</A>
</MENU></MENU>
<P><B><LI><A NAME=ToC_167 HREF="#HDRC9" >Device-level CFR Functions</A></B>
<MENU>
<LI><A NAME=ToC_168 HREF="#HDRC8" >Introduction</A>
<LI><A NAME=ToC_169 HREF="#Header_169" >Summary List of Device-Level CFR functions</A>
<MENU>
<LI><A NAME=ToC_170 HREF="#HDRKBDF" >Keyboard</A>
<LI><A NAME=ToC_171 HREF="#HDRDTF" >Date/Time</A>
<LI><A NAME=ToC_172 HREF="#HDRSIPF" >Sensor Input Ports</A>
<LI><A NAME=ToC_173 HREF="#HDRSPKF" >Speaker</A>
<LI><A NAME=ToC_174 HREF="#HDRDISF" >LCD Display</A>
<LI><A NAME=ToC_175 HREF="#HDRMSF" >General Support</A>
<LI><A NAME=ToC_176 HREF="#Header_176" >Communications Port</A>
<LI><A NAME=ToC_177 HREF="#HDRTMRF" >Timer Support</A>
</MENU>
<LI><A NAME=ToC_178 HREF="#HDRKEY" >Reference - Keyboard</A>
<MENU>
<LI><A NAME=ToC_179 HREF="#Header_179" >KbdReadAscii</A>
<LI><A NAME=ToC_182 HREF="#Header_182" >KbdHandleArrowKeys</A>
</MENU>
<LI><A NAME=ToC_185 HREF="#HDRDATT" >Reference - Date/Time</A>
<MENU>
<LI><A NAME=ToC_186 HREF="#Header_186" >RtcGetAsciiDate</A>
<LI><A NAME=ToC_189 HREF="#Header_189" >RtcGetAsciiTime</A>
<LI><A NAME=ToC_192 HREF="#Header_192" >RtcGetDate</A>
<LI><A NAME=ToC_195 HREF="#Header_195" >RtcGetTime</A>
</MENU>
<LI><A NAME=ToC_198 HREF="#HDRSIP" >Reference - Sensor Input Ports</A>
<MENU>
<LI><A NAME=ToC_199 HREF="#Header_199" >SenActLed</A>
<LI><A NAME=ToC_202 HREF="#Header_202" >SenPower</A>
<LI><A NAME=ToC_205 HREF="#Header_205" >SenQueryData</A>
<LI><A NAME=ToC_208 HREF="#Header_208" >SenRead</A>
</MENU>
<LI><A NAME=ToC_211 HREF="#HDRTRANS" >Reference - Beeper</A>
<MENU>
<LI><A NAME=ToC_212 HREF="#Header_212" >SpkBeep</A>
<LI><A NAME=ToC_215 HREF="#Header_215" >SpkQuery</A>
</MENU>
<LI><A NAME=ToC_217 HREF="#HDRLCDD" >Reference - LCD Displays</A>
<MENU>
<LI><A NAME=ToC_218 HREF="#Header_218" >VioClear</A>
<LI><A NAME=ToC_220 HREF="#Header_220" >VioGetCurPos</A>
<LI><A NAME=ToC_223 HREF="#Header_223" >VioQuery</A>
<LI><A NAME=ToC_226 HREF="#Header_226" >VioReadCell</A>
<LI><A NAME=ToC_229 HREF="#Header_229" >VioReadCellStr</A>
<LI><A NAME=ToC_232 HREF="#Header_232" >VioReadChar</A>
<LI><A NAME=ToC_235 HREF="#Header_235" >VioReadCharStr</A>
<LI><A NAME=ToC_238 HREF="#Header_238" >VioSetCurPos</A>
<LI><A NAME=ToC_241 HREF="#Header_241" >VioSetCurType</A>
<LI><A NAME=ToC_244 HREF="#Header_244" >VioWrtCellString</A>
<LI><A NAME=ToC_247 HREF="#Header_247" >VioWrtCharStr</A>
<LI><A NAME=ToC_250 HREF="#Header_250" >VioWrtCharStrAtt</A>
<LI><A NAME=ToC_253 HREF="#Header_253" >VioWrtNCell</A>
<LI><A NAME=ToC_256 HREF="#Header_256" >VioWrtNChar</A>
</MENU>
<LI><A NAME=ToC_259 HREF="#HDRGSPT" >Reference - General Support</A>
<MENU>
<LI><A NAME=ToC_260 HREF="#Header_260" >HitWatchdog</A>
</MENU>
<LI><A NAME=ToC_261 HREF="#HDRCPREF" >Reference - Communications Port</A>
<MENU>
<LI><A NAME=ToC_262 HREF="#Header_262" >ComGetParms</A>
<LI><A NAME=ToC_265 HREF="#Header_265" >ComGetProtocol</A>
<LI><A NAME=ToC_268 HREF="#Header_268" >ComQuery</A>
<LI><A NAME=ToC_270 HREF="#Header_270" >ComQueryData</A>
<LI><A NAME=ToC_273 HREF="#Header_273" >ComRead</A>
<LI><A NAME=ToC_276 HREF="#Header_276" >ComSetMdmCtl</A>
<LI><A NAME=ToC_279 HREF="#HDRCSETP" >ComSetParms</A>
<LI><A NAME=ToC_282 HREF="#Header_282" >ComWrite</A>
</MENU>
<LI><A NAME=ToC_285 HREF="#HDRTMRSPT" >Reference - Timer functions</A>
<MENU>
<LI><A NAME=ToC_286 HREF="#Header_286" >TimerSetAlarm</A>
<LI><A NAME=ToC_290 HREF="#Header_290" >TimerClearAlarm</A>
<LI><A NAME=ToC_292 HREF="#Header_292" >TimerSetInterval</A>
<LI><A NAME=ToC_296 HREF="#Header_296" >TimerClearInterval</A>
</MENU></MENU>
<P><B><LI><A NAME=ToC_298 HREF="#HDRAPICFR" >Application-level CFR APIs</A></B>
<MENU>
<LI><A NAME=ToC_299 HREF="#Header_299" >Summary of Application-level CFR APIs</A>
<LI><A NAME=ToC_300 HREF="#Header_300" >Summary of Return Codes</A>
<LI><A NAME=ToC_301 HREF="#Header_301" >Application-level CFR API Reference</A>
<MENU>
<LI><A NAME=ToC_302 HREF="#HDRATID" >AliasTransID</A>
<LI><A NAME=ToC_308 HREF="#HDRCKD" >CallKeyDef</A>
<LI><A NAME=ToC_314 HREF="#Header_314" >ClearUserVariable</A>
<LI><A NAME=ToC_320 HREF="#Header_320" >DataFile</A>
<LI><A NAME=ToC_326 HREF="#Header_326" >GetPowerState</A>
<LI><A NAME=ToC_331 HREF="#Header_331" >GetTerminalAddress</A>
<LI><A NAME=ToC_336 HREF="#Header_336" >GetTerminalSettings</A>
<LI><A NAME=ToC_341 HREF="#Header_341" >IdleManager</A>
<LI><A NAME=ToC_346 HREF="#Header_346" >MaxMemory</A>
<LI><A NAME=ToC_352 HREF="#Header_352" >PntrFile0</A>
<LI><A NAME=ToC_357 HREF="#Header_357" >QueryTransactionCnt</A>
<LI><A NAME=ToC_363 HREF="#Header_363" >ReadUserVariable</A>
<LI><A NAME=ToC_369 HREF="#Header_369" >ResizeFile</A>
<LI><A NAME=ToC_371 HREF="#Header_371" >SendTransaction</A>
<LI><A NAME=ToC_377 HREF="#Header_377" >TransactionMsg</A>
<LI><A NAME=ToC_383 HREF="#Header_383" >Validation</A>
<LI><A NAME=ToC_389 HREF="#HDRWTEVNT" >WaitEvent</A>
<LI><A NAME=ToC_395 HREF="#Header_395" >WriteToTrans</A>
<LI><A NAME=ToC_401 HREF="#Header_401" >WriteUserVariable</A>
</MENU></MENU>
<P><B><LI><A NAME=ToC_407 HREF="#HDRKEYALLW" >Command and Special Key Relationships</A></B>
<P><B><LI><A NAME=ToC_408 HREF="#HDRCRLC" >Comparison of ETS, 7526, 7527 Command Capabilities</A></B>
<P><B><LI><A NAME=ToC_409 HREF="#HDRGLO" >Terms and Abbreviations</A></B>
</MENU><HR><P>
</B><BR>
<B>
<B><P></B><BR>
<B><H1><A NAME="Header_1" HREF="#ToC_1">7524 Extended Terminal Services / DCConnect Client Technical Reference</A></H1></B><BR>
<B>PLANT FLOOR SERIES</B><BR>
<B>Data Collection Edition</B><BR>
<P>
7524 Extended Terminal Services / DCConnect Client<BR>
Technical Reference<BR>
<P> Release 1.03<P>
<P>SC28-9750-01<P>
<BR>
<TABLE BORDER WIDTH=100%><TR><TH ALIGN=LEFT>Note!</TH><TR><TD>
<P>Before using this information and the product it supports,
be sure to read the general information.
(<A HREF="#HDRNOTICES">Notices</A>)
</TD></TR></TABLE>
<P><B>Fourth Edition, November 2005</B>
<P>This edition applies to Release 2.2.0 of the DCConnect Client and
to all subsequent versions and releases until otherwise indicated in
new editions. Make sure you are using the correct edition for the
level of the product.
<P>Order publications through your IBM representative or the IBM
branch office serving your locality.
Publications are not stocked at the address below.
<P>A form for reader's comments is provided at the back
of this publication. If the form has been removed,
address comments to:
<DL COMPACT>
<DD>IBM Corporation
<DD>Department 27X
<DD>P. O. Box 1328,
<DD>Boca Raton, Florida 33429-1328 U.S.A.
</DL>
<P>
When you send information to IBM, you grant IBM a nonexclusive right
to use or distribute the information in any
way it believes appropriate without incurring any
obligation to you.
<P>Note to US Government users--Documentation related to
restricted rights--Use, duplication, or disclosure is subject
to restrictions set forth in GSA ADP Schedule Contract with IBM
Corp.
<HR>
<H1><A NAME="HDRNOTICES" HREF="#ToC_2">Notices</A></H1>
<P>References in this publication to IBM products, programs,
or services do not imply that IBM intends to
make these available in all countries in which IBM
operates.
Any reference to an IBM product, program, or service is
not intended to state or imply that only IBM's product, program, or
service may be used.
Any functionally equivalent product, program, or service
that does not infringe any
of IBM's intellectual property rights may be used instead of the IBM
product, program, or service.
Evaluation and verification of operation in conjunction
with other products, except those expressly designated by IBM,
is the user's responsibility.
<P>
IBM may have patents or pending patent applications covering
subject matter in this document. The furnishing of this document
does not give you any license to these patents. You can send license
inquiries, in writing, to the IBM Director of Commercial Relations,
IBM Corporation, Purchase, NY 10577.
<HR>
<H2><A NAME="Header_3" HREF="#ToC_3">Trademarks and Service Marks</A></H2>
<P>The following terms, <B>which are denoted by an asterisk (*) in
this publication</B>,
are trademarks or service marks of IBM Corporation
in the United States and/or other countries:
<PRE>
IBM PLANT FLOOR SERIES
OS/2 AS/400
System/36 System/38
Proprinter Data Collection Edition
Quickwriter
</PRE>
<P>The following terms, <B>which are denoted by a double asterisk (**) in
this publication</B>, are trademarks of other companies as follows:
<PRE>
Code 39 Interface Mechanisms, Inc.
Microsoft Microsoft Corporation
</PRE>
<HR>
<H1><A NAME="Header_4" HREF="#ToC_4">About this Manual</A></H1>
<P>This manual was originally written in 1995 for the 7524 Extended Terminal
Services (ETS) program that can be flashed into IBM 7524 terminals (or their
Intermec/Norand equivalents). In 1997, a product called 752x Emulator for DOS
was created by IBM that was based on the same code as the 7524 ETS flash. The
752x Emulator for DOS was written to support various models of terminals from
Intermec, Symbol and Telxon. Then in 2000, support was added for several
Windows platforms and the 752x Emulator for DOS was renamed to DCConnect Client.
<P>
Because much of the source code the 7524 ETS flash and the DCConnect Client is
the same, much of the discussion in this manual applies to both products.
Therefore any reference to "ETS" or "Extended Terminal Services" applies to
both products - unless explicitly stated otherwise.
<P>
The DCConnect Client has a separate manual, in HTML format, that describes
how to install and configure the product - which can vary greatly depending on
the device or platform one which it is running. That document is available
from our website:
<PRE>
http://www.ibm.com/software/data/dcconnect
</PRE>
<P>
Follow the link to "Library" and then "DCConnect Client User's Guide".
<P>
The Extended Terminal Services Technical Reference
is divided into three parts:
<UL>
<P><LI>Part 1. Interface
<P>This part describes the interface for and
provides guidance during the planning
of the Extended Terminal Services (ETS) program for
a data collection terminal. It discusses all aspects of how an application
on a terminal server
interfaces to the Extended Terminal Services
command set, file structures, and transaction programming.
<P><LI>Part 2. C Programming for Extended Terminal Services
<P>This part is for the programmer who plans to use C language to enhance
the functionality of transaction programs that run on the terminal.
<P><LI>Part 3. Appendixes
<P>This part provides supplemental information for use
in conjunction with the other two parts.
</UL>
<P>
<H3><A NAME="Header_5" HREF="#ToC_5">Who Should Read this Manual</A></H3>
<P>Part 1
is intended for installers, programmer/analysts, and
other technical personnel who work with the IBM* 7524 DCT or any terminal/
platform supported by the DCConnect Client.
<P>
Part 2 provides technical reference material for the programmer or
other technical person who will be writing C language
programs for use with ETS.
<P>
<H3><A NAME="Header_6" HREF="#ToC_6">What You Need to Know to Use This Manual</A></H3>
<P>In addition to having a general knowledge of data processing,
to use part 1 it would be helpful to be familiar with the following:
<UL COMPACT>
<LI>IBM 7524 Data Collection Terminal or other data collection terminal
supported by the DCConnect Client
<LI>IBM DOS*, version 3.3 or higher
<LI>IBM OS/2*, version 1.3 or higher
<LI>IBM personal computers (PCs), Personal System/2*,
or industrial computers.
</UL>
<P>To use part 2, you should have experience in writing programs
using C language.
<P>
<H3><A NAME="Header_7" HREF="#ToC_7">How to Use This Manual</A></H3>
<P>Review this document thoroughly before attempting to perform the
described activities. Complete each step in the order given
wherever a sequence of steps is specified, and do not skip any steps
unless they are designated as optional. Otherwise, the activity may
not be successfully completed, and errors may occur.
<HR>
<H2><A NAME="Header_8" HREF="#ToC_8">What This Manual Contains</A></H2>
<P>Part 1 contains a general description of the Extended Terminal Services
program and detailed information about the following items:
<UL>
<P><LI>For a general overview of the Extended Terminal Services
program,
(See<A HREF="#HDROVER">Extended Terminal Services Overview</A>) .
<P><LI>For a discussion about
installing and downloading the 7524 Extended Terminal Services flash
(See<A HREF="#HDRINSTALL">Installing and Downloading the 7524 Extended Terminal Services Flash</A>)
<P><LI>For a description of the various
modes of operation of the Extended Terminal Services program,
(See<A HREF="#HDRMODES">Modes of Operation</A>)
<P><LI>For a specification of the
communications control protocol used by the Extended Terminal Services
program and outline of the control command structures, control
characters, and communications symbols,
(See<A HREF="#HDRCOMMPRO">Modified Communications Control Protocol 1283</A>)
<P><LI>For details of the communications control commands,
(See<A HREF="#HDRPFTCCC">DCT Communications Control Commands</A>)
<P><LI>For a discusion of power-up requirements
and download sequences for ETS and parameter files,
(See<A HREF="#HDRPOWERUP">Powerup and Download Specifications</A>)
<P><LI>For a description of data entry requirements and a
description input data validation,
(See<A HREF="#HDRVALID">Validation of Device Input Data</A>)
<P><LI>For an explanation of how terminal modes affect keypad operation,
(See<A HREF="#HDRKEYPD">Keypad Operation</A>)
<P><LI>For information about badge-initiated transactions,
(See<A HREF="#HDRBADGE">Badge-Initiated Transactions</A>)
<P><LI>For information about the requirements for
character string construction and manipulation,
(See<A HREF="#HDRSTRINGS">Character String Construction and Manipulation</A>)
<P><LI>For the information about the rules for initializing and
processing Random-Access Memory (RAM) files,
(See<A HREF="#HDRRAMS">RAM Files</A>)
<P><LI>For information about ETS's error reporting capabilities and a
description of the types of errors that can occur in ETS,
(See<A HREF="#HDRERROR">Error Reporting</A>)
</UL>
<P>
Part 2 provides technical reference material for writing C language
programs for use with the Extended Terminal Services. These C programs
may be developed for use either as complete terminal application
programs (TAPs), or as Custom Function Routines (CFRs) for use with
transaction programs.
<UL>
<P><LI>For a discussion of the concepts of C programming on the terminal, its powers
and limitations, and how it differs from programming on a personal
computer,
(See<A HREF="#HDRCH1">Introduction to C Programming on terminals running 7524 ETS or the DCConnect Client</A>)
<P><LI>For information on what a CFR can do, and how they are written,
(See<A HREF="#HDRCFR">Writing Custom Function Routines</A>)
You should focus on this chapter if you are using the Extended Terminal
Services program as the terminal application program
on the terminal, and you wish to create user extensions to or front-ends
to customize its operation.
<P><LI>For a summary of ETS's Device-level callable program functions,
followed by the detailed reference material,
(See<A HREF="#HDRC9">Device-level CFR Functions</A>)
This material is applicable to writing Custom Function Routine programs.
<P><LI>For detailed reference material for the Application-level APIs
between ETS and a Custom Function Routine.
(See<A HREF="#HDRAPICFR">Application-level CFR APIs</A>)
these APIs are related to interactions between your CFR and your
downloaded transaction program commands instead of devices.
</UL>
<P>The appendixes contain information regarding:
<UL>
<P><LI>Command and special key relationships
<P><LI>How RS-232 communications parameters affect READ command operations
<P><LI>How terminal states affect terminal server command processing
<P><LI>Comparison of command set available on the various IBM 752x Data Collection
Terminal products.
<P><LI>Data Collection Terminal default device states
</UL>
<HR>
<H2><A NAME="Header_9" HREF="#ToC_9">Related Publications</A></H2>
<P>The following publications are available for the IBM 7524 Data
Collection Terminal:
<UL>
<P><LI>
The <CITE>IBM 7524 Radio Frequency Terminal
User's Guide</CITE>
manual is shipped with each 7524 terminal. There are 3 versions of this
manual:
<DL>
<DD><P>Model 101/102 handheld portable terminal
<DD><P>Model 201 UHF mobile mount terminal
<DD><P>Model 202 SST mobile mount terminal
</DL>
<P><LI>User's Guides for the 7524-301 and -302 RF controllers, 7524-401, -402,
and -422 RF bases, and 7524-310 RS-485 LAN repeater, all of which come
with their respective products.
<P><LI>
<CITE>IBM 7524 Spread Spectrum Technology Wireless Data Network Fixed End
Theory of Operation</CITE> provides a technical description of the
operation, planning, and installation of a special-purpose, high-speed
RS-485 local area network for communication between IBM 7524 radio
frequency controllers and radio base stations.
</UL>
The following publications are available for the
Data Collection Control/2 (DCC/2) program product:
<UL>
<P><LI>
The <CITE>Data Collection Control/2 Installation and Users Guide
</CITE>, which includes material on
creating the files used in the 7524 or equivalent terminal using graphical
user interface configuration and programing tools,
configuring the system for loading of files to the terminals, including
your CFRs, to the desired terminals.
<P><LI>
The <CITE>Data Collection Control/2 32-Bit Runtime Modules User's
Guide and Technical Reference</CITE>,
which provides information on the installation and use of the
32-bit run-time
DCC/2 environment option which is required when using 7524 terminals
with DCC/2. This manual also includes information on the 32-bit
API that can be used by your 32-bit
OS/2 applications to interface with DCC/2.
<P><LI>
The <CITE>7524 Interface Support for OS/2
Installation and Users Guide</CITE>,
which includes information about using the
7524 Interface Support program to
connect DCC/2 to the 7524 radio frequency system.
<P><LI>
The <CITE>Data Collection Control/2 Technical Reference</CITE> manual,
which gives detailed information on the 16-bit
application program interface
between DCC/2 and your OS/2 applications.
Using these 16-bit APIs, your
terminal server applications can interact with
the 7524 transaction programs and your CFRs.
</UL>
<P>
Publications for the Data Collection Connection (DCConnect) / ERPBridge family
of products are in softcopy format and they are available from
out website:
<PRE>
http://www.ibm.com/software/data/dcconnect
</PRE>
Follow the link to "Library". Among the publications you can find are:
<UL>
<P><LI>7524 Interface Support User's Guide
<P><LI>Data Collection Transaction Building Tool
<P><LI>DCConnect Client User's Guide
<P><LI>DCConnect General Information Manual
<P><LI>DCConnect Technical Reference
<P><LI>DCConnect User's Guide
<P><LI>Transaction Connection Series User's Guide & Reference
</UL>
<HR>
<H1><A NAME="HDRPART1" HREF="#ToC_10">Interface</A></H1>
<P><A NAME="PToC1" HREF="#ToC">Partial Table-of-Contents</A>
<MENU>
<P><B><LI><A NAME=PToC_11 HREF="#HDROVER" >Extended Terminal Services Overview</A></B>
<MENU>
<LI><A NAME=PToC_12 HREF="#Header_12" >Data Flow</A>
</MENU>
<P><B><LI><A NAME=PToC_13 HREF="#HDRINSTALL" >Installing and Downloading the 7524 Extended Terminal Services Flash</A></B>
<MENU>
<LI><A NAME=PToC_14 HREF="#HDRHWSWREQ" >Hardware and Software Requirements</A>
<MENU>
<LI><A NAME=PToC_15 HREF="#HDRHRDWREQ" >Hardware Requirements</A>
<LI><A NAME=PToC_16 HREF="#HDRSFTWREQ" >Software Requirements</A>
</MENU>
<LI><A NAME=PToC_17 HREF="#Header_17" >Installing the 7524 Extended Terminal Services Program</A>
</MENU>
<P><B><LI><A NAME=PToC_18 HREF="#HDRMODES" >Modes of Operation</A></B>
<MENU>
<LI><A NAME=PToC_19 HREF="#Header_19" >Transaction Queue Modes</A>
<MENU>
<LI><A NAME=PToC_20 HREF="#HDRINTER" >Interactive Mode</A>
<LI><A NAME=PToC_21 HREF="#HDRINTBUF" >Interactive/Buffered Mode</A>
<LI><A NAME=PToC_22 HREF="#HDRBMM" >Buffered Mode</A>
<MENU>
<LI><A NAME=PToC_23 HREF="#HDRBM" >Buffered Mode for Networked Terminals</A>
<LI><A NAME=PToC_24 HREF="#Header_24" >Buffered Mode for Batch Terminals</A>
<LI><A NAME=PToC_25 HREF="#Header_25" >Buffer (Queue) Full Condition</A>
</MENU></MENU></MENU>
<P><B><LI><A NAME=PToC_26 HREF="#HDRCOMMPRO" >Modified Communications Control Protocol 1283</A></B>
<MENU>
<LI><A NAME=PToC_27 HREF="#Header_27" >Performance Modification for Terminals on an RF or TCP/IP Network</A>
<LI><A NAME=PToC_28 HREF="#Header_28" >Ramifications for the Elimination of Polling</A>
<LI><A NAME=PToC_29 HREF="#Header_29" >Initial File Loading</A>
<LI><A NAME=PToC_30 HREF="#HDRLOGCH" >Logical Channels</A>
<LI><A NAME=PToC_31 HREF="#HDRMSGSQ" >Message Sequence Number</A>
<LI><A NAME=PToC_32 HREF="#HDRMSGLN" >Additional Fields for Stream Sockets</A>
<LI><A NAME=PToC_33 HREF="#Header_33" >Terminal Addressing</A>
<LI><A NAME=PToC_34 HREF="#Header_34" >Modified Packet Formats</A>
<LI><A NAME=PToC_35 HREF="#HDRUNSMF" >Unsolicited Message Flow Control</A>
<LI><A NAME=PToC_36 HREF="#Header_36" >ASCII Characters</A>
<LI><A NAME=PToC_37 HREF="#Header_37" >Control Characters</A>
<LI><A NAME=PToC_38 HREF="#Header_38" >Maximum Message Lengths</A>
<LI><A NAME=PToC_39 HREF="#Header_39" >Command Structure</A>
<LI><A NAME=PToC_40 HREF="#Header_40" >Broadcast Command</A>
<LI><A NAME=PToC_41 HREF="#Header_41" >Checksum Characters</A>
</MENU>
<P><B><LI><A NAME=PToC_42 HREF="#HDRPFTCCC" >DCT Communications Control Commands</A></B>
<MENU>
<LI><A NAME=PToC_43 HREF="#HDRCMDPRI" >Command Processing Rules</A>
<LI><A NAME=PToC_44 HREF="#HDRDETAIL" >DCT Control Command Details</A>
<MENU>
<LI><A NAME=PToC_45 HREF="#HDRCMD0SET" >CMD 0--Reset Terminal</A>
<LI><A NAME=PToC_46 HREF="#HDRCMD1STA" >CMD 1--Transmit Terminal Status to Terminal Server</A>
<LI><A NAME=PToC_47 HREF="#HDRCMD2WRT" >CMD 2--Write to Terminal Display</A>
<LI><A NAME=PToC_48 HREF="#HDRCMD3ROM" >CMD 3--Transmit ROM Microcode Version and Revision to Terminal Server</A>
<LI><A NAME=PToC_49 HREF="#HDRCMD4TIM" >CMD 4--Set Terminal Time and Date</A>
<LI><A NAME=PToC_50 HREF="#HDRCMD5AUD" >CMD 5--Activate Terminal Audible Tone</A>
<LI><A NAME=PToC_51 HREF="#HDRCMD6FEA" >CMD 6--Transmit Terminal Features to Terminal Server</A>
<LI><A NAME=PToC_52 HREF="#HDRCMD7TOD" >CMD 7--Transmit Terminal TOD to Terminal Server</A>
<LI><A NAME=PToC_53 HREF="#HDRCMD8POL" >CMD 8--Specify Current Polled Buffer or File</A>
<LI><A NAME=PToC_54 HREF="#HDRCMD9XTX" >CMD 9x--Terminal Text or Data File Management</A>
<LI><A NAME=PToC_55 HREF="#HDRCMD9AFS" >CMD 9A--Send File Status to Terminal Server</A>
<LI><A NAME=PToC_56 HREF="#HDRCMD9BIN" >CMD 9B--Initialize Specified Text File</A>
<LI><A NAME=PToC_57 HREF="#HDRCMD9CLD" >CMD 9C--Load Text File</A>
<LI><A NAME=PToC_58 HREF="#Header_58" >CMD 9F--Transmit Data File Contents to Terminal Server</A>
<LI><A NAME=PToC_59 HREF="#Header_59" >CMD 9G--Erase Files</A>
<LI><A NAME=PToC_60 HREF="#HDRCMDALIN" >CMD A--Set Terminal In Service or Out of Service</A>
<LI><A NAME=PToC_61 HREF="#HDRCMDALIX" >CMD AnX--Set Unsolicited Transaction Flow Control</A>
<LI><A NAME=PToC_62 HREF="#HDRCMDBPOS" >CMD B--Positive Response from Terminal Server</A>
<LI><A NAME=PToC_63 HREF="#HDRCMDCNEG" >CMD C--Negative Response from Terminal Server</A>
<LI><A NAME=PToC_64 HREF="#HDRCMDDIDC" >CMD D--Initiate Data Collection from Terminal Server</A>
<LI><A NAME=PToC_65 HREF="#HDRCMDFSTO" >CMD F--Storage Query</A>
<LI><A NAME=PToC_66 HREF="#HDRCMDGEVN" >CMD G--Execute Transaction Program in Simulated Mode</A>
<LI><A NAME=PToC_67 HREF="#Header_67" >CMD I--Set User Variable</A>
<LI><A NAME=PToC_68 HREF="#Header_68" >CMD IM--Set Multiple User Variables</A>
<LI><A NAME=PToC_69 HREF="#HDRCMDJ0MB" >CMD J0--Allocate RAM Memory Block</A>
<LI><A NAME=PToC_70 HREF="#HDRCMDJ1LD" >CMD J1--Load Data into Allocated Memory</A>
<LI><A NAME=PToC_71 HREF="#HDRCMDJ2FL" >CMD J2--Force Load Data into Memory</A>
<LI><A NAME=PToC_72 HREF="#HDRCMDJ3SD" >CMD J3--Start Memory Dump</A>
<LI><A NAME=PToC_73 HREF="#HDRCMDJ4HL" >CMD J4--Halt and Wait for Next Command</A>
<LI><A NAME=PToC_74 HREF="#HDRCMDJ5PX" >CMD J5--Start Program Execution</A>
<LI><A NAME=PToC_75 HREF="#HDRCMDJ6ER" >CMD J6--Terminal Error Return (Response Only)</A>
<LI><A NAME=PToC_76 HREF="#HDRCMDJ7NX" >CMD J7--Send Next Data Dump Record</A>
<LI><A NAME=PToC_77 HREF="#HDRCMDJ8UV" >CMD J8--Terminal Unavailable (Response Only)</A>
<LI><A NAME=PToC_78 HREF="#HDRCMDJ9CF" >CMD J9--Configuration Query</A>
<LI><A NAME=PToC_79 HREF="#Header_79" >CMD K--Transaction Release</A>
<LI><A NAME=PToC_80 HREF="#Header_80" >CMD L--Loopback for Communications Verification</A>
<LI><A NAME=PToC_81 HREF="#Header_81" >CMD MA--Request CFR Status</A>
<LI><A NAME=PToC_82 HREF="#Header_82" >CMD MB--Allocate Space for CFR</A>
<LI><A NAME=PToC_83 HREF="#Header_83" >CMD MC--Load CFR Image</A>
<LI><A NAME=PToC_84 HREF="#Header_84" >CMD MD--Start CFR</A>
<LI><A NAME=PToC_85 HREF="#Header_85" >CMD NA--Send Validation File Status to the Host</A>
<LI><A NAME=PToC_86 HREF="#Header_86" >CMD NB--Initialize Specified Validation File</A>
<LI><A NAME=PToC_87 HREF="#Header_87" >CMD NC--Load Validation File</A>
<LI><A NAME=PToC_88 HREF="#Header_88" >CMD ND--Validation File Load Complete</A>
<LI><A NAME=PToC_89 HREF="#Header_89" >CMD O--Write to Display with Attributes</A>
<LI><A NAME=PToC_90 HREF="#Header_90" >CMD Q--Query (Read) User Variable</A>
<LI><A NAME=PToC_91 HREF="#Header_91" >CMD V--Positive or Negative Response to Remote Validation</A>
</MENU></MENU>
<P><B><LI><A NAME=PToC_92 HREF="#HDRPOWERUP" >Powerup and Download Specifications</A></B>
<MENU>
<LI><A NAME=PToC_93 HREF="#Header_93" >7524 Powerup Requirements</A>
<LI><A NAME=PToC_94 HREF="#HDRFILEINT" >Parameter File Initialization Sequence</A>
<LI><A NAME=PToC_95 HREF="#HDRFILEDWN" >Parameter File Download Sequence</A>
<LI><A NAME=PToC_96 HREF="#HDREVFDS" >Extended Validation File Download Sequence</A>
<LI><A NAME=PToC_97 HREF="#HDRCRDS" >CFR File Download Sequence</A>
<MENU>
<LI><A NAME=PToC_98 HREF="#Header_98" >Redownload of a CFR</A>
</MENU></MENU>
<P><B><LI><A NAME=PToC_99 HREF="#HDRVALID" >Validation of Device Input Data</A></B>
<MENU>
<LI><A NAME=PToC_100 HREF="#HDRNUMERIC" >Numeric Data Entry Field</A>
<LI><A NAME=PToC_101 HREF="#HDRALPHANM" >Alphanumeric Data Entry Field</A>
<LI><A NAME=PToC_102 HREF="#HDRVDATA" >Validation of Data Entered</A>
</MENU>
<P><B><LI><A NAME=PToC_103 HREF="#HDRKEYPD" >Keypad Operation</A></B>
<MENU>
<LI><A NAME=PToC_104 HREF="#Header_104" >Keyboard Usage for 7524 Terminals (and their Intermec/Norand equivalents)</A>
<LI><A NAME=PToC_105 HREF="#Header_105" >Keyboard Usage for Terminals Running the DCConnect Client</A>
</MENU>
<P><B><LI><A NAME=PToC_106 HREF="#HDRBADGE" >Badge-Initiated Transactions</A></B>
<P><B><LI><A NAME=PToC_107 HREF="#HDRSTRINGS" >Character String Construction and Manipulation</A></B>
<P><B><LI><A NAME=PToC_108 HREF="#HDRRAMS" >RAM Files</A></B>
<MENU>
<LI><A NAME=PToC_109 HREF="#HDRFILERUL" >General File Rules</A>
<LI><A NAME=PToC_110 HREF="#HDRRAMFILE" >File Descriptions</A>
<MENU>
<LI><A NAME=PToC_111 HREF="#HDRFIL0DSC" >File 0--Terminal Operating Parameters/Program Storage</A>
<MENU>
<LI><A NAME=PToC_112 HREF="#Header_112" >File 0--Record 00 (Configuration Record)</A>
<LI><A NAME=PToC_113 HREF="#Header_113" >File 0--Records 01-121</A>
<LI><A NAME=PToC_114 HREF="#Header_114" >Examples of Function Key Record Formats for File 0</A>
</MENU>
<LI><A NAME=PToC_115 HREF="#HDRFIL1FCT" >File 1--Fast Clocking Times</A>
<MENU>
<LI><A NAME=PToC_116 HREF="#HDRR0TIMPR" >Record 0--Fast Clocking Time Periods</A>
<LI><A NAME=PToC_117 HREF="#HDRR199ADD" >Records 1-99--Additional Time Periods</A>
</MENU>
<LI><A NAME=PToC_118 HREF="#HDRFIL27US" >Files 2-7--User Validation Files</A>
<LI><A NAME=PToC_119 HREF="#HDRFIL8MSG" >File 8--Message File</A>
<LI><A NAME=PToC_120 HREF="#HDRFUNID" >File 9--Transaction Queue File</A>
<MENU>
<LI><A NAME=PToC_121 HREF="#Header_121" >Validation Transaction Format</A>
<LI><A NAME=PToC_122 HREF="#Header_122" >Transaction IDs</A>
</MENU>
<LI><A NAME=PToC_123 HREF="#Header_123" >File c--Custom Function Routine Support</A>
<LI><A NAME=PToC_124 HREF="#Header_124" >File e--Extended Validation Support</A>
</MENU></MENU>
<P><B><LI><A NAME=PToC_125 HREF="#HDRERROR" >Error Reporting</A></B>
<MENU>
<LI><A NAME=PToC_126 HREF="#HDRDEVCERR" >Device Errors and System Software Failures</A>
<LI><A NAME=PToC_127 HREF="#HDRINTFERR" >Interfacing Errors</A>
<LI><A NAME=PToC_128 HREF="#HDRAPLXMPL" >Application Exceptions</A>
<LI><A NAME=PToC_129 HREF="#HDRLOCLERR" >Local Errors</A>
</MENU></MENU><HR><P>
<HR>
<H1><A NAME="HDROVER" HREF="#PToC_11">Extended Terminal Services Overview</A></H1>
<P>This manual was originally written in 1995 for the 7524 Extended Terminal
Services (ETS) program that can be flashed into IBM 7524 terminals (or their
Intermec/Norand equivalents). In 1997, a product called 752x Emulator for DOS
was created by IBM that was based on the same code as the 7524 ETS flash. The
752x Emulator for DOS was written to support various models of terminals from
Intermec, Symbol and Telxon. Then in 2000, support was added for several
Windows platforms and the 752x Emulator for DOS was renamed to DCConnect Client.
<P>
Because much of the source code the 7524 ETS flash and the DCConnect Client is
the same, much of the discussion in this manual applies to both products.
Therefore any reference to "ETS" or "Extended Terminal Services" applies to
both products - unless explicitly stated otherwise.
<P>This publication describes both forms of the Extended Terminal Services
(ETS) program:
<UL>
<P><LI>7524 Extended Terminal Services flash which is loaded into the IBM
7524 Radio Frequency or Batch Data Collection Terminal (DCT). In 1998, IBM
stopped selling the 7524 terminal. The 7524 terminal was relogoed from
Intermec/Norand. Intermec continues to sell some of the equivalent models
of these terminals: 11xx, 17xx and 59xx.
<P>
Loading of the 7524 ETS program into flash is usually done prior to shipment,
with the code residing in non-volatile "FLASH" ROM. 7524 ETS can only
be used with the 7524 DCT (or the equivalent Intermec/Norand model).
<P>
The latest version of 7524 ETS flash for all supported terminal models is
available from our website:
<PRE>
http://www.ibm.com/software/data/dcconnect
</PRE>
<P>
Follow the link to "Product Downloads" and then "7524 ETS Flash Loads and CFR
Samples, Programming Tools".
<P><LI>
The DCConnect Client is the equivalent product to 7524 ETS that runs on
selected non-IBM, (third party) DOS-based terminal or Windows-based
terminal/PC. For a list of all supported terminals/platforms and for
installation and configuration instructions for the DCConnect Client, please
refer to our website, mentioned above, and follow the link to "Data Collection
Terminals" (in the lefthand column) and then the link in the middle of the page
that refers to "third party terminal vendors".
</UL>
<P>
ETS includes a set of functions similar to those provided in the other
IBM 752x Data Collection Terminals: 7527 running <I>7527 Extended Terminal
Services</I> and 7526 with its native microcode.
<P>
Through downloaded ETS files, the DCT can be customized to
collect user-specified data as an intelligent, distributed processing
device. For complete details about files,
(See<A HREF="#HDRRAMS">RAM Files</A>) .
<P>
ETS interfaces via the RF data network / TCP/IP network / serial connection
with a personal computer (PC) or industrial computer
that acts a terminal server.
The terminal server collects data from and provides files
and query services to all of the data collection terminals supported by
the DCConnect Client, as well as 7524 terminals and IBM 7526 and 7527 terminals.
To perform this server function, IBM offers the
product <I>Data Collection Connection</I> (version
1.4.0 or later). If using IBM 7524 terminals or their Intermec/
Norand equivalent, the the program product <I>7524 Interface
Support</I> is also required.
<P>
There are versions of both the 7524 ETS flash and the DCConnect Client
program which allow the terminal to communicate to the terminal server
via the serial port. Terminals loaded with this version of the flash/program
are often referred to as 'batch' terminals.
<P>
Most of the time, terminals loaded with the DCConnect Client program
commmunicate with the terminal server over a TCP/IP network. This network
may be a fixed Ethernet or it may involve RF communications over part of the
Ethernet. Whether RF is involved or not is transparent to the DCConnect Client.
<P>
Most of the time, terminals loaded with 7524 ETS flash communicate with
the terminal server over a special RF data network using components from
Intermec/Norand. An RF controller is attached to the terminal server via the
serial port and that controller is attached to one or more RF bases (access
points) which communicate via radio to the 7524 terminals. There are
different kinds of radio technologies available: UHF, SST, 9.02mhz OWL,
2.4ghz OWL. However, whichever radio technology is used is transparent to the
logic of the 7524 ETS flash.
<P>
The specific 7524 radio frequency products which form the RF data network
include:
<UL>
<P><LI>
The 7524-301 UHF (ultra-high frequency) and 7524-302 SST (spread spectrum
technology) Radio Frequency Controllers, which connect via an RS-232
communications port (COMx) to your personal computer. The controller
encapsulates the data transmitted between the RF terminals and the
personal computer into RF network packets, transmits the data to the
RF bases stations, and controls the network of base stations.
<P><LI>
The 7524-310 Radio Frequency Controller is a repeater device for
use on larger SST networks which have been built with the special-purpose
RS-485 460kbs local area network.
<P><LI>
The 7524-401 Radio Frequency Base is a UHF transceiver. The base
handles transmission and reception of RF signals to and from the
RF terminals. Up to two 7524-401 bases may be attached (via RS-232 or
RS-422) to a 7524-301 controller.
<P><LI>
The 7524-402 Radio Frequency Base is a SST transceiver. The base
handles transmission and reception of RF signals to and from the
RF terminals. Many 7524-402 bases may be attached
to a 7524-302 controller via RS-485 high-speed local area networks.
<P><LI>
The 7524-422 Radio Frequency Base is a SST transceiver which includes
both RS-485 and Ethernet 10base2 LAN interconnection support.
The base
handles transmission and reception of RF signals to and from the
RF terminals. Many 7524-422 bases may be attached
to a 7524-302 controller. The first unit must be attached to the 7524-302
via the RS-485 high-speed local area network. This first 7524-422 may
serve (in addition to being a RF transceiver) as a bridge to a
10base2 Ethernet LAN. Many other 7524-422 bases may be spread across
the Ethernet LAN.
</UL>
<HR>
<H2><A NAME="Header_12" HREF="#PToC_12">Data Flow</A></H2>
<P><A HREF="#FIGTAPREL">Figure 1</A> illustrates the data flow of ETS.
This diagram contains references to the following terms:
<UL>
<P><LI>Alphabetic and numeric keys
<P>The location of the alphabetic and numeric keys on the DCT varies
depending on the model.
<P>For additional information,
(See<A HREF="#HDRKEYPD">Keypad Operation</A>) and
(See<A HREF="#HDRKEYALLW">Command and Special Key Relationships</A>) .
<P><LI>General purpose (GP) communications<A HREF="#FNGPDEF">(1)</A>
<P>GP communications are
point-to-point communications with
user-supplied devices such as a scale, printer, and scanners.
<P>For a discussion of GP communications,
(See<A HREF="#HDRRAMS">RAM Files</A>) .
<P><LI>Message file
<P>File 8 is the message file. For a complete description,
(See<A HREF="#HDRFIL8MSG">File 8--Message File</A>) .
<P><LI>Programmable function (PF) keys
<P>The location and use of the PF keys vary depending on the terminal
model.
<P>For additional information,
(See<A HREF="#HDRKEYPD">Keypad Operation</A>) and
(See<A HREF="#HDRKEYALLW">Command and Special Key Relationships</A>) .
<P><LI>Sensors
<P>The 7524 terminals, models 50, 51, 52, 54, 100, 101, 102 and 104,
can be
ordered with an optional
integrated bar code laser scanner. All 7524 terminals also have
a sensor port to support the
connection of a tethered bar code wand, CCD, or laser scanner.
<P>Most third party terminals supported by the DCConnect Client also
included integrated scanners and/or the ability to attach a tethered
bar code wand, CCD or laser scanner.
<P><LI>Transaction, transaction queue
<P>Transactions are placed in File 9. For more information,
(See<A HREF="#HDRFUNID">File 9--Transaction Queue File</A>) and
(See<A HREF="#HDRMODES">Modes of Operation</A>) .
<P><LI>User variables (UV)
<P>New data may be appended to user variables and then manipulated
and used during the processing of a transaction program.
<P>For a discussion of User variables,
(See<A HREF="#HDRSTRINGS">Character String Construction and Manipulation</A>) .
</UL>
<P><B><A NAME="FIGTAPREL">Figure 1. Extended Terminal Services Data Flow Diagram</A></B><BR>
<img src=e9gw0001.GIF><BR>
<HR>
<H1><A NAME="HDRINSTALL" HREF="#PToC_13">Installing and Downloading the 7524 Extended Terminal Services Flash</A></H1>
<P>This chapter applies only to the 7524 ETS flash; it does not apply to the
DCConnect Client. For installation and configuration instructions regarding
the DCConnect Client, please refer to the softcopy DCConnect Client User's
Guide which is available from our website:
<PRE>
http://www.ibm.com/software/data/dcconnect
</PRE>
<P>
Follow the link to "Library" and then "DCConnect Client User's Guide".
<P>
7524 Radio Frequency Terminals usually have their terminal personality
program installed at the factory per the customer's order.
However, if the need arises to convert a terminal from one personality
type to another (for example,
from 3270 emulation to 7524 ETS), or to install
a new version of the program, then a simple procedure may be used to
erase the "flash" non-volatile memory of the terminal and reload
the personality application program.
<HR>
<H2><A NAME="HDRHWSWREQ" HREF="#PToC_14">Hardware and Software Requirements</A></H2>
<P>Before attempting to load 7524 Extended Terminal Services to a terminal,
ensure that the required hardware and software are available.
<P>
<H3><A NAME="HDRHRDWREQ" HREF="#PToC_15">Hardware Requirements</A></H3>
<P>The minimum hardware requirements for re-loading 7524 ETS to the
terminal's memory
are:
<UL>
<P><LI>An
IBM personal or industrial computer with monitor, keyboard, and an
RS-232 communications port. The operating system must be capable of
running a DOS application (e.g. DOS, OS/2 2.0 or later).
<P><LI>One or more IBM 7524 Radio Frequency Terminals
<P><LI>Downloader cable
</UL>
<P>
<H3><A NAME="HDRSFTWREQ" HREF="#PToC_16">Software Requirements</A></H3>
<P>The minimum software requirements are:
<UL>
<P><LI>One of the following operating systems for the system unit:
<UL>
<P><LI>DOS (at least Version 3.3)
<P><LI>OS/2* (at least Version 2.0)
</UL>
<P><LI>7524 Extended Terminal Services upgrade diskette, available from
your place of purchase or from IBM support personnel.
</UL>
<HR>
<H2><A NAME="Header_17" HREF="#PToC_17">Installing the 7524 Extended Terminal Services Program</A></H2>
<P>
To install an update to the 7524 Extended Terminal Services (ETS) program,
perform the following steps:
<OL>
<P><LI>The ETS program comes in a self-extracting
executable file, which when
run will unpack several files:
<OL>
<P><LI>ETSxxx.HEX--the binary images to be
loaded into the 7524's memory.
The characters 'xxx' specify the 7524 model
for which the image is
intended: 050, 051, 052, 054, 100, 101, 102, 104, 201, 202, 204.
<P><LI>PROGDUX.EXE--the DOS program that performs the download
<P>and
<P>PROGDUX2.EXE--the OS/2 version of the program to do the download
<P><LI>GO.BAT--the DOS batch file that calls PROGDUX, using
command-line arguments to set the COMx port, baud
rate, and hex data file to be used.
<P>and
<P>GO.CMD--the OS/2 command file which calls PROGDUX2 using
the command line arguments.
</OL>
<P><LI>Connect the download cable to the personal computer and to the mini-DIN
connector on the 7524-50, 51, 52, 54, 100, 101, 102 or 104
terminal or to the 15-pin communications
port on the 7524-201, -202, or -204.
<P><LI>The 7524 terminal should be powered off at this point. With the terminal
powered off, press and hold the <B><I>I</I></B> key and turn on the 7524's
power. The 7524 will power-up in a mode which expects a download.
<P><LI>Start the downloader on the personal computer by using the
GO.BAT command file
or by entering a similar command manually. Enter
<TT>TYPE GO.BAT</TT> to
list the file for help with modifying the parameters.
<P><LI>PROGDUX will periodically report the progress of the download
as it runs. When finished, you may unplug the terminal.
A command line parameter on the PROGDUX program may be used to
set the program in a mode where it will automatically wait for you to plug
in another terminal for downloading.
</OL>
<HR>
<H1><A NAME="HDRMODES" HREF="#PToC_18">Modes of Operation</A></H1>
<P>This chapter describes the modes of operation for the
<I>transaction queue</I> maintained in the terminal by ETS.
A <I>transaction</I> is a collection of related data
which has been collected by the DCT during the execution of a
transaction program.
A <I>transaction queue</I> is a temporary storage area for
transactions that have been collected.
These transactions are waiting to be sent to
the terminal server.
After a transaction is sent to the server, it
is removed from the queue by ETS
after ETS has received an indication from the terminal server that
the transaction was received properly.
<P>
The terminal handles the removal of transactions from the queue
differently depending on whether it is communicating to the host
by way of
the RS-232 port ('batch' interface) or
by way of an RF or TCP/IP network
('networked' interface).
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>Collecting Transactions from a Batch Terminal
</B></TD><TD><P>
Because the batch terminal communicates through the
RS-232 port, it can be on the same communications line as
other fixed 752X terminals, provided an RS232-RS485
converter is used.
Server applications, such as DCConnect, can communicate
with a batch terminal.
For this reason, the batch terminal was
set up so that transactions are collected from it in the
same way that they are collected from 752x terminals such as
the 7527. In fact,
server applications, such as DCConnect, can communicate with an
ETS batch terminal
as if it were a 7527 terminal.
<P>
The batch terminal must be polled
to collect transactions from it. Whenever the terminal server
polls the terminal, the terminal either responds with the
next transaction in the queue or it responds with a NAK,
indicating there are no transactions to be collected.
Depending on how the batch terminal has been configured, a
release command from the terminal server may be required before
the terminal discards a transaction that has been sent to
the terminal server.
</TD></TR><TR VALIGN=TOP><TD><P><B>Collecting Transactions from a Network-Attached Terminal
</B></TD><TD><P>
Network-attached terminals include 7524 RF terminals as well as any
terminal that is running the DCConnect Client and is communicating to
the terminal server using TCP/IP.
<P>
A terminal operating in the networked environment does not have to be polled
in order to collect transactions from it.
Continuous
polling of a network of terminals would drastically
degrade the performance of the network - particularly if RF is involved.
A networked terminal is able to send a transaction to the
terminal server as
soon as it is generated, rather than in response to a poll.
A message that is transmitted through
the network indicates which
terminal it is coming from or going to. Therefore, the
terminal server can determine
which terminal the
transaction came from even though it did not explicitly
poll any terminal for a transaction.
<P>
The networked terminal, after having sent the first
transaction in the queue, will not attempt to send any
others until the terminal server sends an explicit release
command for that one transaction. When the terminal server sends
a valid release command, the terminal immediately sends the
next transaction in the queue, if there is one. Only one
transaction is outstanding from the networked terminal at a time.
<P>
Because there are times when the terminal server will not want
the terminal to send transactions to it, special commands
were created for networked terminal that can be used by
the terminal server to inform the terminal that it can or cannot
send transactions.
For information on these commands,
(See<A HREF="#HDRUNSMF">Unsolicited Message Flow Control</A>) .
<P>
When the terminal has been informed not to send transactions, it
stores any transactions that are generated in its queue
until the terminal server
informs the terminal that
it can send them again. At
such time, the first transaction is sent and must be
released by the terminal server before the next is sent.
</TD></TR></TABLE>
<HR>
<H2><A NAME="Header_19" HREF="#PToC_19">Transaction Queue Modes</A></H2>
<P>
The transaction queue operates in 3 modes:
<UL COMPACT>
<LI>Interactive,
(See<A HREF="#HDRINTER">Interactive Mode</A>)
<LI>Interactive/buffered,
(See<A HREF="#HDRINTBUF">Interactive/Buffered Mode</A>)
<LI>Buffered,
(See<A HREF="#HDRBMM">Buffered Mode</A>)
</UL>
<P>The mode of the transaction queue
can be set in one of three ways:
<OL>
<P><LI>Through the terminal server command 8
(CMD 8)<A HREF="#FNCMDEXPL">(2)</A>,
which sets the default mode of the transaction queue.
<P><LI>Through the <B>:I</B> command
in a transaction program which sets the mode of
the transaction queue for the duration of the current transaction only.
<P><B>:I</B> and all other key commands
are described in <A HREF="#TBLKEYCMDS">Table 6</A>.
<P><LI>Through byte 2 in File 0 record 00, which is the default mode of the
transaction queue if a terminal server CMD 8 has not been executed,
or if there is no <B>:I</B>
in the transaction program of the current transaction.
<P>For a description of File 0,
(See<A HREF="#HDRFIL0DSC">File 0--Terminal Operating Parameters/Program Storage</A>) .
The DCConnect product presents graphical input panels which make it
easy to configure the various operating options controlled
by File 0, record 00.
</OL>
<P>
<H3><A NAME="HDRINTER" HREF="#PToC_20">Interactive Mode</A></H3>
<I>Interactive mode</I>
allows the terminal to build a transaction and lock
out any further activity until the transaction is acted on by the
terminal server, or until a programmable timeout function
(Timer <B>A</B> in
File 0 record 00, byte 16/17) occurs.
The transaction is removed upon receipt of a CMD 2, CMD B, CMD C,
or CMD D
from the terminal server, or when communications with the
terminal server have timed out.
If timeout occurs, the waiting transaction will be cancelled, and an
<B>OUT OF SERVICE</B> message (stored in File 8)
will be displayed on the terminal screen.
Transactions may not be entered until the terminal server
resumes communications with the terminal.
<P>
<H3><A NAME="HDRINTBUF" HREF="#PToC_21">Interactive/Buffered Mode</A></H3>
<I>Interactive/buffered mode</I>
allows the terminal to build a transaction
and lock out any further activity until the transaction is acted on by
the terminal server, or until a programmable timeout
(Timer <B>A</B>) function occurs.
If timeout occurs, the waiting transaction will be stored in a buffer,
and the terminal can accept new transactions. The timeout can be set
to a value via a download parameter, which will give sufficient time for
the terminal server to respond to
the terminal. The transaction queue
will then operate in buffered mode until the terminal server
starts to communicate with the terminal again.
<P>
<H3><A NAME="HDRBMM" HREF="#PToC_22">Buffered Mode</A></H3>
<P>
Buffered mode allows the terminal to place all transactions
in the transaction queue as they are entered, regardless of
whether the terminal server is currently communicating with the
terminal. Transactions are sent to the terminal server
from the queue using the first in/first out (FIFO) method;
transactions are sent to the terminal server in the same order
that they were added to the queue. The sequence of commands
used by the terminal and the terminal server varies, depending on
whether the terminal is an RF or batch terminal and whether
or not transactions must be explicitly released by the
terminal server with a special release command (CMD K).
<P>
<H4><A NAME="HDRBM" HREF="#PToC_23">Buffered Mode for Networked Terminals</A></H4>
<P>
Because an RF terminal is not explicitly polled by the terminal
server, the terminal determines when to send
transactions to the terminal server, following certain rules
of protocol. The first rule is that the terminal should not
send transactions unless the terminal server gives permission.
<P>
The terminal maintains a <I>transaction flow control</I> flag
to track whether or not it is allowed to send
transactions to the terminal server. The
don't-send-me-transactions command (CMD A0X) is used by the
terminal server to turn this flag off. When a terminal is
first powered on, the flag defaults to the off state.
However, a power-up message
informing that the terminal is now active
is sent to the terminal server.
At this
time, the terminal server
can choose to send to the terminal a
you-can-now-send-me-transactions command (CMD A1X), which
turns on the terminal's transaction flow control flag.
<P>
If the terminal sends a transaction without the terminal
server's permission, the terminal
server sends to
the terminal the CMD A0X followed by a NAK for the
transaction. The NAK indicates the terminal server did not or
could not receive the transaction and that the terminal
should resend it when it receives a CMD A1X from the
terminal server.
<P>Whenever the terminal receives the CMD A1X
command, it sends whatever transaction is first in its
queue. If the terminal server receives that transaction
successfully, it responds with an ACK to the terminal. The
ACK, however, does not release the transaction from the
terminal's queue. The terminal expects a CMD K release
before it will discard the transaction. The ACK sent by the
terminal server indicates that the transaction's checksum was
valid and that the terminal server is now accepting transactions.
The CMD K is used when the terminal server has successfully
stored the transaction (for example, in a DCConnect logfile).
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
There are other possible responses to the A1X command; these are
discussed in the next chapter.
</td></tr></table>
<P>
When the terminal receives a valid CMD K (the sequence
number matches that of the first transaction in the queue),
the first transaction is discarded. If more transactions
are in the queue, the next one is immediately sent to the
terminal server.
<P>
This process repeats until all transactions
have been sent to the terminal server. If new
transactions are generated before the queue is emptied, they
are added to the end of the queue. In the case where
a new transaction is generated and the queue is empty, the
terminal immediately sends the transaction to the
terminal server, provided its transaction flow control
flag is on.
<P>
<H4><A NAME="Header_24" HREF="#PToC_24">Buffered Mode for Batch Terminals</A></H4>
The batch terminal sends transactions to the terminal
server in response to polls
issued by the terminal server.
If the terminal has no transactions in its queue,
it responds with a NAK to the terminal
server. But if it had transactions,
the first one in the queue that had not yet
been sent will be sent.
<P>If a transaction was sent, the terminal server
responds with an ACK or a NAK, as follows.
<UL COMPACT>
<LI>The ACK response indicates the terminal server
successfully received the transaction and that the terminal
should send the next transaction in the queue for the next
poll, provided the queue is not empty.
<LI>The NAK response indicates the terminal server did
not or could not receive the transaction properly and that
the terminal should return the same transaction the next time
that the terminal server polls that terminal.
</UL>
<P>
Depending on how the terminal is configured, the ACK to the
transaction may or may not cause the transaction to be
discarded by the terminal.
<UL>
<P><LI>In the simplest case, the ACK discards the
transaction.
<P><LI>
If the terminal is configured for a
<I>transaction release requirement</I> (CMD K)
from the terminal server before
transactions are released, the ACK does
not discard the transaction. This ACK does, however, inform
the terminal to return the next transaction in the
queue on the next poll. The terminal
keeps the first transaction in its buffer.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
A terminal operating parameter (File 0 record 00 offset 203)
enables the transaction release requirement. If this parameter is
not present (that is, a smaller file 0 has been downloaded),
then the terminal defaults to not requiring the release
command.
</td></tr></table>
<P>
This transaction release requirement provides improved throughput and
prevents loss of data at the same time. Multiple
transactions can be sent to the terminal server and
still be retained in the terminal. When the terminal
server has successfully stored a block of transactions,
it sends the CMD K to the terminal to release that
block of transactions from the terminal.
<P>When the release requirement is in effect:
<UL>
<P><LI>Transactions are
discarded from the buffer when the terminal receives the CMD
K specifying to release (discard) one or more transactions
from the terminal's queue. Each transaction in the queue has
a sequence number. The CMD K also specifies a specific
sequence number. If the sequence number in the CMD K is a
valid sequence number for one of the outstanding
transactions, all transactions with a sequence number less
than or equal to that specified in the CMD K are released.
<P><LI>
A timer is also
used to allow the terminal to reset its transaction queue if
the CMD K is not received in a reasonable amount of time.
When the first transaction is polled, the <I>terminal
server timer</I> is started (Timer A in File 0 record 00,
byte 16/17).
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>Timer A has not expired
</B></TD><TD><P>All
transactions that the terminal server polls are marked
in the terminal as sent but not released and are kept in the
terminal's transaction queue. When any valid CMD K is
received, the timer A is restarted.
</TD></TR><TR VALIGN=TOP><TD><P><B>Timer A has expired
</B></TD><TD><P>The terminal assumes that all transactions marked
as sent but not released did not reach their final
destination. As a result, the terminal resets the
transaction queue so that the first transaction in it will
be the next one that is returned to the terminal server
in response to the next poll. On the next poll, the Timer A
will be restarted.
</TD></TR></TABLE>
</UL>
</UL>
<P>
<H4><A NAME="Header_25" HREF="#PToC_25">Buffer (Queue) Full Condition</A></H4>
<P>
For both networked and batch terminals, the transaction queue
may run out of space if the terminal has not been
communicating with the terminal server for some time.
When the buffer fills up, the terminal does nothing
until it has a new transaction to add to the buffer
that will not fit.
The terminal then shows a <B>Buffer
full</B> message indicating how many transactions are stored.
The terminal user will be unable to create any more
transactions until the terminal is able to send some of the
stored transactions to the terminal server.
<P>
The size of the transaction buffer can vary based on the kind of
device being used and its configuration. Unlike other 752x terminals,
the size of the transaction buffer is not affected by the terminal
server command that initializes file 9 (the transaction buffer) to a
specific size. Terminals with 7524 ETS flash can store up to 735
transactions. Terminal running the DCConnect Client default to a
capacity of 367 transactions. However, this default value can be
changed using the MAX_TRANSACTIONS keyword in the Client configuration.
Refer to the DCConnect Client documentation for more information.
<HR>
<H1><A NAME="HDRCOMMPRO" HREF="#PToC_26">Modified Communications Control Protocol 1283</A></H1>
<P>
This chapter specifies the communications control protocol
used by the Extended Terminal Services
and outlines the requirements for control command structures,
control
characters, and communications symbols.
<P>
The IBM-designed 1283 communication line protocol is the basis
for the
communication between the terminal server and the attached DCT.
This
protocol is used by the following hard-wired communications terminals:
IBM
7524 batch terminal,
7525, 7526, 7527 and terminals running the serial (batch) version of
the DCConnect Client.
It is a polled protocol,
suitable for use with wired terminals.
<P>
However, with communications over an RF or TCP/IP network, polling of
terminals cannot be done because performance of the network would be
dramatically degraded. Thus the networked terminal uses a
modified version of the 1283 protocol, which does not require
constant polling of the terminals. The networked terminal can
send unsolicited messages to the server.
<P>
The batch terminal uses the standard 1283 protocol.
The remainder
of this chapter discusses the differences in the modified 1283
protocol used
by the networked terminal.
<HR>
<H2><A NAME="Header_27" HREF="#PToC_27">Performance Modification for Terminals on an RF or TCP/IP Network</A></H2>
<P>
The modification eliminates the polling of the DCT
transaction queue characterized as
follows:
<PRE>
Terminal Server DCT Response
STX, ADDR, ADDR, ETX
NAK (error)
NAK (no data)
STX, data, CS1, CS2, ETX (data)
DC2 (download of ETS needed)
DC1 (download of files needed)
</PRE>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The batch terminal uses polling; the networked terminal does not.
</td></tr></table>
<P>
Instead of polling, the modification stipulates
that the networked DCT can send unsolicited
transaction data to the terminal server.
Unsolicited transaction data sent from the
DCT will not be released (the DCT will retain the
data) until its receipt is acknowledged
by the terminal server (this is the present behavior).
For information,
(See<A HREF="#HDRBM">Buffered Mode for Networked Terminals</A>) .
<HR>
<H2><A NAME="Header_28" HREF="#PToC_28">Ramifications for the Elimination of Polling</A></H2>
The 1283 protocol implements two separate message types:
unsolicited and
command/responses (hereafter referred to as <I>commands</I>).
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>Unsolicited
</B></TD><TD><P>Unsolicited messages from the terminal can occur at any
time. These messages include transactions, download
requests (DC1), 'I-am-here' messages (DC2), time requests (DC2nnnnn),
and 'I-have-no-transactions-and-don't-need-a-download' messages (DC3).
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
This use of the DC2 character is different from its use in
the true 1283 protocol.
</td></tr></table>
</TD></TR><TR VALIGN=TOP><TD><P><B>Command/responses
</B></TD><TD><P>Commands and their responses are completed
synchronously. That is, a second command is not issued to a
terminal until the response to the first command is received
or a timeout occurs.
</TD></TR></TABLE>
<P>
Using the standard 1283 protocol, transactions and
commands are distinguished via the
polling mechanism. The terminal server specifically
requests transaction data by issuing
a poll; since the DCT always responds with data or NAK
(or DC1/DC2), polls are
immediately concluded and commands may therefore be issued at any time.
<P>
Elimination of the polls and allowing unsolicited
transaction data means that there is no longer any method by
which the terminal server can determine if data received
from the DCT is transaction data or the response to a
command. Further, it is possible for
transaction data to be sent to the terminal
server between a command and
its response, prohibiting the data collection server
software from reading the command response it expects.
For a description of how to overcome these potential problems,
(See<A HREF="#HDRLOGCH">Logical Channels</A>) .
<HR>
<H2><A NAME="Header_29" HREF="#PToC_29">Initial File Loading</A></H2>
<P>
The 1283 protocol as implemented in the batch terminal
provides for several responses to polls. The most common
command responses are a transaction packet or a NAK
indicating that no data is available. Because transactions
are sent to the host in an unsolicited manner, the NAK is no
longer needed and is no longer sent.
<P>
The poll, however, is also how a batch terminal requests
a load of RAM files, if they are not
present in the terminal. Because polling is not used by the
networked terminal, the following mechanism is used to ensure
that files are loaded when necessary.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
ETS never handles the loading of itself, the 7524 ETS flash / DCConnect
Client ,because for 7524 terminals the flash is maintained in
nonvolatile flash ROM and for terminals running the DCConnect
Client, the Client must be loaded in the terminal before it
can even communicate with the terminal server.
This eliminates the
need for and use of the DC2 response for this purpose.
Instead, the DC2 unsolicited message is used to inform the
terminal server that the terminal is active in the following
situations:
<UL>
<P><LI>The terminal is first powered on / DCConnect Client starts
<P><LI>The 7524 RF terminal has just come back in range
<P><LI>A terminal that has been suspended has been resumed
<P><LI>The terminal is active and has not received any message
from the terminal server in a while - and as far as it knows,
it is allowed to send unsolicited data.
</UL>
</td></tr></table>
<P>
Upon startup of the terminal server, the server will try to
communicate with all terminals that are configured on the
TCP/IP network. However for the 7524 RF network, it does not
do this. Instead, the server expects the 7524 RF terminals and/or
the RF controller to tell the server which terminals are currently
communicating. This is how the terminal server gets its initial
snapshot of which terminals are communicating on both kinds of
networks.
<P>
After this point, a power on of any 7524 RF terminal or startup/unsuspend
of the DCConnect Client will cause an 'I-am-here' message to be sent
to the server.
<P>
Likewise, if a terminal was already powered and was just out of
range, when it comes back in range, an 'I-am-here' message will
eventually be sent to the server.
<P>
Whenever the terminal server identifies a terminal that has just
started communicating, whether at startup or later and whether on
a 7524 RF network or TCP/IP network, a startup sequence of commands
is performed with the terminal to ensure the terminal is in the
proper state and that it is able to send unsolicited messages if
it should be allowed to do so.
<P>
Part of the startup sequence is the sending of the A1X command to the
terminal which tells the terminal that it is permitted to send
unsolicited messages. It is at this time that the terminal will send
a DC1 message to the server if it requires RAM files to be loaded.
<P>
The networked terminal will only request a file load when it detects
that one or more RAM files are missing. This avoids a file reload
each time that the terminal establishes communications with the server.
However, the server can choose to reload the RAM files at any time,
usually at the request of someone operating the server.
<HR>
<H2><A NAME="HDRLOGCH" HREF="#PToC_30">Logical Channels</A></H2>
<P>
To maintain the ability to keep transaction and command data
separate, the single communications channel (RF or TCP/IP) is divided into
two logical channels by way of an intermediate-level protocol that is
implemented between the data collection server and the
DCT, on top of the modified 1283 protocol. The two channels
are used for:
<UL>
<P><LI>Unsolicited messages from the
terminal and the server responses to these messages,
<P><LI>Server commands and their responses.
</UL>
<P>
All traffic through each of these channels must be kept separate.
<P>
To implement the two logical channels over the single communications
channel, an additional header is added to the front of each
message that specifies its type as either the unsolicited or
command. Only one header character is needed.
All traffic between the terminal and the server that traverses the
RF / TCP/IP network must have this additional header character.
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>ASCII 'X'
</B></TD><TD><P>An ASCII 'X' is used for
transactions and other unsolicited terminal messages.
Any terminal server responses to these
unsolicited messages must also use this character.
</TD></TR><TR VALIGN=TOP><TD><P><B>ASCII 'C'
</B></TD><TD><P>An ASCII 'C' is used for commands initiated by the
terminal server and the terminal responses to those commands.
</TD></TR></TABLE>
<P>
The data collection server must use the header byte to
determine what type of message it has received. The
terminal does the same. Without the header the messages
look the same as they do in the standard 1283 protocol.
<HR>
<H2><A NAME="HDRMSGSQ" HREF="#PToC_31">Message Sequence Number</A></H2>
<P>
When communicating over a TCP/IP network, the DCConnect Client and the
data collection server use an additional field in the front of the header
to hold a 4-byte message sequence number. Most of the time UDP protocol
is used on the TCP/IP network; therefore there is a potential for lost
or duplicate messages. A message sequence number is used to match up
responses with commands. A different sequence number is maintained for
each channel ('X' and 'C'). The server maintains the sequence number for
the 'C' channel and the terminal maintains the sequence number for the 'X'
channel.
<P>
The sequence number is a 4-byte long integer prededing the channel
character ('X' or 'C') in the message header. It is in network byte
order.
<P>
For every command the server sends, the sequence number is incremented
by one. If a command does not get a response from the terminal before
the specified timeout, the command is sent again using the same
message sequence number. For the response to any 'C' channel command,
the terminal copies the sequence # from the command message to the
response message before sending back the response message.
<P>
The terminal also saves the last response it sent back for every kind of
command along with the sequence number associated with that command/response.
For every command received, a check is made to see if the sequence number
in the new command matches the one for the saved command. If it does, the
saved response is sent without actually processing the command. This avoid
problems such as loading the same block for a file into the terminal more
than once.
<P>
In the 'X' channel, only transactions use the message sequence number because
they are the only messages for which the terminal expects an explicit
response. The other unsolicited messages: download requests,
I-am-here messages, and time requests will all be retried by
the terminal if it does not get the expected activity that the request should
generate within a certain period of time. The message sequence number for
all 'X' channel messages besides transactions is set to 0.
<P>
In the command channel, the 'A1X' and 'A0X' commands also have the message
sequence number set to 0 because they are commands that are not expected to
get an immediate response (the server does not wait for a response before
issuing any other command).
<P>
At this time, message sequence numbers are not used in a 7524 RF network
because communications in the 7524 RF network have guaranteed delivery; the
messasge sequence nubmers are only used for communications over a TCP/IP
network.
<P>
For the remainder of this manual, any discussion of message formats will not
mention the message sequence number since is not used by the 7524 RF network.
But you should assume it is there for all messages that are send in a TCP/IP
network.
<HR>
<H2><A NAME="HDRMSGLN" HREF="#PToC_32">Additional Fields for Stream Sockets</A></H2>
<P>
Terminals that communicate over a stream socket in a TCP/IP network have two
additional fields that precede the message sequence number. The first two
bytes of these messages is a start of message identifier that must always be
the hex value 0x0365 in network byte order. The next two bytes are the
length of the remainder of the message in network byte order. These extra
fields are used for reconstructing a message that may be broken up as it
is sent through the TCP/IP network. With the start of message identifier
and length Extended Terminal Services knows when it has a new message and
how many bytes it is going to be.
<P>
For the remainder of this manual, any discussion of message formats will
not mention theses additional fields because they are not common to all the
different kinds of messages for networked terminals.
<HR>
<H2><A NAME="Header_33" HREF="#PToC_33">Terminal Addressing</A></H2>
<P>
All packets in the RF / TCP/IP network include an address field in the
header to indicate
which terminal the packet originated from or is supposed to
go to. The message format for the 1283 protocol also had 2 positions for
an address character; both positions had the same character.
Extended Terminal Services ignores the two address
characters that are used in the 1283 protocol. The
server software may still set these addresses for
additional debugging messages when watching the network
traffic.
<P>
In the 7524 RF network, terminal addresses can range from 0 through 126,
giving a total of 127 unique addresses. The 1283 protocol
allows for addresses A-Y, 0-6, giving a total of 32 unique
addresses. As a convention, the 7524 Interface Support sets
up the two address characters in the message as follows:
<PRE>
7524 Terminal Addresses Two Message Characters<A HREF="#FNDUP">(3)</A>
----------------------- ----------------------
0 - 24 AA - YY
25 - 31 00 - 66
32 - 56 AA - YY
57 - 63 00 - 66
64 - 88 AA - YY
89 - 95 00 - 66
96 - 120 AA - YY
121 - 126 00 - 55
</PRE>
<P>
In a TCP/IP network, these address characters are also filled in for
backwards compatability. They are generated based simply on the order
of the terminals in the server configuration. For example, the first
terminal uses AA, the second uses BB, the 26th uses 00, the 32nd uses 66,
the 33rd uses AA, the 34th uses BB, ...
<HR>
<H2><A NAME="Header_34" HREF="#PToC_34">Modified Packet Formats</A></H2>
<PRE>
Present 1283 Protocol Modified 1283 Protocol
Command 'C' Command
Response 'C' Response
Poll Eliminated
Transaction 'X' Transaction
</PRE>
<HR>
<H2><A NAME="HDRUNSMF" HREF="#PToC_35">Unsolicited Message Flow Control</A></H2>
<P>
Allowing unsolicited transactions and other messages from
the DCTs introduces a flow control problem in the data
collection server. The server needs the ability to
inform terminals that they should not send any unsolicited
messages. As a result, two new commands (A1X and A0X)
were introduced to
the 1283 protocol that are similar in meaning to two
existing commands (A1 and A0).
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>Existing commands
</B></TD><TD><P>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>A1
</B></TD><TD><P>Used to put
terminals In Service (A1)
</TD></TR><TR VALIGN=TOP><TD><P><B>A0
</B></TD><TD><P>Used to put
terminals Out of Service (A0).
</TD></TR></TABLE>
<P><B>Note: </B>The A1 and A0 commands controlled whether or not
terminal users were able to run
transaction programs to create transactions.
</TD></TR></TABLE>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>New commands
</B></TD><TD><P>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>A1X
</B></TD><TD><P>Enable Transmission of Unsolicited Messages (flow control = on)
</TD></TR><TR VALIGN=TOP><TD><P><B>A0X
</B></TD><TD><P>Disable Transmission of Unsolicited Messages (flow control = off)
</TD></TR></TABLE>
</TD></TR></TABLE>
<P>
The A1X and A0X commands fall into the 'command' category
and are thus preceded with the
'C' header character. <B>However, these commands
do not receive explicit response from
the terminal.</B> In other words, when the server sends out these
commands on the 'C' channel, it will not wait for any response (and none
will be sent by the terminal) on the 'C' channel.
<P>
But when a terminal receives an A1X command on the 'C' channel it may cause
the terminal to generate one of several messages on the 'X' channel:
<UL>
<P><LI>If the terminal has a transaction to send, it will send the first one
in its queue.
<P><LI>If the terminal requires a download of RAM files it will send a <DC1>
<P><LI>If the terminal has just been powered on / DCConnect Client has just been
started, a time request, <DC2> nnnnn, will be sent to the server. For
information about how the time request should be handled,
(See<A HREF="#HDRCMD4TIM">CMD 4--Set Terminal Time and Date</A>) .
<P><LI>If the terminal does not require a download and it does not have any
transactions, it will send <DC3>. This lets the server know, in an
asynchronous way, that it received the A1X command and it does not need a
download of RAM files and it does not have any transactions to send.
</UL>
<P>
The A0X command can be used in the case where a terminal
sends a transaction and the server is not ready for it.
(See<A HREF="#HDRBM">Buffered Mode for Networked Terminals</A>) .
This could occur immediately after the server sent out a
command to that terminal but before the response from the
terminal came back. The following sequence illustrates this
case:
<P><B>Note: </B>
<BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Legend/Symbol
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=99%>Description
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>==>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Transmission from terminal server to terminal
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%><==
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Transmission from terminal to terminal server
</TD></TR></TABLE>
<PRE>
==> C 5 Command to beep the terminal
<== X transaction Terminal sent up transaction at same time
==> C A0X Server does not want transactions now
==> X NAK Transaction NAKed so that terminal will resend it later
<== C ACK Response to the beep command by the terminal
</PRE>
<P>
In the preceding sequence, there are two outstanding
commands to the terminal at the time that the C A0X is
issued. Because the A0X will not generate a terminal
response, the terminal server can be sure that the C ACK that is
received later is for the beep command.
<P>
The A0X and A1X commands cross the boundary between the
command channel and the
unsolicited channel, which is why these commands
have characteristics
of both. They are
initiated by the terminal server, which is true of all commands on the 'C'
chaneel.
However, they do
control the flow in the unsolicited channel. The protocol
has been set up such
that if an A0X or A1X command is lost, no transactions
would be lost and no
synchronization problems would result.
<P>
Commands A0X and A1X toggle an internal terminal state flag
called the
<I>transaction flow control</I> flag. When a terminal is
first powered on, this flag defaults to being off. Only when the
server sends an A1X command will the flag be turned on.
At that time the terminal can begin sending transactions, if
it has any, or request a download of RAM files, if it needs
one.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The unsolicited DC2 message ("I-am-here") is not governed by
the transaction flow control flag. It is used in several situations
to let the server know that the terminal is functioning:
<UL>
<P><LI>Whenever a 7524 terminal loses the RF communications carrier and
then regains it
<P><LI>Whenever a 7524 terminal is powered on
<P><LI>Whenever the DCConnect Client is started and it knows the IP address
of the terminal server.
<P><LI>Whenever the DCConnect Client is suspended for more than 5 seconds, upon
resuming power, the DC2 message is sent.
<P><LI>For certain terminal models, the DCConnect Client will send the DC2
message if it has not received any message from the terminal server within
a certain period of time. In particular, when running in an Intermec
Antares terminal, right after startup the DCConnect Client will send the DC2
message every 10 seconds until it hears from the terminal server. Once
communications have been established, it will allow up to 75 seconds of no
message activity before it goes back into the mode where it sends the DC2
message every 10 seconds - until the terminal server begins to respond.
<P>
The Antares terminal uses a stream socket instead of a UDP socket. As a result
it is responsible for establishing communications with the terminal server.
For all other devices that use a UDP socket, the terminal server periodically
tries to communicate with each configured terminal that is currently not
responding.
</UL>
</td></tr></table>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>A1X
</B></TD><TD><P>When an A1X command is received by the terminal,
the transaction flow control flag is turned on. If no
transactions are waiting to be sent and the
terminal does not need a download, a DC3 is sent to the
terminal server to let the terminal server know that the terminal
received the A1X command. If a download is needed,
the terminal sends an
unsolicited DC1 message to the server. If
there are transactions in the
transaction queue, the first one is sent to the
host, even if it has already
been sent before.
</TD></TR><TR VALIGN=TOP><TD><P><B>A0X
</B></TD><TD><P>When an A0X command is received by the terminal, the
flag is turned off. This does not cause any immediate
action to take place in the terminal. Rather, it determines
what the terminal will do when the next transaction release
command is received or when the next transaction is
generated in the terminal.
</TD></TR></TABLE>
<P>
When the terminal generates a transaction,
what happens next depends on the transaction
flow control flag and whether there are
transactions currently in the
terminal's transaction queue.
<UL>
<P><LI>If there are
transactions in the queue, the new
one is added to the end of the queue.
<P><LI>If there are no transactions in the queue:
<UL COMPACT>
<LI>If the transaction flow control flag is
on, this transaction is sent to the terminal server.
<LI>If the transaction flow control flag is
off, this transaction is stored in the terminal's
transaction queue.
</UL>
</UL>
<P>
When a transaction is successfully released in the terminal
and there are transactions in the terminal still waiting to
be sent, the transaction flow control flag determines what to do next.
<UL>
<P><LI>If the flag is on, the first transaction in the queue is
sent.
<P><LI>If the flag is off, nothing is done with any of
the buffered transactions.
</UL>
<P>
If the terminal has just sent a transaction to the
terminal server and that
transaction has not yet been released, and then the
terminal receives an A0X
command followed some time later by an A1X command
with no transaction release
in between, the same transaction is sent to the
terminal server again when the A1X
command is received.
<P>
If, however, a transaction release command is
received after the A0X is
received but before the A1X, then the transaction
is released from the
terminal. When the A1X is received, that released
transaction will not be
resent because it no longer exists. In this instance,
the next transaction
sent to the terminal server is the next one in the queue
following the one that was
just released, if there are any.
<P>
The following describes the
transaction data/response flow,
including the actions
in some error conditions.
<P><B>Note: </B>
<BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Legend/Symbol
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=99%>Description
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>==>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Transmission from terminal server to terminal
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%><==
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Transmission from terminal to terminal server
</TD></TR></TABLE>
<P>
The initial state of these examples has the terminal server ready
for unsolicited transactions, and the terminal's transaction flow
control flag is on. No transactions are currently in the
queue and a new transaction has just been generated at the
terminal.
<PRE>
<== Xtransaction Transaction is sent by the terminal
==> XAck Transaction received at server, but must not be released
from the terminal yet.
or
==> XNak Transaction received but the checksum failed. This is an
implicit request for the terminal to resend the transaction
provided an A0X command was not issued by the server
in the mean time.
</PRE>
<P>
If at this point the terminal generates more transactions,
they are queued in the terminal behind the one that is
waiting to be released.
<P>
When the terminal server has successfully stored the transaction
and is ready to
release it, the terminal server sends the transaction release
command (CMD K), which
specifies the sequence number of the transaction being
released: nnnnn. The
terminal responds to the release with ACK or NAK
indicating whether the
release was successful (sequence number matches the
first transaction in the
queue).
<PRE>
==> CKnnnnn Release transaction with sequence number 'nnnnn'
<== CAck Sequence number was correct; transaction is released
or
<== CNak Sequence number was not correct or other error occurred
with the release. Transaction remains in the terminal.
Server should resend release or send A1X to have the
first transaction again.
</PRE>
<P>
The sequence number in the CMD K usually must match that of
the first transaction in the queue in order for it to be
released. However, if the sequence number in the CMD K is
set to 'XXXXX' then the first transaction in the queue
should be released no matter what.
<P>
If the release is successful and there are other
transactions waiting in the
terminal, and the transaction flow control flag is on, the
first will be sent and the preceding
scenario repeats.
<P>
If the release was not successful, the terminal will do nothing
with the transaction unless it receives one of the
following commands:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>Another release command
</B></TD><TD><P>Will try to process as before
</TD></TR><TR VALIGN=TOP><TD><P><B>A0X command
</B></TD><TD><P>The terminal turns off its transaction flow control
flag but still leaves the first transaction
in the buffer so it can be resent when A1X is next sent from the
terminal server.
</TD></TR><TR VALIGN=TOP><TD><P><B>A1X command
</B></TD><TD><P>The first transaction will be sent to the
terminal server again
</TD></TR></TABLE>
<P>
Each time a transaction is sent to the terminal server,
the terminal starts an
internal timer in case it does not receive an ACK or
NAK response for that
transaction. If no response is received before the
timer expires, the
transaction is resent, provided an A0X command
was not received by the
terminal in the meantime.
<P>
If no ACK or NAK is received for the transaction,
and a transaction release is
received before the timer expires, the transaction
is still released from
the terminal and operation continues as usual.
<P>
Likewise, when no response is received for a
transaction and an A0X command is
received followed some time later by a transaction
release, the transaction is
still released and operation continues as usual.
<P>
As a rule, a release command always
succeeds if the sequence number
specified in the release command matches
that of the first transaction or if it
is set to XXXXX.
<HR>
<H2><A NAME="Header_36" HREF="#PToC_36">ASCII Characters</A></H2>
<P>The following table specifies the ASCII characters
used in the communications control commands discussed in this document.
Their hexadecimal equivalents are also provided, along with
brief descriptions.
<BR>
<P><B><A NAME="TBLASCII">Table 1. ASCII/Hex Cross-reference</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP>ASCII
</TH><TH ALIGN=LEFT VALIGN=TOP>Hex
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=99%>Description
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>SOH
</TD><TD ALIGN=LEFT VALIGN=TOP>01
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Start of header
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>STX
</TD><TD ALIGN=LEFT VALIGN=TOP>02
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Start of text
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>ETX
</TD><TD ALIGN=LEFT VALIGN=TOP>03
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>End of text
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>ACK
</TD><TD ALIGN=LEFT VALIGN=TOP>06
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Positive acknowledgement
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>DC1
</TD><TD ALIGN=LEFT VALIGN=TOP>11
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Device control 1
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>DC2
</TD><TD ALIGN=LEFT VALIGN=TOP>12
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Device control 2
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>DC3
</TD><TD ALIGN=LEFT VALIGN=TOP>13
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Device control 3
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>NAK
</TD><TD ALIGN=LEFT VALIGN=TOP>15
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Negative acknowledgement
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>ESC
</TD><TD ALIGN=LEFT VALIGN=TOP>1B
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Escape sequence
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>RS
</TD><TD ALIGN=LEFT VALIGN=TOP>1E
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Record separator
</TD></TR></TABLE>
<P>The following legends and symbols are used in describing the
communications control commands.
<BR>
<P><B><A NAME="TBLCOMMLEG">Table 2. Communication Legends and Symbols</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Legend/Symbol
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=99%>Description
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>=>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Transmission from terminal server to terminal
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%><=
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Transmission from terminal to terminal server
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>ADDR
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Terminal address -- in a 7524 RF / TCP/IP network it is used only for
compatibility with 7526/7527 control programs. The address character
is not used by the terminal. Use of address <I>A</I> is suggested
for all terminals.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>CMD
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Command ID character sent to terminal
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>CS1, CS2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Checksum characters
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>data
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Characters sent to terminal server
from a terminal as a
result of a poll or command
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>text
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Parameters and data associated with a command sent to a terminal
from the terminal server
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>RS
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Record separator
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>f
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>File identifier
</TD></TR></TABLE>
<A NAME="SPTCMDEXMP"><I>(Ref #1.)</I></A>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
Communications control commands are discussed throughout the remainder
of this chapter. Also,
(See<A HREF="#HDRPFTCCC">DCT Communications Control Commands</A>) .
In the command descriptions,
the commas (,) or spaces ( ) are not sent as part of the
text or data stream transmitted or received by the terminal.
They are used to clarify the examples for the reader.
</td></tr></table>
<HR>
<H2><A NAME="Header_37" HREF="#PToC_37">Control Characters</A></H2>
<P>Certain ASCII characters are used in the network protocol
as control characters. Because binary files (files which
can contain all 256 possible 8-bit characters) can be
transferred to the terminal over the network, the protocol
defines a use of Escape characters to avoid having binary
data misinterpreted as network control characters. To make
transmission of the following control characters
<I>transparent</I> to the protocol, each character is prefixed
with an ESC (1Bh) character as it is transmitted.
Additionally, the STX character is suffixed with an ESC character.
Transparency for the ESC character itself is achieved
by transmitting two ESC characters.
<PRE>
Character Transmit As
_________ ___________
SOH (01H) ESC SOH
STX (02H) ESC STX ESC
ETX (03H) ESC ETX
NAK (15H) ESC NAK
ESC (1BH) ESC ESC
</PRE>
Any computer that transmits data to a 7524 DCT, whether RF or batch, or to
a terminal running the DCConnect Client, whether RF or batch,
must insert these
transparency characters in the data stream, and be prepared to handle
transparency characters coming back from the DCT.
<P>
The transparency characters just described are most useful
for the batch terminal although they are used in the 7524 RF and TCP/IP
terminal as well. In addition, the 7524 RF terminal does some
further encoding so that the characters in the message are
not misinterpreted as part of the framing needed to send a
message through the RF network (this additional encodeing is not
done for a TCP/IP network). The further RF encoding for
7524 RF terminals involves the following:
<UL>
<P><LI>All characters with an ASCII value less than 0x20 and
greater than 0x7E or equal to 0x5E will be encoded in two
bytes as the hex value of the character. 0x5E
(the caret (^))
is encoded by the terminal server; therefore it will be changed
so that the Norand RF controller never has to see it.
<P><LI>The tilde (~) is used as the RF encoding control character
<P><LI>Encoded characters will either be stored as a
triplet: ~xx where xx is the
hex value of the character, or as part of a run
of doublets. A run of
doublets starts with the sequence ~H and ends
with ~N. In between are
the doublets, which are two byte pairs containing
the hex value of the
character being encoded.
<P><LI>If three characters in a row need to be encoded,
then a run of doublets
should be used rather than triplets.
<P><LI>If there is alternating encoded/unencoded data
where the data could
possibly be C~XXC~XX (resulting in double expansion),
it will be more
efficient for the terminal to decode a run of doublets
for this even though
it would take four additional bytes.
</UL>
<HR>
<H2><A NAME="Header_38" HREF="#PToC_38">Maximum Message Lengths</A></H2>
<P>
In the RF environment it takes much longer to send two
messages of size X than it does to send a single message
that is twice the size of X. Therefore to maximize
performance, messages should be made as long as possible.
The preceding RF encoding guidelines allow data to be encoded so
that it is made up of characters that are not part of the RF
framing. If used correctly, it can also minimize the total
number of bytes in the final message.
<P>
The 7524 terminal has a receive buffer of 1024 bytes and thus can
accept messages of that length for both the RF and batch
versions of the terminal. However, the Norand RF controller also
has a (1024 - 7) byte limit.
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>7524 batch terminal and DCConnect Client batch terminal
</B></TD><TD><P>Messages going to
batch terminals cannot exceed 1024 bytes <B>before</B> taking
into account the escape encoding has been done for transparency.
</TD></TR><TR VALIGN=TOP><TD><P><B>7524 RF terminal
</B></TD><TD><P>Messages going to
the 7524 batch terminal
cannot exceed the 1017 bytes <B>after</B>
escape encoding has been done for transparency
and the RF encoding have been done.
<P>
The additional RF encoding is done only for messages that
are to be sent to the terminal. This allows commands, such as
to load files and set user variables, to be as large as
possible in order to get the most information into the
terminal in each message. RF encoding is not done for
messages that are sent from the terminal because most
messages from the terminal are very short. The only
potentially long message is the transaction, which
will not exceed 128 bytes.
</TD></TR><TR VALIGN=TOP><TD><P><B>DCConnect Client terminals in a TCP/IP network
</B></TD><TD><P>Messages going to a terminal running the DCConnect Client in a
TCP/IP network cannot exceed 1024 characters - including all framing
characters.
</TD></TR></TABLE>
<HR>
<H2><A NAME="Header_39" HREF="#PToC_39">Command Structure</A></H2>
<P>The following example shows a command or message from the terminal
server to one terminal with a response from the terminal
to the terminal server.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
Not shown here are the additional header fields for message sequence number,
start of message identifier and message length - all of which are not common
to all the different kinds of networked terminals supported by Extended
Terminal Services.
</td></tr></table>
<P>From terminal server:
<PRE>
=> C STX, ADDR, ADDR, CMD, text, RS, CS1, CS2, ETX
</PRE>
<P>Terminal response:
<PRE>
Error <= C NAK
Recv OK <= C ACK
Data <= C STX, text, CS1, CS2, ETX
</PRE>
<P>Terminal Server reply if data received:
<PRE>
Error => C NAK
Recv OK => C ACK
</PRE>
<P>An ACK response from the terminal after receipt of any command means
only that the terminal received the command.
CMD 1 must be
executed to determine if the last command executed properly.
If a command is buffered,
executing CMD 1 may not indicate whether the buffered command executed
properly.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
Throughout the rest of the book, the leading <B>C</B> that must be
part of every server command and terminal response will not be
shown because it is not used for batch terminals.
</td></tr></table>
<HR>
<H2><A NAME="Header_40" HREF="#PToC_40">Broadcast Command</A></H2>
There is no broadcast command method used by Extended Terminal Services.
<HR>
<H2><A NAME="Header_41" HREF="#PToC_41">Checksum Characters</A></H2>
<P>Messages transmitted and received by the terminal must have two
ASCII checksum characters (CS1, CS2) just ahead of the <B>ETX</B>
character.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The only exceptions are:
<UL COMPACT>
<LI>ACK and NAK responses
<LI>The DC1 response from the terminal when a file download
is required
<LI>The DC2 message indicating the terminal can communicate.
<LI>The DC2 nnnnn message from a terminal requesting the time
<LI>The DC3 message indicating the terminal has no transactions and
does not need a file download
</UL>
</td></tr></table>
<P>ETS will always calculate the checksum and transmit two checksum
characters (CS1, CS2).
The terminal server program may choose
to strip off or ignore them when they are received,
but it is recommended that the terminal server program calculate
the checksum, compare it to the received checksum,
and send an ACK if it is correct, or a NAK if it is incorrect.
<P>Checksum characters are calculated as follows:
<UL>
<P><LI><B>From terminal server</B>--Starting with
the first character following the STX and two address characters,
each byte up to the checksum
is added (dropping the carry). The
resulting value is converted to two ASCII characters (0-F) and
transmitted just ahead of the ETX character.
<P>For example, the terminal server requests the DCT's status:
<PRE>
=> STX, A, A, 1, 3, 1, ETX
</PRE>
<P>The ASCII value of the character '1' that follows STX A A is 0x31. So
the two checsum charactes are '3' and '1'.
<P><LI><B>From terminal</B>--Starting with
the first character following the STX character and ending before CS1,
each byte up to the checksum is added (dropping the carry).
The resulting value is converted
to two ASCII characters (0-F) and transmitted just ahead of the
ETX character.
<P>For example, the DCT responds to the terminal server's
status request:
<PRE>
<= STX, 10000A 00B90, 5, D, ETX
</PRE>
<P>
The hex values for '10000A 00B90' are added together, dropping any carry:
<PRE>
0x31 + 0x30 + 0x30 + 0x30 + 0x30 + 0x41 +
0x20 + 0x30 + 0x30 + 0x42 + 0x39 + 0x30 = 0x5D.
</PRE>
Thus the two checksum characters are '5' and 'D'.
</UL>
<P>The terminal will NAK a message it receives if the checksum
calculated by the terminal does not match the
checksum sent by the terminal server.
The checksum calculation must be done after any escape encoding is done
for transparency. However, the checksum calculation must be done before
the RF encoding that is performed on the message in 7524 RF networks.
<HR>
<H1><A NAME="HDRPFTCCC" HREF="#PToC_42">DCT Communications Control Commands</A></H1>
<P>
<P>For information about the communications control protocol
used by the ETS and an outline of the requirements for
control command structures, control characters, and communications
symbols,
(See<A HREF="#HDRCOMMPRO">Modified Communications Control Protocol 1283</A>)
The following DCT communications control commands are
used with ETS.
For a description of these commands
(See<A HREF="#HDRDETAIL">DCT Control Command Details</A>) .
<UL COMPACT>
<LI>CMD 0--Reset Terminal
<LI>CMD 1--Transmit Terminal Status to Terminal Server
<LI>CMD 2--Write to Terminal Display
<LI>CMD 3--Transmit ROM<A HREF="#FNROMDEF">(4)</A> Microcode Version and
Revision to Terminal Server
<LI>CMD 4--Set Terminal Time and Date
<LI>CMD 5--Activate Audible Tone
<LI>CMD 6--Transmit Terminal Features to Terminal Server
<LI>CMD 7--Transmit Terminal TOD<A HREF="#FNTODDEF">(5)</A>
to Terminal Server
<LI>CMD 8--Specify Current Polled Buffer of File
<LI>CMD 9x--Terminal Text or Data File Management
<LI>CMD 9A--Send File Status to Terminal Server
<LI>CMD 9B--Initialize Specified Text File
<LI>CMD 9C--Load Text File
<LI>CMD 9F--Transmit Data File Contents
<LI>CMD 9G--Erase Files
<LI>CMD A--Set Terminal In or Out of Service
<LI>CMD AnX--Set Unsolicited Transaction Flow Control
<LI>CMD B--Positive Response from Terminal Server
<LI>CMD C--Negative Response from Terminal Server
<LI>CMD D--Initiate Data Collection from Terminal Server
<LI>CMD F--Storage Query
<LI>CMD G--Execute Transaction Program in Simulated Mode
<LI>CMD I--Set User Variable
<LI>CMD IM--Set Multiple User Variables
<LI>CMD J0<A HREF="#FNNOOP">(6)</A>--Allocate RAM<A HREF="#FNRAMDEF">(7)</A> Memory Block
<LI>CMD J1<A HREF="#FNNOOP">(6)</A>--Load Data into Allocated Memory
<LI>CMD J2<A HREF="#FNNOOP">(6)</A>--Force Load Data into Memory
<LI>CMD J3<A HREF="#FNNOOP">(6)</A>--Start Memory Dump
<LI>CMD J4<A HREF="#FNNOOP">(6)</A>--Halt and Wait for Next Command
<LI>CMD J5<A HREF="#FNNOOP">(6)</A>--Start Program Execution
<LI>CMD J6<A HREF="#FNNOOP">(6)</A>--Terminal Error
Return (Response Only)
<LI>CMD J7<A HREF="#FNNOOP">(6)</A>--Send Next Data
Dump Record
<LI>CMD J8<A HREF="#FNNOOP">(6)</A>--Terminal
Unavailable (Response Only)
<LI>CMD J9--Configuration Query.
<LI>CMD K--Transaction Release
<LI>CMD L--Loopback test
<LI>CMD MA--Request CFR Status
<LI>CMD MB--Allocate Space for CFR
<LI>CMD MC--Load CFR Image
<LI>CMD MD--Start CFR
<LI>CMD NA--Send Validation Status to the Host
<LI>CMD NB--Initialize Specified Validation File
<LI>CMD NC--Load Validation File
<LI>CMD ND--Validation File Load Complete
<LI>CMD O--Write to Display with Attributes
<LI>CMD Q--Query (Read) User Variable
<LI>CMD V--Positive or Negative Response to Remote Validation
</UL>
<HR>
<H2><A NAME="HDRCMDPRI" HREF="#PToC_43">Command Processing Rules</A></H2>
<P>This section specifies the rules for processing commands.
For command descriptions,
(See<A HREF="#HDRDETAIL">DCT Control Command Details</A>) .
<P>General command processing rules are as follows:
<UL>
<P><LI>When the terminal is <I>out of service</I>,
only file operations can be processed.
<P><B>Notes: </B><OL>
<P><LI><I>Out of Service</I> means that
operator interaction with the terminal is not permitted, but
the terminal can still communicate with the terminal server.
<P>
In the past, the term 'offline' was used to mean 'out of service'.
<P>
If the IBM DOS Data Collector is installed, <I>offline</I>
means the terminal is not being polled by the Data Collector,
and <I>disabled</I> means that no
operator interaction with the terminal is permitted (out of service), but
the terminal can still communicate with the terminal server.
<P><LI><I>In Service</I> means the terminal will accept data
from the operator and the terminal server.
<P>
In the past, the term 'online' was used to mean 'in service'.
<P>
If the IBM DOS Data Collector is installed, <I>online</I>
means the terminal is being polled by the Data Collector,
and <I>enabled</I> means the terminal will accept data
from the operator and the terminal server (in service).
</OL>
<P><LI>All other terminal server commands are carried out immediately,
provided that they do not interrupt a current transaction.
Otherwise, the turnaround is usually within 100 milliseconds.
However, CMD D (initiate data collection from terminal server)
and CMD G (execute transaction program in simulated mode)
take longer to process.
</UL>
<P>
In this chapter there are references to 'polling' and 'not polling' of the
terminal by the terminal server. In the strictest sense, 'polling' is the
terminal server asking the terminal whether it has transactions by sending
a poll command. However, in the RF and TCP/IP networks, the terminal server
does not send poll commands to the terminal; the terminal is able to send a
transaction to the terminal server, asynchronously, without having to wait
for any command to reply to with the transaction. However, the terminal
server can send commands to a networked terminal to tell it whether or
not it is allowed to send transactions at all.
<P>
So networked terminals are considered to be 'polled' if the terminal has been
told it is allowed to send transactions. Conversely, networked terminals are
considered to be 'not polled' if they have been told by the terminal server
not to send any transactions.
<HR>
<H2><A NAME="HDRDETAIL" HREF="#PToC_44">DCT Control Command Details</A></H2>
<P>This section describes the DCT communications control
commands listed at the beginning of this chapter.
The proper format for each command is specified, and
additional information is provided where necessary.
<P><B>Notes: </B><OL>
<P><LI>All commands are for use in the batch and RF / TCP/IP networked
terminals except where explicitly
noted.
<P><LI>The commands are shown as they should be
formatted for the batch
terminal. For the 7524 RF terminal and other networked terminals, every
command and response would be
preceded with the header character C, even
though it is never shown in this
chapter.
<P><LI>In the command descriptions, the parentheses,
commas (,) or spaces ( ) are not sent as part of the
text or data stream transmitted or received by the terminal.
They are used to clarify the examples for the reader.
</OL>
<P>
<H3><A NAME="HDRCMD0SET" HREF="#PToC_45">CMD 0--Reset Terminal</A></H3>
<P>This command resets the DCT, halts running
applications, and reinitializes memory allocations.
All terminal files are deleted and the terminal will request a load
of all files.
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, 0, CS1, CS2, ETX
</PRE>
<P>There is no terminal response.
<P>
<H3><A NAME="HDRCMD1STA" HREF="#PToC_46">CMD 1--Transmit Terminal Status to Terminal Server</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, 1, CS1, CS2, ETX
<= STX, data, CS1, CS2, ETX
</PRE>
<P>
The <B>data</B> portion consists of a string of 12 ASCII characters
that define the terminal, as follows:
<PRE>
Character Description
1 0 Normal state
1 First status request since POST completed
2 0 Last command executed correctly
1 Last command did not execute correctly
3 0 Required file download is present
1 File download required
4 0 Terminal is in service
1 Terminal is out of service
5 0 All commands since last CMD 1 executed correctly
1 Command failure occurred since last CMD 1
6, 7 cc Identifies command for status information.
Character 7 is a blank (ASCII space) for single
character commands.
8, 9 00 Last command OK
0f Last command OK (f = files 0-e, v = extended
validation file)
10 Invalid command
20 Invalid text or format
2f Invalid text or format (f = files 0-e,
v = extended validation file)
3f File overrun (no space)
4f File not initialized
69 Invalid attempt to initialize file 9
6f Invalid attempt to initialize file <B>f</B> due
to memory constraints
7f Still processing command (f = files 0-e,
v = extended validation file)
80 Last command ignored because terminal in wrong state
10, 11 ff Identifies current polled data file
12 0 No data in transaction queue
1 Data exists in transaction queue
</PRE>
<P>
<H3><A NAME="HDRCMD2WRT" HREF="#PToC_47">CMD 2--Write to Terminal Display</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, text, CS1, CS2, ETX
<= ACK or NAK
</PRE>
<P>The <B>text</B> refers to ASCII characters to be displayed in the
sequence sent. Space characters show as blanks on the display.
Normally, the data written to the display will remain until Timer
<B>B</B> count has expired as specified in File 0.
This command refreshes the display.
<P>Although terminals with 7524 ETS flash or those running the DCConnect
Client may have many different font sizes and view port sizes
(affecting the number of rows and columns of text which can
be shown at one time on the display), ETS always maintains a
20-line by 40-character virtual display in memory. The operator may
move the visible window of the display around so that all
areas of this
virtual display size may be viewed.
<P>
In this host command, use ASCII
DC2 as the first character of the text
to allow the characters on the screen
to remain unaffected by Timer <B>B</B> message display time out.
<P>
To prevent disturbing normal transaction display messages,
this command is handled only during terminal idle cycles.
If the terminal is not idle,
the command is buffered to be executed when the terminal is idle.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
<I>Idle</I> refers to a terminal state in which the
terminal is operating but not active; that is, the terminal
may be receiving commands and sending replies, but is waiting for
the operator to initiate a transaction.
</td></tr></table>
<P>
<H3><A NAME="HDRCMD3ROM" HREF="#PToC_48">CMD 3--Transmit ROM Microcode Version and Revision to Terminal Server</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, 3, CS1, CS2, ETX
<= STX, data, CS1, CS2, ETX
</PRE>
<P>The <B>data</B> portion consists of a string of four ASCII
characters defining the terminal ROM microcode where:
<DL COMPACT>
<DD>Characters 1 and 2 = ROM microcode version number
<DD>Characters 3 and 4 = ROM microcode revision number.
</DL>
<P>For example, <I>0101</I> means <I>version 01, revision 01</I>.
<P>
<H3><A NAME="HDRCMD4TIM" HREF="#PToC_49">CMD 4--Set Terminal Time and Date</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, 4, text, CS1, CS2, ETX
<= ACK or NAK
</PRE>
<P>The <B>text</B> refers to 12 ASCII numeric characters in the
following format using the 24-hour clock: YYMMDDHHMMSS.
<P>
For networked terminals, CMD 4 can also be used in response to a time
request (DC2 nnnnn) from the terminal. Because of the possiblity of
delays in the network or the set time command being buffered in an RF
controller, when the terminal receives the normal CMD 4, it does not
know when that command actually left the terminal server.
<P>
So in order to make sure the time is set reasonably accurately, the
terminal issues a time request to the terminal server (DC2 nnnnn) filling
in a sequence number. It then waits for the response, keeping track of
how long it takes. Right now it will wait up to 7 seconds for the
response.
<P>
The syntax for the response to the time request is the normal CMD 4 with
the 5 digit sequence number 'nnnnn' inserted after the date/time string
and before the checksum. The checksum calculation includes the sequence
number. The terminal server must copy the sequence number from the time
request to the response CMD 4.
<P>
When the terminal receives the CMD 4 that includes the sequence number, it
makes sure sequence number matches the one it used in its last request and
it makes sure the 7 second timeout has not expired since that request was
sent. If the sequence number is correct and the timeout hasn't expired,
the terminal sets its clock based on the time in the command. Otherwise
it will increment the sequence number and issue the request again.
<P>
The terminal will not send an ACK or NAK in response to the CMD 4 that
contains the 5 digit sequence number in it.
<P>
The following example illustrates the sequence. The STX, ADDR, CS1, CS2 and
ETX characters are not shown in this example.
<PRE>
=> 4030100190605 - Normal server command to set time to
3/1/2000 19:06:05
<= <ACK> - Terminal sends back ACK, although it hasn't
acted on the set time command since it
doesn't know when it left the server.
<= <DC2> 00001 - Terminal sends time request (on 'X' channel)
using 00001 as the sequenc number
... - Due to network delay, 10 seconds elapse
=> 403010019061500001 - Server replies to time request with new set
time command for 3/1/2000 19:06:15 using the
00001 sequence number from the time request
<= <DC2> 00002 - Because of the delay, the terminal sends
another time request after incrementing the
sequence number to 00002
=> 403010019061800002 - Server replies to time request with new set
time command for 3/1/2000 19:06:18 using the
00002 sequence number
... - Terminal acts on this set time command, because
only 3 seconds have elapsed. This exchange
is now complete.
</PRE>
<P>
<H3><A NAME="HDRCMD5AUD" HREF="#PToC_50">CMD 5--Activate Terminal Audible Tone</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, 5, text, RS, CS1, CS2, ETX
<= ACK or NAK
</PRE>
<P>The <B>text</B> refers to an ASCII numeric character
(1-9) that relates to a tone duration. The value of the
<B>text</B> multiplied
by 0.5 second determines the duration of the tone.
<P>To prevent disturbance during normal transactions, this
command will be handled only during terminal idle cycles.
If the terminal is not idle, an ACK is returned to the terminal
server, and this command is ignored.
<P>
Depending on the type of terminal that ETS is running on,
ETS may not observe the duration specified in the command;
the duration of the tone may always be the same regardless
of the <B>text</B> specified.
<P>
<H3><A NAME="HDRCMD6FEA" HREF="#PToC_51">CMD 6--Transmit Terminal Features to Terminal Server</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, 6, CS1, CS2, ETX
<= STX, data, CS1, CS2, ETX
</PRE>
<P>The <B>data</B> is a string of five ASCII characters that define
the terminal's features, as follows:
<DL>
<DD><P>Char 1 = Display size:
<PRE>
1 = 2L x 40W alphanumeric
<B><I>2 = APA graphics</I></B>
4 = 1L x 32W alphanumeric
5 = 1L x 40W alphanumeric.
</PRE>
<DD><P>Char 2 = RAM storage size:
<PRE>
<B><I>5 = 128Kb</I></B>
6 = 256Kb
7 = 384Kb.
</PRE>
<DD><P>Char 3 = TOD clock:
<PRE>
1 = Clock installed.
</PRE>
<DD><P>Char 4 = Auxiliary ASCII port:
<PRE>
1 = Installed.
</PRE>
<DD><P>Char 5 = Printer port/DIDO<A HREF="#FNDIDODEF">(8)</A>
port switch setting:
<PRE>
0 = Printer
1 = DIDO port.
</PRE>
</DL>
<P>
The terminal always sets the display size=2,
RAM size=5,
TOD clock=1, Auxilliary ASCII port=1, Printer port=0.
Some of these values may not be entirely accurate for the hardware
the terminal actually has.
<P>
<H3><A NAME="HDRCMD7TOD" HREF="#PToC_52">CMD 7--Transmit Terminal TOD to Terminal Server</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, 7, CS1, CS2, ETX
<= STX, data, CS1, CS2, ETX
</PRE>
<P>
The <B>data</B> refers to the current terminal time and date using
the same format as CMD 4 (YYMMDDHHMMSS).
<P>
<H3><A NAME="HDRCMD8POL" HREF="#PToC_53">CMD 8--Specify Current Polled Buffer or File</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, 8, text, RS, CS1, CS2, ETX
<= ACK or NAK
</PRE>
<P>The <B>text</B> contains one to three ASCII characters
that specify the currently polled buffer or file
and the number of data records to be transmitted on a poll.
The following ASCII characters are valid parameters
for the <B>text</B> portion of CMD 8:
<DL>
<DD><P>A = Specifies interactive/buffered mode,
which holds only one record
at a time. The terminal will switch to buffered mode when
the terminal server is not polling the terminal; that is,
if the transaction is not processed within the time limit specified by
Timer <B>A</B>.
<DD><P>C = Specifies interactive mode, which holds only one record
at a time. The terminal will go out of service and not allow any
data to be entered when the terminal server is not polling
the terminal.
<DD><P>B9n = Specifies the polled File 9, which will buffer multiple
records.
<DL COMPACT>
n = Number of records to be returned on a poll
(maximum 129 bytes), where n must be an integer between 1 and 9.
</DL>
</DL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
ETS allows only <B>n</B> to be set to 1.
</td></tr></table>
<P>When the terminal is switched to buffered mode,
the terminal server must poll all the buffered
transaction records out of the terminal before
the terminal will switch back to interactive mode.
If the terminal is switched to interactive mode
without polling all the buffered
transactions from File 9, the terminal will transmit
all buffered transactions before any interactive transactions are
transmitted.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
When specifying the currently polled buffer or file, it is not
necessary to take the terminal out of service prior to the execution of this
command. If the terminal is in the middle of a transaction, the ACK is
sent and the command is buffered. The command is executed when the
transaction is completed and will go into effect for the following
transaction.
</td></tr></table>
<P>
<H3><A NAME="HDRCMD9XTX" HREF="#PToC_54">CMD 9x--Terminal Text or Data File Management</A></H3>
<P>The 9x commands are used to initialize and manage up to 14 text
or data files.
Records in these files can be of variable length.
An ASCII record separator (RS) must be used between records.
This series of commands allows the terminal server
to perform the following:
<DL>
<DD><P>CMD 9A--Send file status to terminal server
<DD><P>CMD 9B--Initialize text file
<DD><P>CMD 9C--Load text file
<DD><P>CMD 9F--Transmit data file contents to terminal server
<DD><P>CMD 9G--Erase files.
</DL>
<P>Status should be queried (CMD 1) after each text or
data file command (9x) to verify that the command was executed properly.
<P>
<H3><A NAME="HDRCMD9AFS" HREF="#PToC_55">CMD 9A--Send File Status to Terminal Server</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, 9A, f, RS, CS1, CS2, ETX
<= STX, f, data, CS1, CS2, ETX
</PRE>
<P>The <B>f</B> represents the file number (0-9,
a-b, d-e).
<P>The <B>data</B> portion consists of a fixed length string of ASCII
characters that indicate the status of the specified file.
<P>The format is: aaaaauuuuudp
<P>Where:
<DL COMPACT>
<DD>aaaaa = Number of bytes reserved by previous CMD 9B
(00001-65536).
<DD>uuuuu = Number of bytes not used (In TS mode, this becomes 00000
after the terminal is put In Service via CMD A.)
<DD>d = Text type specified
<DL COMPACT>
<DD>1 = Non-compacted alphanumeric text.
</DL>
<DD>p = Type of text file
<DL COMPACT>
<DD>0 = Non-polled file
<DD>1 = Polled file.
</DL>
</DL>
The number of bytes returned in aaaaa and uuuuu can be formatted
in one of two ways:
<OL>
<P><LI>Five digits as the number of bytes
<P><LI>If the file size is larger than 99999 bytes, then the first character is a
letter indicating a multiple of 65536 bytes; A=65536, B=131072, ...
<P>
The remaining 4 characters make up a hex number from 0x0000 to 0xffff which
should be added to the multiple of 65536 bytes specified by the first byte.
The sum of these two values is the actual size.
</OL>
In TS mode, five digits are always returned.
If the file is above 99999, 99999 is still returned.
<P>
<H3><A NAME="HDRCMD9BIN" HREF="#PToC_56">CMD 9B--Initialize Specified Text File</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, 9B, f, text, RS, CS1, CS2, ETX
<= ACK or NAK
</PRE>
<P>The <B>f</B> is a the file number (0-9,
a-b, d-e).
<P>The <B>text</B> is a fixed length string of ASCII characters that
initializes a specified text file, reserves file space, and defines
file characteristics.
<P>The format is: llllldtrsfrrrrr
<P>Where:
<DL>
<DD><P>lllll = File space to be reserved in bytes.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
If file 9 (transaction queue)
is the file being initialized, the size is ignored because ETS specifies the
size of the transaction queue as a number of transactions rather than a number
of bytes. For 7524 ETS, the number of transaction is fixed. For the
DCConnect Client, the number of transactions can be set by the MAX_TRANSACTIONS
keyword in its configuration. See the DCConnect Client User's Guide for more
information.
</td></tr></table>
<P>
The file size can be formatted in one of two ways:
<OL>
<P><LI>Five digits as the number of bytes
<P><LI>If the file size is larger than 99999 bytes, then the first character is a
letter indicating a multiple of 65536 bytes; A=65536, B=131072, ...
<P>
The remaining 4 characters make up a hex number from 0x0000 to 0xffff which
should be added to the multiple of 65536 bytes specified by the first byte.
The sum of these two values is the actual size.
</OL>
<DD><P>dtr = Reserved
<DD><P>s = Sorted attribute
<DL COMPACT>
<DD>0 = Not sorted
<DD>1 = Sorted.
</DL>
<DD><P>f = Fixed length attribute
<DL COMPACT>
<DD>0 = Variable length
<DD>1 = Fixed length.
</DL>
<DD><P>rrrrr = Record count for variable length
and length of record for fixed length.
</DL>
<P>
No binary data is allowed in a variable length record except
for File 8
(message file).
<P>It is necessary to initialize all files (even File 9) before
downloading or redownloading them, so that the required storage
will be allocated.
<P><B>Notes: </B><OL>
<P><LI>The DCT must be set out of service (via CMD A) before CMD 9B can
be executed.
<P><LI>The maximum size of any validation file is 64K.
<P><LI>The initialization of any file (except file 9) to zero
deletes the
file from the DCT.
</OL>
<P>
<H3><A NAME="HDRCMD9CLD" HREF="#PToC_57">CMD 9C--Load Text File</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, 9C, f, text, CS1, CS2, ETX
<= ACK or NAK
</PRE>
<P>The <B>f</B> represents the file number
(0-8, a-b,
d-e).
<P>The <B>text</B> refers to variable length records.
The end of a variable length record is indicated by
an <B>RS</B>.
<P>This will load text records into a specified file
(0-8, a-b, d-e).
Repeat the CMD 9C string to load the file.
Text records may be variable
in length and can be in multiple communications records.
This eliminates the restriction that a text
record must have a maximum length based on the
communication record size.
An <B>RS</B> must be entered between the different
text records and at the end of the last text record submitted.
Spaces are allowed between characters.
<P>CMD 9C is valid only with non-polled files.
Any attempt to load text to File 9 will be rejected,
and status character 8 will be set to 1.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The DCT must be set out of service (via CMD A) before CMD 9C can be executed.
</td></tr></table>
<P>
<H3><A NAME="Header_58" HREF="#PToC_58">CMD 9F--Transmit Data File Contents to Terminal Server</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,9F,fff..ff,(RS),rrrr,CS1,CS2,ETX
<= STX,nnn,data,CS1,CS2,ETX
</PRE>
The <B>fff..ff</B> refers to the file, "0" -
"8", "a", "b", "d", "e", or an up to
12 character
extended validation file name. The <B>RS</B> is
present only if the file name is an extended
validation file name, it is not present for
the basic ETS files "0" - "8",
"a", "b", "d", and
"e".
This provides a way to distinguish extended validation
files that may have a single character name
that is the same as a basic file name.
The <B>rrrr</B> is the file record being requested.
Each record is a 100 byte block of the file,
record numbers are in the range of 0000 to 3999.
<P>
The <B>nnn</B> refers to the number (three ASCII
characters) of data bytes being returned (0 to 100)
and is the number of bytes following in the <B>data</B> parameter.
The only time <B>nnn</B> should be less than 100 is when fewer than
100 bytes are available for the record number requested.
If <B>nnn</B> is "000" for record "0000" then the file is empty.
If <B>nnn</B> is "UUU" then the file is uninitialized.
If <B>nnn</B> is "RRR" then the requested record is out
of range for the file requested.
If <B>nnn</B> is "000", "UUU", or "RRR"
then no data is
returned.
<P>
The <B>data</B> refers to the data for the record.
The <B>data</B> that is returned is in the form that
the files are stored by ETS in the terminal.
This command is used when
the text files, "0" - "8", "a", "b",
"e", and
the extended validation files, need to be
restored by the terminal server.
When the files are sent to ETS, "ESC RS" allows the RS to be
imbedded in the text, and the ESC is removed by ETS.
RS characters that are not preceded by ESC are record separators
and are replaced by nulls for use by ETS.
For the terminal server to do
the restoration, all RS characters (ASCII
record separator) need to be preceded by an
ESC (ASCII escape), and then all nulls (00)
need to be replaced by an RS.
No restoration is required for ETS file "d" since it is not
a text file and is stored and used in its original form.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
If this command is executed on a file that has been resized in a
mode 2 CFR, <B>nnn</B> is always "000", even if data
has been written to the file with the CFR.
</td></tr></table>
<P>
<H3><A NAME="Header_59" HREF="#PToC_59">CMD 9G--Erase Files</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,9G,f,CS1,CS2,ETX
<= ACK or NAK
</PRE>
The <B>f</B> represents which set of files to erase.
<PRE>
0 = delete all validation files (extended and files 2-7)
1 = delete all validation files plus files 0, 1, 8, a, b, d, e,
(file c, CFR, is deleted separately by CMD MB)
</PRE>
<P>The terminal must be set out of service and the transaction queue
(file 9) empty in order to execute this command.
<P>
<H3><A NAME="HDRCMDALIN" HREF="#PToC_60">CMD A--Set Terminal In Service or Out of Service</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, A, text, CS1, CS2, ETX
<= ACK or NAK
</PRE>
<P>
The <B>text</B> is ASCII zero for setting the
terminal out of service, and ASCII one for setting the terminal in service.
<P>When out of service, the display will show the
<B>OUT OF SERVICE</B>
message (in File 8). The terminal will be out of service and transaction
programs cannot be run. The executing transaction will be
aborted.
<P>
<H3><A NAME="HDRCMDALIX" HREF="#PToC_61">CMD AnX--Set Unsolicited Transaction Flow Control</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, A, text, X, CS1, CS2, ETX
</PRE>
<P>There is no terminal response.
<P>
The <B>text</B> is ASCII zero for setting the
terminal's transaction sending state to "off" (do not send
transactions),
and ASCII one for setting the flag to "on".
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
These commands are available only for the RF or TCP/IP networked terminals.
</td></tr></table>
<P>
For details on how transaction flow control works,
(See<A HREF="#HDRUNSMF">Unsolicited Message Flow Control</A>) .
<P>
<H3><A NAME="HDRCMDBPOS" HREF="#PToC_62">CMD B--Positive Response from Terminal Server</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, B, text, RS, CS1, CS2, ETX
<= ACK or NAK
</PRE>
<P>
The <B>text</B> is a string of ASCII characters used to control the
audible tone and write messages to the display. STX and ETX cannot be
used in the text string.
<P>
The first character controls audible tone:
<DL COMPACT>
<DD>0 = No tone, prompt timeout after Timer B
<DD>1 = Tone, prompt timeout after Timer B
<DD>2 = No tone, no prompt timeout
<DD>3 = Tone, no prompt timeout.
</DL>
<P>
The second character defines the display source:
<DL>
<DD><P>0 = No message to display
<DD><P>1HELLO(RS) = Write message <B>HELLO</B> to display. Message
must end with a record separator (<I>RS</I>).
<DD><P>2flllll = Write record at <B>lllll</B> in File f to the display
<DL COMPACT>
<DD>f = File number (2-8)
<DD>lllll = Record location (00000-99999) within the file.
</DL>
</DL>
<P>The following example gives audible tone for a valid
transaction and writes <B>ACCEPT</B> to the display:
<DL COMPACT>
<DD>B11ACCEPT(RS)
</DL>
<P>The following example activates audible tone for a valid transaction
and writes record 3 of File 4 to the display:
<DL COMPACT>
<DD>B32400003(RS)
</DL>
<P><B>Notes: </B><OL>
<P><LI>The use of CMD B will be handled only when the terminal is
waiting for
an interactive response
(that is, when DCT is waiting for a response in interactive
mode to acknowledge receipt of a transaction record).
<P><LI>If "no prompt timeout" and "no message to display" are
chosen, then the no timeout is ignored.
</OL>
<P>
<H3><A NAME="HDRCMDCNEG" HREF="#PToC_63">CMD C--Negative Response from Terminal Server</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, C, text, RS, CS1, CS2, ETX
<= ACK or NAK
</PRE>
<P>
The <B>text</B> is a string of ASCII characters used to control the
audible tone and write messages to the display.
STX and ETX characters cannot be used in the text string.
<P>The first character controls audible tone:
<DL COMPACT>
<DD>0 = No tone, prompt timeout after Timer B
<DD>1 = Tone, prompt timeout after Timer B
<DD>2 = No tone, no prompt timeout
<DD>3 = Tone, no prompt timeout.
</DL>
<P>The second character defines the display source:
<DL>
<DD><P>0 = No message to display
<DD><P>1HELLO(RS) = Write message <B>HELLO</B> to display.
Message must end
with a record separator (<I>RS</I>).
<DD><P>2flllll = Write record at <B>lllll</B> in File <B>f</B>
to the display
<DL COMPACT>
<DD>f = File number (2-8)
<DD>lllll = Record location (00000-99999) within the file.
</DL>
</DL>
<P>The following example activates tone for invalid transaction and
writes <B>NOT ACCEPTED</B> to the display:
<DL COMPACT>
<DD>C11NOT ACCEPTED(RS)
</DL>
<P>The following example activates tones for an invalid
transaction and writes record 3 in File 4 to the display:
<DL COMPACT>
<DD>C12400003
</DL>
<P><B>Notes: </B><OL>
<P><LI>
The use of CMD C will be handled only when the terminal is waiting for
an interactive response
(that is, when DCT is waiting for a response in interactive
mode to acknowledge receipt of a transaction record).
<P><LI>If "no prompt timeout" and "no message to display" are
chosen, then the no timeout is ignored.
</OL>
<P>
<H3><A NAME="HDRCMDDIDC" HREF="#PToC_64">CMD D--Initiate Data Collection from Terminal Server</A></H3>
<P>This command allows the terminal server to initiate a data
collection transaction program with the terminal. CMD D
can have multiple key commands appended to it. These may include
all of the command set plus the <B>:6</B> command.
CMD D allows command sequences that are
longer than one communications packet.
For ETS compatible operation - if the terminating
record separator character (RS) is not
present in a CMD D, the continuation of the
command is assumed to follow in the next CMD D.
The command sequence is buffered (up to
512 bytes) until the RS is found in a following CMD D.
For TS compatible operation - a CMD D without a terminating RS
will generate an error transaction.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
<B>:6(ctextc)</B>
is a key command used only in this command;
<B>(text)</B> is the message to be displayed.
</td></tr></table>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, D, key commands, RS, CS1, CS2, ETX
<= ACK or NAK
</PRE>
<P>In interactive or interactive/buffered mode, CMD D (as well
as CMD B, CMD C, or CMD 2) will be accepted by the terminal
to complete a transaction. This provides the flexibility of using
the terminal in a fully interactive mode, allowing the
terminal server to control each step in the data collection process.
<P>Transactions created with CMD D contain a function ID of
<B>FD</B>.
If a CMD 1 (status) is done, character 8 will have a value of
'7'
which indicates a 'pending' status until the completion of the
CMD D transaction.
<P>Example:
<PRE>
=> STX, ADDR, ADDR, D:010:11000:6*Enter Dept*:20500, RS, CS1, CS2, ETX
<= ACK
</PRE>
<P>The preceding example generates a transaction from the terminal.
A
prompt is displayed (File 8 record 10) with a 10-character badge
read expected. Next, <B>Enter Dept</B> is displayed with a
five-character numeric input expected. The resulting transaction may be
polled from the terminal.
<P><B>Notes: </B><OL>
<P><LI>
To prevent disturbance during normal transactions, the use of
CMD D will be handled only during terminal idle cycles.
<P><LI>Use CMD 1 to verify it completed successfully (characters 8 and 9).
</OL>
<P>
<H3><A NAME="HDRCMDFSTO" HREF="#PToC_65">CMD F--Storage Query</A></H3>
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, F, RS, CS1, CS2, ETX
<= STX, data, CS1, CS2, ETX
</PRE>
The <B>data</B> is a string of 12 ASCII characters defining the
memory status of the DCT. The first 6 bytes give the number of
bytes of memory left in the DCT and
the second 6 bytes give the number of bytes
of the largest contiguous block of memory in the DCT. Both
fields are right-justified and padded on the left with ASCII zeroes.
<P>
<H3><A NAME="HDRCMDGEVN" HREF="#PToC_66">CMD G--Execute Transaction Program in Simulated Mode</A></H3>
<P>This command allows the user to simulate an <I>event</I> on
the DCT and execute the transaction program associated with the event
without the event actually happening. (An <I>event</I> is
any activity that can cause a transaction program to be executed.
For further details about events,
(See<A HREF="#HDRFIL0DSC">File 0--Terminal Operating Parameters/Program Storage</A>) .
Instead of the event actually
happening (for example, the user presses F1 on the DCT),
the user can issue this
command to set the event remotely (create a simulated event).
<P>
Once the event has been set, processing of the event will take place in
the same manner as if the real event had occurred and transaction
record(s) will be created as defined by the transaction program or as
defined by the system.
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, G, function ID, RS, CS1, CS2, ETX
<= ACK or NAK
</PRE>
<P>The <B>function ID</B> is a two-byte ASCII field that represents
a hex value. This value is the same as the function ID field listed in
<A HREF="#TBLFIDS">Table 10</A>
and described in the format of a transaction record in File 9,
(See<A HREF="#HDRFUNID">File 9--Transaction Queue File</A>) .
<P><B>Notes: </B><OL>
<P><LI>To prevent disturbance during normal transactions, the use of
CMD G will be handled only during terminal idle cycles.
<P><LI>Use CMD 1 to verify successful completion.
</OL>
<P>
<H3><A NAME="Header_67" HREF="#PToC_67">CMD I--Set User Variable</A></H3>
<P>
This command sets a global user variable on the DCT; the user variable is
cleared before the data is copied into it.
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,I,text,CS1,CS2,ETX
<= ACK or NAK
</PRE>
The <B>text</B>, nnnccc....cc, refers to:
nnn = user variable number (010 - 099)
ccc....cc = characters to set in user variable, 118 bytes maximum
<P>
<H3><A NAME="Header_68" HREF="#PToC_68">CMD IM--Set Multiple User Variables</A></H3>
<P>
This command sets one or more user variables in the DCT.
The previous values
of all affected user variables are not preserved.
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR, IM, text, CS1, CS2, ETX
<= ACK or NAK
The <B>text</B>, nnnlllccc....cc, RS, nnnlllccc....cc, RS, ... refers to:
nnn = user variable number (010-099)
lll = length of data for the specified user variable
ccc....cc = character data to which the user variable should be set
</PRE>
<P>
The nnnlllccc....cc, RS sequence can be repeated for as
many variables that
need to be set. The variables are set in the order that
they are presented in
the command. The total length of a single IM command
cannot exceed 472 bytes.
<P>
This command is useful in an RF network because it takes much
longer to set multiple user variables using
separate commands than it does to
set them in one command.
<P>
This command will return NAK if any error occurs.
There is no need to send CMD 1 to verify its success.
<P>
<H3><A NAME="HDRCMDJ0MB" HREF="#PToC_69">CMD J0--Allocate RAM Memory Block</A></H3>
<P><B>Note: </B>The 7524 ETS flash / DCConnect Client cannot be loaded into the
terminal using the Jx commands. ETS does not ever load itself; it expects
that do be done outside of its operations.
<P>
7524 ETS is loaded into semi-permanent FLASH ROM
via the process described in
(See<A HREF="#HDRINSTALL">Installing and Downloading the 7524 Extended Terminal Services Flash</A>)
For compatibility
with existing data collection control software,
ETS will respond to the Jx loading commands with
dummy data intended to make the terminal server believe that the
download is working. The data sent to the terminal is discarded.
<P>
For reference only, the function of the command in a 7527 context is
reproduced below.
<P>This command provides a method to allocate RAM
for ETS to be loaded into.
When CMD J0 is executed with the size parameter equal to the length of
ETS in paragraphs,
and assuming RAM is available for allocation, the start
segment address is returned in the address portion of the reply.
This value is used to fix the ETS load module address to be
compatible with the relative load address.
If CMD J0 is executed with size = 0, then no memory is allocated,
but the first
available starting segment address is returned in the address.
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, J0, size, CS1, CS2, ETX
<= STX, J0, address, size, CS1, CS2, ETX
=> ACK or NAK
</PRE>
<P>The <B>size</B> is a two-byte hex
variable, expressed in paragraphs, that defines the number of bytes
to be allocated.
The returned <B>size</B> is the size allocated, if available,
or the largest block available, if there is not enough memory.
<P>The <B>address</B> is a two-byte hex
segment address, expressed in paragraphs, returned from the terminal.
<P>
<H3><A NAME="HDRCMDJ1LD" HREF="#PToC_70">CMD J1--Load Data into Allocated Memory</A></H3>
<P><B>Note: </B>The 7524 ETS flash / DCConnect Client cannot be loaded into the
terminal using the Jx commands. ETS does not ever load itself; it expects
that do be done outside of its operations.
<P>
7524 ETS is loaded into semi-permanent FLASH ROM
via the process described in
(See<A HREF="#HDRINSTALL">Installing and Downloading the 7524 Extended Terminal Services Flash</A>)
For compatibility
with existing data collection control software,
ETS will respond to the Jx loading commands with
dummy data intended to make the terminal server believe that the
download is working. The data sent to the terminal is discarded.
<P>
For reference only, the function of the command in a 7527 context is
reproduced below.
<P>
This command loads the program or data into RAM in the space previously
allocated by CMD J0.
The maximum data length is 128 bytes which includes control characters
plus the address and length parameters;
therefore,the maximum data length is 112 bytes.
Most J1 commands must be limited to 112 bytes because the loads
are done on paragraph boundaries (16 bytes).
This command is repeated until the program is completely loaded.
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR,J1, address, length, data, CS1, CS2, ETX
<= STX, J1, address, size, CS1, CS2, ETX
=> ACK or NAK
</PRE>
<P>The <B>address</B> is a two-byte hex
segment address, expressed in paragraphs, of the RAM area to be
loaded, or the area that was last loaded. Zero is returned
if an error occurred during this load command.
<P>The <B>length</B> refers to the length of data in the link frame.
It consists of two hex bytes.
<P>The <B>data</B> is to be loaded into RAM.
It consists of hex bytes.
<P>The <B>size</B> refers to the
amount of RAM remaining in the allocated area.
It consists of two hex bytes, expressed in paragraphs.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
This command requires allocated memory prior to loading data or a
program into the terminal's RAM.
</td></tr></table>
<P>
<H3><A NAME="HDRCMDJ2FL" HREF="#PToC_71">CMD J2--Force Load Data into Memory</A></H3>
<P><B>Note: </B>The 7524 ETS flash / DCConnect Client cannot be loaded into the
terminal using the Jx commands. ETS does not ever load itself; it expects
that do be done outside of its operations.
<P>
7524 ETS is loaded into semi-permanent FLASH ROM
via the process described in
(See<A HREF="#HDRINSTALL">Installing and Downloading the 7524 Extended Terminal Services Flash</A>)
For compatibility
with existing data collection control software,
ETS will respond to the Jx loading commands with
dummy data intended to make the terminal server believe that the
download is working. The data sent to the terminal is discarded.
<P>
For reference only, the function of the command in a 7527 context is
reproduced below.
<P>Previous allocation of RAM is not required to execute this command.
Program or data modules are written into allocated or unallocated RAM.
This command can also be executed while ETS is running.
<B>Warning:</B>
Data and program areas can be overwritten by this command.
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, J2, address, length, data, CS1, CS2, ETX
<= STX, J2, address, CS1, CS2, ETX
=> ACK or NAK
</PRE>
<P>The <B>address</B> refers to the segment address of the
RAM area to be loaded.
It consists of two hex bytes, expressed in paragraphs.
<P>The <B>length</B> represents the length of data in the link frame.
It consists of two hex bytes.
<P>The <B>data</B> is to be loaded into RAM.
It consists of hex bytes.
<P><B>Note: </B>This command forces data or the program into the terminal's RAM without
regard to any previous memory allocation.
<P>
<H3><A NAME="HDRCMDJ3SD" HREF="#PToC_72">CMD J3--Start Memory Dump</A></H3>
<P><B>Note: </B>The 7524 ETS flash / DCConnect Client cannot be loaded into the
terminal using the Jx commands. ETS does not ever load itself; it expects
that do be done outside of its operations.
<P>
7524 ETS is loaded into semi-permanent FLASH ROM
via the process described in
(See<A HREF="#HDRINSTALL">Installing and Downloading the 7524 Extended Terminal Services Flash</A>)
For compatibility
with existing data collection control software,
ETS will respond to the Jx loading commands with
dummy data intended to make the terminal server believe that the
download is working. The data sent to the terminal is discarded.
<P>
For reference only, the function of the command in a 7527 context is
reproduced below.
<P>CMD J3 sets up the terminal to dump or return data loaded in
RAM. This command is the initialization,
and also returns the first data block
requested. Execute CMD J7 to return
additional RAM data to the terminal server.
ETS must be halted with CMD J4 prior to execution of CMD J3.
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, J3, type, address, size, CS1, CS2, ETX
<= STX, J3, count, address, size, data 1, data 2, ... data N, CS1, CS2, ETX
=> ACK or NAK
</PRE>
<P>The <B>type</B>
refers to the type of dump to be initiated.
It consists of two ASCII characters.
The valid codes for dump types are as follows:
<DL COMPACT>
<DD>01 = Full dump, <B>address</B> through end of RAM.
<DD>03 = Allocated memory dump. Dump storage is currently
allocated, starting with <B>address</B>.
<DD>04 = Selective dump. Dump storage starts at <B>address</B>.
</DL>
<P>The <B>address</B> is a variable, expressed in paragraphs,
based on the type of dump requested.
It consists of two hex bytes.
The returned <B>address</B> should reflect the
sent <B>address</B>.
<P>For dump types 01-03,
the <B>size</B> sent to the terminal
is the maximum size of records to be
dumped. For type 04, it is the length of the area to be dumped.
It consists of two hex bytes, expressed in paragraphs.
For dump types 01-03, the <B>size</B>
returned by the terminal is the number of data bytes returned in the
first block (N). For dump type 04, the <B>size</B>
returned is the length of the area to be dumped.
<P>The <B>count</B> is the record number of the dump,
starting with 0001h.
It consists of two hex bytes.
The last record contains a count of FFFFh.
<P>
<H3><A NAME="HDRCMDJ4HL" HREF="#PToC_73">CMD J4--Halt and Wait for Next Command</A></H3>
<P><B>Note: </B>The 7524 ETS flash / DCConnect Client cannot be loaded into the
terminal using the Jx commands. ETS does not ever load itself; it expects
that do be done outside of its operations.
<P>
7524 ETS is loaded into semi-permanent FLASH ROM
via the process described in
(See<A HREF="#HDRINSTALL">Installing and Downloading the 7524 Extended Terminal Services Flash</A>)
For compatibility
with existing data collection control software,
ETS will respond to the Jx loading commands with
dummy data intended to make the terminal server believe that the
download is working. The data sent to the terminal is discarded.
<P>
For reference only, the function of the command in a 7527 context is
reproduced below.
<P>This command stops the execution of ETS if it is loaded and running.
It returns the operational status of ETS.
The CMD J5 must be executed to start or restart any ETS.
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, J4, CS1, CS2, ETX
<= STX, J4, address, size, status, version, CS1, CS2, ETX
=> ACK or NAK
</PRE>
<P>The <B>address</B> is the first segment of RAM used by the loaded
program.
It consists of two hex bytes, expressed in paragraphs.
It is the lowest address used by the loaded program.
<P>The <B>size</B> refers to the total amount of RAM in the terminal.
It consists of two hex bytes, expressed in paragraphs.
<P>The <B>status</B> refers to the terminal's operational status.
It consists of two ASCII characters.
The following codes are used to indicate the terminal's operational
status:
<DL COMPACT>
<DD>00 = Was operational and ETS was loaded
<DD>01 = Was in a halted state
<DD>02 = Waiting for first program to be loaded
<DD>03 = Program loaded but not started
<DD>04 = Self-test/maintenance mode
<DD>05 = Keylock is in locked mode.
</DL>
<P>The <B>version</B> refers to the terminal's microcode level.
It consists of two hex bytes.
<P>
<H3><A NAME="HDRCMDJ5PX" HREF="#PToC_74">CMD J5--Start Program Execution</A></H3>
<P><B>Note: </B>The 7524 ETS flash / DCConnect Client cannot be loaded into the
terminal using the Jx commands. ETS does not ever load itself; it expects
that do be done outside of its operations.
<P>
7524 ETS is loaded into semi-permanent FLASH ROM
via the process described in
(See<A HREF="#HDRINSTALL">Installing and Downloading the 7524 Extended Terminal Services Flash</A>)
For compatibility
with existing data collection control software,
ETS will respond to the Jx loading commands with
dummy data intended to make the terminal server believe that the
download is working. The data sent to the terminal is discarded.
<P>
For reference only, the function of the command in a 7527 context is
reproduced below.
<P>This command loads the terminal processor registers from
the values found in the .EXE header of the application program previously
downloaded via CMD J1.
When the registers are loaded, program execution continues from the point
execution was stopped.
To start ETS after it
has been halted with CMD J4, execute CMD J5 without
register parameters.
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, J5, ss, sp, cs, ip, es, ds, CS1, CS2, ETX
<= STX, J5, return code, CS1, CS2, ETX
=> ACK or NAK
</PRE>
<P>The following processor registers are loaded via CMD J5:
<DL COMPACT>
<DD><B>ss</B>--Stack Segment register value
<DD><B>sp</B>--Stack Pointer register value
<DD><B>cs</B>--Code Segment register value
<DD><B>ip</B>--Instruction Pointer register value
<DD><B>es</B>--Extra Segment register value
<DD><B>ds</B>--Data Segment register value.
</DL>
<P>Each processor register consists of hex bytes.
<P>The following <B>return code</B>s are used with CMD J5:
<DL COMPACT>
<DD>00--Program was started
<DD>01--CS or IP was invalid
<DD>02--SS or SP was invalid
<DD>03--Terminal not in proper state for command.
</DL>
<P>Each <B>return code</B> consists of two ASCII characters.
<P>
<H3><A NAME="HDRCMDJ6ER" HREF="#PToC_75">CMD J6--Terminal Error Return (Response Only)</A></H3>
<P>This response or status information is returned upon receipt of the
first poll after reset, power recovery, or when an error has occurred.
When power is restored, if the terminal lost power, it responds to the
first poll or command with reason set,
indicating a power failure occurred.
If an application program was loaded, the application restart
indication would also be on.
<P>The format for this command is:
<PRE>
<= STX, J6, reason, CS1, CS2, ETX
</PRE>
<P>The following bit numbers represent
<B>reason</B>s for terminal status:
<DL>
<DD><P>Least Significant Bit (LSB) first
<DL COMPACT>
<DD>0--Power failure occurred
<DD>1--Processor exception occurred
<DD>2--Co-processor fatal error
<DD>3--Network reset sent (CMD 0)
<DD>4--User reset via keyboard or keylock
<DD>5--Application reset occurred.
</DL>
<DD><P>Bits 6 and 7 encoded values are:
<DL COMPACT>
<DD>0--Cold reset occurred
<DD>1--Warm reset occurred
<DD>2--Application restart occurred
<DD>3--Not used.
</DL>
</DL>
<P>Each <B>reason</B> contains one byte of hex data.
<P>
<H3><A NAME="HDRCMDJ7NX" HREF="#PToC_76">CMD J7--Send Next Data Dump Record</A></H3>
<P><B>Note: </B>The 7524 ETS flash / DCConnect Client cannot be loaded into the
terminal using the Jx commands. ETS does not ever load itself; it expects
that do be done outside of its operations.
<P>
7524 ETS is loaded into semi-permanent FLASH ROM
via the process described in
(See<A HREF="#HDRINSTALL">Installing and Downloading the 7524 Extended Terminal Services Flash</A>)
For compatibility
with existing data collection control software,
ETS will respond to the Jx loading commands with
dummy data intended to make the terminal server believe that the
download is working. The data sent to the terminal is discarded.
<P>
For reference only, the function of the command in a 7527 context is
reproduced below.
<P>This command returns data or program information from the
terminal's RAM as specified in the count parameter.
CMD J3 must be executed successfully prior to
CMD J7; otherwise,
reason 02 is returned by response J8.
The value for the starting dump record is returned by
CMD J3 in the count parameter.
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, J7, count, CS1, CS2, ETX
<= STX, J7, count, address, size, data 1, data 2, ... data N, CS1, CS2, ETX
</PRE>
<P>The <B>count</B> is the record number of the last record dumped.
It contains two bytes of hex data.
The last record contains a count of FFFFh.
<P>The <B>address</B> is a variable, expressed in paragraphs,
which is the starting address of the data in the
record.
It contains two bytes of hex data,
expressed in paragraphs.
<P>The <B>size</B> is the length of the data in the record.
It contains two bytes of hex data.
For dump types 01-03, the <B>size</B>
returned by the terminal is the number of data bytes returned in the
first block (N). For dump type 04, the <B>size</B>
returned by the terminal is the length of the area to be dumped.
<P>
<H3><A NAME="HDRCMDJ8UV" HREF="#PToC_77">CMD J8--Terminal Unavailable (Response Only)</A></H3>
<P><B>Note: </B>The 7524 ETS flash / DCConnect Client cannot be loaded into the
terminal using the Jx commands. ETS does not ever load itself; it expects
that do be done outside of its operations.
<P>
7524 ETS is loaded into semi-permanent FLASH ROM
via the process described in
(See<A HREF="#HDRINSTALL">Installing and Downloading the 7524 Extended Terminal Services Flash</A>)
For compatibility
with existing data collection control software,
ETS will respond to the Jx loading commands with
dummy data intended to make the terminal server believe that the
download is working. The data sent to the terminal is discarded.
<P>
For reference only, the function of the command in a 7527 context is
reproduced below.
<P>This command is an error response
to commands 0, J0 through J5, J7, and J9 when they are sent to the
terminal, indicating that the command has invalid parameters
or the parameters are out of proper sequence.
<P>The format for this command is:
<PRE>
<= STX, J8, reason, CS1, CS2, ETX
</PRE>
<P>where the <B>reason</B> code explains why
the terminal is unavailable.
<P>The valid <B>reason</B> codes are:
<DL COMPACT>
<DD>00 = Terminal is in diagnostic state (that is, alloc, load, dump,
halt)
<DD>01 = Terminal not halted (dump, restart)
<DD>02 = Dump not initiated (next dump)
<DD>03 = Keylock switch is locked (halt or start)
<DD>04 = Terminal already started (alloc)
<DD>05 = Invalid number of parameters
<DD>06 = Dump terminated; bad count.
</DL>
<P>The <B>reason</B> code consists of two ASCII characters.
<P>
<H3><A NAME="HDRCMDJ9CF" HREF="#PToC_78">CMD J9--Configuration Query</A></H3>
<P>This command returns the hardware and firmware
configuration of the terminal.
<P>The format for this command is:
<PRE>
=> STX, ADDR, ADDR, J9, CS1, CS2, ETX
<= STX, J9, version, display, touch, ramsize, keylock, pio, CS1, CS2, ETX
</PRE>
<P>Where:
<DL>
<DD><P><B>version</B> = ROM microcode major and minor versions, two hex
bytes. (For example, <I>V01</I> would return <I>= 0100</I>.)
<DD><P><B>display</B> = Display type,
one hex byte. Valid display types are:
<DL COMPACT>
<DD>00 = Two-line display
<DD><B>01 = Graphics, normal video</B>
<DD>02 = Graphics, reverse video.
</DL>
<DD><P><B>touch</B> = Screen status, one hex byte. Valid screen status
codes are:
<DL COMPACT>
<DD><B>00 = Touch disabled</B>
<DD>01 = Touch enabled.
</DL>
<DD><P><B>ramsize</B> = Size of RAM in paragraphs, two hex bytes
<DD><P><B>keylock</B> = Status of the keylock,
one hex byte. Valid keylock status codes are:
<DL COMPACT>
<DD><B>00 = Keylock unlocked</B>
<DD>01 = Keylock locked.
</DL>
<DD><P><B>pio</B> = Switch setting for printer or DIDO, one hex byte
<DL COMPACT>
<DD><B>00 = Switch is set to printer</B>
<DD>01 = Switch is set to DIDO.
</DL>
</DL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
ETS always returns the highlighted values.
</td></tr></table>
<P>
<H3><A NAME="Header_79" HREF="#PToC_79">CMD K--Transaction Release</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,K,text,CS1,CS2,ETX
<= ACK or NAK
</PRE>
<P>
The <B>text</B>, sssss, refers to:
<PRE>
sssss = transaction sequence number (00000-99999)
</PRE>
<P>The sequence number can be set to XXXXX in order to release
the first transaction in the terminal regardless of
the sequence number of that first transaction.
<P>
(See<A HREF="#HDRBMM">Buffered Mode</A>) .
<P>
<H3><A NAME="Header_80" HREF="#PToC_80">CMD L--Loopback for Communications Verification</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,L,text,CS1,CS2,ETX
<= STX,L,text,CS1,CS2,ETX
</PRE>
<P>
The <B>text</B> refers to any ASCII data string, 121 bytes maximum.
<P>
Whatever <B>text</B> is received is sent back in the response.
<P>
<H3><A NAME="Header_81" HREF="#PToC_81">CMD MA--Request CFR Status</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,MA,CS1,CS2,ETX
<= STX,status,size,CS1,CS2,ETX
</PRE>
<P>
The <B>status</B> is a single binary byte as follows:
<PRE>
00 No CFR loaded
01 CFR in process of being loaded
02 CFR enabled
</PRE>
<P>
The <B>size</B> is two binary bytes and is in paragraphs.
A zero size is returned if no space is
allocated for a CFR.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
ESC (ASCII escape) sequence for binary data must be sent to the terminal and is
also sent by the terminal when needed.
</td></tr></table>
<P>
<H3><A NAME="Header_82" HREF="#PToC_82">CMD MB--Allocate Space for CFR</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,MB,size,CS1,CS2,ETX
<= STX,paragraph,CS1,CS2,ETX
</PRE>
<P>
The <B>size</B> is two bytes (binary) and is in paragraphs.
The maximum size allowed is 64 Kb or 4096 paragraphs.
<P>
The base <B>paragraph</B> address is returned (2 bytes, binary) to
the server.
A base address of 0 is returned if not enough memory.
If a CFR is already loaded, this command will disable it and initiate a
new CFR load sequence provided the terminal is out of service.
<P>
An additional optional byte, set to '1', may follow the paragraph value that is
returned, if the CFR is not supposed to be fixed up before
downloading. In this case, the CFR executable should be downloaded
exactly as it is stored on the terminal server. If this extra byte is
not in the response or if it is and is not set to '1', then the CFR should
be fixed up (as described at the end of the next chapter) before downloading.
<P>
The exception to this is when the DCConnect Client is running on a Windows
Client, where the CFR is actually a DLL and not an executable file; CFRs
that are DLLs are always downloaded by the terminal server without being
fixed up.
<P>
<H3><A NAME="Header_83" HREF="#PToC_83">CMD MC--Load CFR Image</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,MC,number,data,CS1,CS2,ETX
<= ACK or NAK
</PRE>
<P>
This command loads the CFR executable image.
The <B>number</B> (2 binary bytes, starting at zero)
is a block counter to make sure that no data is lost or repeated.
The <B>data</B> is the CFR image.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
A NAK is returned if the number is incorrect or no CMD MB
has been executed.
</td></tr></table>
<P>
<H3><A NAME="Header_84" HREF="#PToC_84">CMD MD--Start CFR</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,MD,number,CS1,CS2,ETX
<= ACK or NAK
</PRE>
<P>
This command notifies the terminal to
initialize and attach the CFR.
The <B>number</B> (2 binary bytes)
is the block counter as in CMD MC and must be
one greater than the last number used in a CMD MC.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
A NAK is returned if the number is incorrect or no CMD MB
and CMD MC has been executed.
</td></tr></table>
<P>
<H3><A NAME="Header_85" HREF="#PToC_85">CMD NA--Send Validation File Status to the Host</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,NA,fff..ff,CS1,CS2,ETX
<= STX,fff..ff,data,CS1,CS2,ETX
</PRE>
<P>
<B>fff..ff</B> is file name, 1-12 characters
<P>
The <B>data</B>, aaaaauuuuudt, refers to:
<PRE>
aaaaa number of bytes reserved by previous CMD NB
uuuuu number of bytes not used
d = text type
1 = noncompacted alphanumeric text
t = file type
0 = non-polled file
</PRE>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
If a mode 2 CFR does a resize of the file, aaaaa-uuuuu = resize
number.
</td></tr></table>
<P>
<H3><A NAME="Header_86" HREF="#PToC_86">CMD NB--Initialize Specified Validation File</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,NB,fff..ff,text,CS1,CS2,ETX
<= ACK or NAK
</PRE>
<P>
<B>fff..ff</B> is file name, 1-12 characters
<P>
<P>The <B>text</B> is a fixed length string of ASCII characters that
initializes a specified text file, reserves file space, and defines
file characteristics.
<P>The format is: llllldtrsfrrrrr
<P>Where:
<DL COMPACT>
<DD>lllll = File space to be reserved in bytes.
Maximum bytes allowed is 65500 or 63K.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The file size can be formatted in one of two ways:
<OL COMPACT>
<LI>Five digits as the number of bytes
<LI>Four digits plus a letter <B>K</B> (upper or lower case).
In this case, the four digits are multiplied by 1024 to obtain
the file size in bytes.
</OL>
</td></tr></table>
<DD>dtr = Reserved
<DD>s = Sorted attribute
<DL COMPACT>
<DD>0 = Not sorted
<DD>1 = Sorted.
</DL>
<DD>f = Fixed length attribute
<DL COMPACT>
<DD>0 = Variable length
<DD>1 = Fixed length.
</DL>
<DD>rrrrr = Record count for variable length
and length of record for fixed length.
</DL>
<P>
A validation file can be deleted from local
storage at the terminal by using CMD NB to
reinitialize the file to 0 bytes.
<P>
<H3><A NAME="Header_87" HREF="#PToC_87">CMD NC--Load Validation File</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,NC,fff..ff,RS,data,CS1,CS2,ETX
<= ACK or NAK
</PRE>
<P>
<B>fff..ff</B> is file name, 1-12 characters
<P>
The <B>data</B> refers to variable length data records,
a record separator (RS) appears at the end of each record.
Repeat the CMD NC string to load the file.
Text records may be variable in length and can be in
multiple communications records.
This eliminates the restriction that a text record must have a maximum
length based on the maximum size of the communications record.
An RS must be entered between the text records and at the end of the
last record transmitted.
Spaces are allowed between characters.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
If this command causes a file overrun, this is indicated in a CMD 1
status, where characters 8 and 9 are '3v'.
There is no error transaction created.
</td></tr></table>
<P>
<H3><A NAME="Header_88" HREF="#PToC_88">CMD ND--Validation File Load Complete</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,ND,fff..ff,CS1,CS2,ETX
<= ACK or NAK
</PRE>
<P>
<B>fff..ff</B> is file name, 1-12 characters
<P>
This command signals ETS that the file is
complete and available for validation.
<P>
<H3><A NAME="Header_89" HREF="#PToC_89">CMD O--Write to Display with Attributes</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,O,rr,cc,a,e,text,CS1,CS2,ETX
<= ACK or NAK
</PRE>
<P>
The <B>rr</B> refers to row and <B>cc</B> refers to column.
If <B>rr</B> is 00 then the current row is used;
if <B>cc</B> is 00 then the current column is used.
<P>
The <B>a</B> refers to the attribute:
<PRE>
0 = No blinking, normal, no underline
1 = No blinking, normal, underline
2 = No blinking, reverse video, no underline
3 = No blinking, reverse video, underline
4 = Blinking, normal, no underline
5 = Blinking, normal, underline
6 = Blinking, reverse video, no underline
7 = Blinking, reverse video, underline
</PRE>
<P>
The <B>e</B> refers to the erase screen option.
<PRE>
0 = the display is not erased before displaying the text
1 = the display is erased before displaying the text
</PRE>
<P>
The <B>text</B> refers to ASCII text to be displayed.
Like CMD 2 if the first text character is a DC2 then the text is written
to the display buffer unaffected by Timer B.
Otherwise, the text will remain displayed for the duration of Timer B.
In order for multiple successive CMD Os to display multiple
lines of text on the display, the DC2 option
must be used at the beginning of each text
line and the text will remain until an operator action deletes it.
Also, like CMD 2, this command is handled only during
terminal idle cycles.
<P>
<H3><A NAME="Header_90" HREF="#PToC_90">CMD Q--Query (Read) User Variable</A></H3>
<P>
This command returns to the server the contents of a user variable on the DCT
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR, Q, text, RS, CS1, CS2, ETX
<= STX, Q, data, CS1, CS2, ETX
</PRE>
The <B>text</B> is:
nnn = user variable number (000 - 099)
The <B>data</B> is the contents of the user variable. The data is not
null-terminated. The length of the response message minus the framing
characters determines is how the terminal server should determine the length
of the user variable data.
<P>
<H3><A NAME="Header_91" HREF="#PToC_91">CMD V--Positive or Negative Response to Remote Validation</A></H3>
<P>
The format for this command is:
<PRE>
=> STX, ADDR, ADDR,V,text,RS,CS1,CS2,ETX
<= ACK or NAK
</PRE>
<P>For TS operation, the <B>text</B> is a series of 5 ASCII bytes:
<UL>
<P><LI>Bytes 1 - 2 = the sequence number of the transaction that
requested the remote validation in decimal (00-99).
<P><LI>Bytes 3 - 4 = the field number in decimal (01-99)
which is essentially the nth ':' or ';' in the transaction
program.
<P><LI>Byte 5 = response to the remote validation
<UL COMPACT>
<LI>ASCII 'P' = positive response (the data was found to be valid)
<LI>ASCII 'N' = negative response (the data was found to be invalid).
</UL>
</UL>
<P>For ETS operation, the <B>text</B> is a series of 8 ASCII bytes:
<UL>
<P><LI>Bytes 1 - 5 = the sequence number of the transaction that
requested the remote validation in decimal (00000-99999).
<P><LI>Bytes 6 - 7 = the field number in decimal (01-99)
which is essentially the nth ':' or ';' in the transaction
program.
<P><LI>Byte 8 = response to the remote validation
<UL COMPACT>
<LI>ASCII 'P' = positive response (the data was found to be valid)
<LI>ASCII 'N' = negative response (the data was found to be invalid).
</UL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
A 'P' response causes the transaction program to continue operation,
while an 'N' response causes the transaction program to either skip
or abort.
</td></tr></table>
</UL>
<HR>
<H1><A NAME="HDRPOWERUP" HREF="#PToC_92">Powerup and Download Specifications</A></H1>
<P>This chapter discusses powerup requirements for 7524 terminals and
specifies the download sequences for ETS parameter files to both 7524
terminals and terminals running the DCConnect Client.
<HR>
<H2><A NAME="Header_93" HREF="#PToC_93">7524 Powerup Requirements</A></H2>
<P>The 7524 DCT may be reset (that is, restarted)
in three ways:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>Type of Reset</B>
</TD><TD><P><B>Description</B>
</TD></TR><TR VALIGN=TOP><TD><P><B>Initial start/Cold reset
</B></TD><TD><P>Upon the initial startup of a new terminal, or
a terminal in which the battery has been removed for a long period,
all DCT setup parameters must be set using the gold shift and <I>Menu</I>
key sequence. Then all the RAM configuration, program, prompt,
validation, and CFR files must be downloaded.
The System Setup menu contains a
<I>Reset Parms</I> option for
clearing out the DCT configuration and files.
</TD></TR><TR VALIGN=TOP><TD><P><B>Application restart
</B></TD><TD><P>This type of reset is initiated through power-off/on.
Files should not need to be downloaded.
</TD></TR></TABLE>
<P>When the DCT is powered up, it executes a Power On Self Test (POST).
If an initial start/cold reset is executed,
the terminal setup parameters (communications, and so forth) are set to
default values.
The default address, "127",
is non-operative, so a valid address must be set (valid addresses are
0 to 126). On SST terminals (7524-102 and -202),
the LAN ID and host name must
also be set (they must match those used by the RF controller
and base stations).
<P>
All terminals under the control of ETS, upon startup,
waits for the download of files 0-8, c and e,
so that operating parameters may be loaded in the terminal.
For a description of the download sequence for these files,
(See<A HREF="#HDRFILEDWN">Parameter File Download Sequence</A>) .
An initialization command is sent for all the files
(RAM space to allocate for each file) followed by the required
data as supported by the ETS protocol.
Initial text is also loaded into the appropriate files.
Once loaded, the parameter files remain in RAM until
a new download sequence is received, or until CMD 0 is sent.
For initialization requirements,
(See<A HREF="#HDRFILEINT">Parameter File Initialization Sequence</A>) .
<HR>
<H2><A NAME="HDRFILEINT" HREF="#PToC_94">Parameter File Initialization Sequence</A></H2>
<P>
This section contains the initialization sequence for the parameter files.
These files must be initialized before they can be downloaded.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>For the networked terminal, 'Poll,' as shown in the following
example, can be eliminated; the
terminal sends a DC1 command when it requires a download. In addition,
a networked terminal should send an A0X command to the terminal to tell
it not to send any unsolicited messages such as transactions or other
download requests.
</td></tr></table>
<PRE>
TERMINAL
SERVER DCT
______ ___
Poll ---->
<---- DC1 Request Files
CMD A0 ----> Set DCT Out of Service
<---- ACK
CMD 1 ----> Status Request
<---- RSP Return Status
</PRE>
<P>
If the terminal contains transactions
(byte 12 of the status reply is '1')
then these transactions must be removed
from the terminal before the
download can continue. For the networked terminal,
the A1X command should be sent to
inform the terminal to send transactions. All
transactions from the terminal
should be handled as described in
(See<A HREF="#HDRMODES">Modes of Operation</A>) .
When all transactions have been
removed, the A0X command should be sent to the
terminal so that it can no longer
send unsolicited messages.
<PRE>
Initialize files 1-8, a-b, and d-e until all are complete
CMD 9B ----> Initialize File 9
<---- ACK
CMD 1 ----> Status Request
<---- RSP Return Status
CMD 9A ----> Request file status
<---- RSP Return file status
Initialize CFR:
CMD MB ---->
<---- RSP
CMD MA ---->
<---- RSP
Initialize Extended Validation Files:
CMD NB ---->
<---- ACK
CMD NA ---->
<---- RSP
Repeat for each extended validation file.
</PRE>
<P>This sequence is followed immediately by the download sequence given in
(See<A HREF="#HDRFILEDWN">Parameter File Download Sequence</A>) .
Then
the terminal is ready to be put in service by the terminal server.
<P><B>Notes: </B><OL>
<P><LI>The parameter files are
automatically initialized by the Data Collection Connection software
(See the <I>DCConnect User's Guide.</I> for additional information.)
<P><LI>Files 0 and 8 must always be initialized and loaded.
Files 1, 2-7, c, and e are optional;
however, if any of these files is initialized, it must also be loaded.
<P><LI>A detailed description of the text and data associated with each
command is provided in
(See<A HREF="#HDRDETAIL">DCT Control Command Details</A>) .
</OL>
<HR>
<H2><A NAME="HDRFILEDWN" HREF="#PToC_95">Parameter File Download Sequence</A></H2>
<P>Once the parameter files have been initialized,
they are ready for downloading.
The required download sequence is as follows:
<PRE>
TERMINAL
SERVER DCT
______ ___
CMD 9C ----> Load File 0
<---- ACK
CMD 1 ----> Status Request
<---- RSP Return Status
Repeat until file 0 is loaded.
CMD 9C ----> Load File 1
<---- ACK
CMD 1 ----> Status Request
<---- RSP Return Status
Repeat until file 1 is loaded.
Continue Loading Files 2-8, B and E
CMD 9C ----> Load File 2
<---- ACK
CMD 1 ----> Status Request
<---- RSP Return Status
Load CFR if needed.
CMD MC ----> Load CFR
<---- ACK
CMD 1 ----> Status Request
<---- RSP Return Status
Repeat until CFR is loaded, then start the CFR.
CMD MD ----> Start CFR
<---- ACK
CMD 1 ----> Status Request
<---- RSP Return Status
</PRE>
<PRE>
Load Extended Validation Files.
CMD NC ----> Load Extended File
<---- ACK
CMD 1 ----> Status Request
<---- RSP Return Status
Repeat until Extended file is loaded, then start the file.
CMD ND ----> Start Extended File
<---- ACK
CMD 1 ----> Status Request
<---- RSP Return Status
Repeat previous two steps for each extended validation file.
Setup Buffer File 9
CMD 8 ----> Specify polled buffer
<---- ACK
CMD 1 ----> Status Request
<---- RSP Return Status
Set DCT Clock
CMD 4 ----> Set Clock
<---- ACK
CMD 1 ----> Status Request
<---- RSP Return Status
Set DCT In Service
CMD A1 ----> Set DCT In Service
<---- ACK
CMD 1 ----> Status Request
<---- Return Status
For the networked terminal, the A1X command should now be sent to the
terminal to allow it to send transactions and other unsolicited
messages to the server.
</PRE>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The parameter files are
automatically downloaded by the DCConnect software.
</td></tr></table>
<HR>
<H2><A NAME="HDREVFDS" HREF="#PToC_96">Extended Validation File Download Sequence</A></H2>
If just valiation files are to be loaded, the following download sequence
should be followed, the same procedure as described previously should be used
except that the initialization and loading of files 0, 1, 8, A-D can be
eliminated. File E should be reloaded if more than one validation file is
being reloaded.
<HR>
<H2><A NAME="HDRCRDS" HREF="#PToC_97">CFR File Download Sequence</A></H2>
Most of the discussion in this chapter deals with downloading CFR
executables that have been 'fixed up' for a particular address.
However, Windows versions of the DCConnect Client, uses CFRs that
have been built as DLLs. CFRs that are DLLs are not 'fixed up'
prior to downloading. The binary image of CFR DLLs must be sent
to the terminal without any changes. The remainder of this
chapter is about fixing up and downloading CFR executables.
<P>
Downloading of CFR executables is more complex than
other files because the CFR executable file image must be adjusted
for the location of the CFR in the terminal's memory.
Space is allocated in the terminal by the terminal server
via CMD MB.
The terminal's response is the address (in paragraphs)
at which the CFR will be stored in the terminal.
The terminal server
must then adjust all the absolute references in the CFR
executable file (EXE file) and transmit the adjusted
image a block at a time using CMD MC.
When the entire image has been sent, the terminal server
sends CMD MD to notify the terminal to initialize the CFR.
<P>
The size of the CFR is derived from values found in the EXE header.
Offsets 04 and 05 of the EXE file image give the size of the
file in 512 byte increments.
Offsets 02 and 03 are the file size MOD 512.
Offsets 08 and 09 give the size of the EXE header.
For a more detailed explanation of the EXE file
format created by LINK, see the DOS Technical
Reference Manual chapter titled "EXE File Structure and Loading".
<P>
Once the resident size of the CFR has been
determined, use CMD MB to allocate space.
The ETS will respond to this command with an address in paragraphs.
This address + 32 bytes will be the base address of the CFR
once it has been downloaded.
Use this address + 32 bytes to relocate the CFR image.
The final step in the relocation process will
be to add a JMP instruction to the entry point of the relocated image.
The remaining 27 bytes of the relocated CFR image header
should remain unused and set to zero.
<P>
Once the relocation of the CFR has taken
place, downloading may be performed using CMD MC.
After the relocated CFR image has been
downloaded, use CMD MD to activate the CFR.
<P>
<B>Disk EXE image:</B>
<img src=e9zz0001.GIF>
<B>Terminal image:</B>
<img src=e9zz0002.GIF>
<P>
Procedure:
<OL>
<P><LI>Get EXE file for CFR.
<P><LI>The header portion of the EXE file is used to determine
how much memory must be allocated in the 7524 for the CFR.
Calculate the memory required as follows:
<OL>
<P><LI>Obtain the 16-bit values contained in offsets
02-03h, 04-05h, 08-09h, and 0A-0Bh.
<P><LI>If the value in 02-03h is zero, decrement the
value in 04-05h by one.
<P><LI>The size is:
<PRE>
( ( (offset 04-05h) X 512) +
(offset 02-03h) +
( (offset 0A-0Bh) X 16) -
(offset 08-09h) )
</PRE>
</OL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>In step 3 below, you also add 32 bytes for the CFR header.
</td></tr></table>
<P><LI>The total file image to be loaded into
the terminal is the size from item 2 above plus 32 bytes for a header.
<P><LI>Allocate the space required for the file
image in the terminal using CMD MB and
the total from item 3 above.
<P><LI>Create a download image which is a 32
byte header followed by the relocated
program image.
<P><LI>Perform the relocation of all absolute
references in the EXE image.
The base address for relocation is the
address returned by the CMD MB plus 32.
<P><LI>Put a jump instruction at the beginning
of the header which is a jump to the
relocated entry point of the code image.
This jump instruction consists of 5 bytes, defined
as follows:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>Byte</B>
</TD><TD><P><B></B>
</TD></TR><TR VALIGN=TOP><TD><P>1
</TD><TD><P>8088 jump instruction -- always EAh
</TD></TR><TR VALIGN=TOP><TD><P>2-3
</TD><TD><P>Memory offset for jump destination.
Set to equal offsets 14-15h from EXE header.
</TD></TR><TR VALIGN=TOP><TD><P>4-5
</TD><TD><P>Memory segment for jump destination.
Set to equal offsets 16-17h from EXE header
<I>plus</I> the relocation value used
in step 6 (return from MB command plus 32 bytes).
</TD></TR></TABLE>
<P><LI>Download the image created in step 5
using CMD MC.
<P><LI>Do CMD MD to complete the download
sequence.
</OL>
<PRE>
TERMINAL
SERVER DCT
______ ___
CMD MB ----> Allocate space
<---- RSP Allocation address
Create download image, do relocations
CMD MC ----> Send image blocks
<---- ACK
CMD 1 ----> Status Request
<---- RSP
CMD MD ----> CFR load complete
<---- ACK
</PRE>
<P>
<H3><A NAME="Header_98" HREF="#PToC_98">Redownload of a CFR</A></H3>
To redownload when a CFR is already present,
the CFR must not be currently
executing and the terminal must be taken out of service
(which implies emptying the transaction queue first).
If these conditions are met, then a download using the normal CFR
download commands can be done.
CMD MB will reallocate space as per the new request and disable
the current CFR.
For more information about creating CFR's,
(See<A HREF="#HDRCH1">Introduction to C Programming on terminals running 7524 ETS or the DCConnect Client</A>) and
(See<A HREF="#HDRCFR">Writing Custom Function Routines</A>) .
<HR>
<H1><A NAME="HDRVALID" HREF="#PToC_99">Validation of Device Input Data</A></H1>
<P>This chapter specifies data entry requirements and describes
how data entries are validated.
<P>Field length for device input data (keyboard, sensor ports,
and RS-232 port) will always be specified by a length parameter.
ETS will overlay the existing display message with underscores
(_) to define the length and position when a read is requested.
The field will always be placed in the rightmost display position
(except in the case of <B>:R</B> (read),
where the field will start
at the current cursor position),
and the cursor will be placed at the start of the input field.
<HR>
<H2><A NAME="HDRNUMERIC" HREF="#PToC_100">Numeric Data Entry Field</A></H2>
<P>In a numeric data entry field, only numeric characters must be
entered in all positions of the field.
Valid keys are the numeric keys, the Fill key, and specific
PF keys or touch screen regions
defined in File <B>b</B> to contain only numeric data.
Numeric characters enter into the far right position of the field,
with each
new key entry moving the previous key entry one position to the left.
The Fill key can be used to
fill the remainder of the incomplete field with ASCII zeroes (0)
on the left.
All characters scrolled out of the field (on the left) are deleted.
<P>Limited line editing is allowed using the Backspace (<) key
on the keypad.
If Backspace is pressed, the most recent character entered is deleted,
and the data must be reentered.
Backspace can only put you back to the beginning
of the current data input field.
It cannot corrupt data on the other part of the screen that is not
within the current data input field.
Press the Enter key to complete the field.
<P>If a numeric data entry field has autofill parameter (a) = 1, it will
bypass the length check.
The enter key may be use at any time to complete the field.
Any remaining underscores in the numeric key entry field will be
changed to ASCII zeroes on the left, and the field will be completed.
<P><B>Notes: </B><OL>
<P><LI>Refer to <B>:2 llft(appb)</B> in
<A HREF="#TBLKEYCMDS">Table 6</A> for additional information about
numeric input data.
<P><LI>Refer to <A HREF="#TBLKEYS">Table 3</A> for additional information about
using the Enter key,
Fill key, Backspace key, PF keys, and numeric keys
for data entry.
</OL>
<HR>
<H2><A NAME="HDRALPHANM" HREF="#PToC_101">Alphanumeric Data Entry Field</A></H2>
<P>In an alphanumeric data entry field, the space key is used to remove
the underscores and advance the cursor from the present position.
The Fill key can be used to fill the remainder of the incomplete
field with ASCII spaces.
Alphanumeric characters enter into the far left position of the
field, and each new character enters one position to the right of the
previous one.
Once the field is full, characters enter into the far right position
of the field, scrolling the leftmost character out the left side of the
field.
All the characters scrolled out of the field (on the left) are deleted.
<P>Limited line editing is allowed using the (<) Backspace key.
If Backspace is pressed, the most recent character entered is
changed back to an ASCII underscore (_),
and the data must be reentered.
The Backspace key can only put you back to the beginning
of the current data input field.
It cannot corrupt data on the other part of the screen that is not
within the current data input field.
Press the Enter key to complete the field.
<P>An alphanumeric entry field with the autofill parameter (a) = 1
bypasses the length check.
The Enter key may be used at any time to complete the field, and any
remaining underscore in the alphanumeric data entry field will be
changed to ASCII spaces on the right.
<P><B>Notes: </B><OL>
<P><LI>Refer to <B>:3 llft(appb)</B> and
<B>:4 llft</B> in
<A HREF="#TBLKEYCMDS">Table 6</A> for additional information about
alphanumeric input data.
<P><LI>Refer to <A HREF="#TBLKEYS">Table 3</A> for additional information about
using the Enter key,
Fill key, Backspace key, PF keys, and numeric keys
for data entry.
</OL>
<HR>
<H2><A NAME="HDRVDATA" HREF="#PToC_102">Validation of Data Entered</A></H2>
<P>Validation of data entered is specified by the use of two validation
parameters in File 0 (key commands).
See <A HREF="#TBLKEYCMDS">Table 6</A> for detailed descriptions of the key
commands used with File 0.
<P>These parameters have the following meanings:
<UL>
<P><LI>Parameter <B>f</B> specifies the file
ID<A HREF="#FNIDNOTE">(9)</A> of the validation file.
<P>
Valid validation file IDs are 2-7, a-z, and A-Z.
File E
maps these single
character file IDs to the 8.3 file names used by the NA, NB,
NC and ND commands.
The single character file IDs are used in several transaction
program commands.
Commands 9A, 9B, and 9C can be used to initialize/load
validation files with
IDs 2 through 7.
No validation is specified by setting <B>f</B> equal to zero.
<P><LI>Parameter <B>t</B> specifies that the file must
contain an exact positive match (t = 1)
or a negative match (t = 0).
Validation of the positive match requires that a matching record
exist in the file for data which has been entered.
Validation of a negative match file requires that a matching record
not be found in the file for the data entered.
</UL>
<HR>
<H1><A NAME="HDRKEYPD" HREF="#PToC_103">Keypad Operation</A></H1>
<P>This chapter describes how terminal modes affect keypad operation. The
first part describes the keyboard for various models of 7524 terminals and
their Intermec/Norand equivalent. The second part describes how the keyboard
is treated by the DCConnect Client.
<HR>
<H2><A NAME="Header_104" HREF="#PToC_104">Keyboard Usage for 7524 Terminals (and their Intermec/Norand equivalents)</A></H2>
<P>The different models of the 7524 terminal have
different keyboard layouts, which affects
how to access certain keys:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>PF Keys 1-12
</B></TD><TD><P>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>7524-05X
</TD><TD><P>Accessed by pressing Black-Shift-F1 through
Black-Shift-F12 (labelled A through L).
</TD></TR><TR VALIGN=TOP><TD><P>7524-10X
</TD><TD><P>PF1 through PF8 are towards the
top of the keyboard. To get PF9 through PF12,
use Gold-Shift-PF1 through Gold-Shift-PF4.
</TD></TR><TR VALIGN=TOP><TD><P>7524-20X
</TD><TD><P>PF1 through PF8 are actually labelled
F1 through F8 on the key face. To get PF9 through
PF12 use Gold-Shift-PF1 through Gold-Shift-PF4.
</TD></TR></TABLE>
</TD></TR><TR VALIGN=TOP><TD><P><B>Clear key
</B></TD><TD><P>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>7524-05X
</TD><TD><P>Black-Shifted-N
</TD></TR><TR VALIGN=TOP><TD><P>7524-10X
</TD><TD><P>Gold-Shifted-PF7
</TD></TR><TR VALIGN=TOP><TD><P>7524-20X
</TD><TD><P>The blue key located two keys below the key labelled F6
</TD></TR></TABLE>
</TD></TR><TR VALIGN=TOP><TD><P><B>Cancel key
</B></TD><TD><P>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>7524-05X
</TD><TD><P>Black-Shifted-O
</TD></TR><TR VALIGN=TOP><TD><P>7524-10X
</TD><TD><P>Gold-Shifted-PF8
</TD></TR><TR VALIGN=TOP><TD><P>7524-20X
</TD><TD><P>The blue key located one key below the key labelled F6
</TD></TR></TABLE>
</TD></TR><TR VALIGN=TOP><TD><P><B>Fill key
</B></TD><TD><P>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>7524-XXX
</TD><TD><P>Accessed by pressing Gold-Shift-SPACE when in
data entry mode for all 7524 models
</TD></TR></TABLE>
</TD></TR><TR VALIGN=TOP><TD><P><B>OK key
</B></TD><TD><P>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>7524-05X
</TD><TD><P>Black-Shifted-M
</TD></TR><TR VALIGN=TOP><TD><P>7524-10X
</TD><TD><P>Located below the On/Off key
</TD></TR><TR VALIGN=TOP><TD><P>7524-20X
</TD><TD><P>The blue key located three keys below the key labelled F6
</TD></TR></TABLE>
</TD></TR><TR VALIGN=TOP><TD><P><B>Space key
</B></TD><TD><P>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>7524-05X
</TD><TD><P>Labelled with SP on the face of
the key
</TD></TR><TR VALIGN=TOP><TD><P>7524-10X
</TD><TD><P>Labelled with SP on the face of
the key
</TD></TR><TR VALIGN=TOP><TD><P>7524-20X
</TD><TD><P>Labelled with SPACE on the face
of the key
</TD></TR></TABLE>
</TD></TR><TR VALIGN=TOP><TD><P><B>Backspace key
</B></TD><TD><P>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>7524-XXX
</TD><TD><P>Labelled with an arrow pointing to the left for all 7524 models.
</TD></TR></TABLE>
</TD></TR></TABLE>
<P>The terminal operates in two modes: <I>idle</I> and
<I>transaction</I> These
modes affect the way that the terminal responds when the user presses
certain keys.
<P><A HREF="#TBLKEYS">Table 3</A> describes the terminal's responses to pressing these
keys when the terminal is operating
in the previously mentioned modes. Note that
pressing a key may cause a different operation than the key label
indicates, depending on the terminal state.
<BR>
<P><B><A NAME="TBLKEYS">Table 3. Impact of Terminal Modes on Keypad Operation</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Key
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=2%>Idle mode
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=97%>Transaction mode
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Numeric 0-9
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>No response
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Places numeric characters 0-9 into a data entry field
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Enter key
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>No response
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Completes the transaction step in progress and advances to next step
in transaction.
If this is the last step in the transaction,
indicates the completion of this transaction record
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Function keys 1-26 or Alphabetic A-Z
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Responds to the key definitions in records 1-26 in File 0
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Places alphabetic characters A-Z into the data entry field defined
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Function key 27
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Responds to key definition in record 27 in File 0
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
On 7524 models 05X and 10X -- Used to put space into a data
entry field or to fill the field with spaces.
<P>On the 7524 model 20X -- Used to put a
period in a data entry field.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Function key 28
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Responds to key definition in record 28 in File 0
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
On 7524 models 05X and 10X -- Used as a backspace
key when in data entry mode.
<P>On 7524 model 20X -- Used to put a minus sign
(hyphen) in a data entry field.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Program Function (PF) keys 1-12
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Responds to key definitions in records 31-42 in File 0
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
Used only when the :Z command is waiting for a keystroke.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Fill key
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>No response
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Used to complete the current data input field with
ASCII spaces ( ), if the data is to be alphanumeric, or ASCII
zeroes (0), if the data is to be numeric
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Space key
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>No response
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Used to put blank/space into a data entry field
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Backspace (<) key
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>
No response
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Used to allow limited line editing during a data entry operation
<P>If Backspace is pressed, the most recent character entered is
deleted or changed back to an ASCII underscore (_),
and the data must be reentered.
Backspace can only put you back to the
beginning of the current data input field. It cannot corrupt data on
any other screen area that is not within the current data input field.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Clear key
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Clears the display buffer
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
Clears all the data from the current data input field and replaces the
entire field with underscores. Similar to the CE keys on
most calculators that allow you to clear the most recent
entry until Enter is pressed
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Cancel key
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>No response
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Used to abort the current transaction
</TD></TR></TABLE>
<HR>
<H2><A NAME="Header_105" HREF="#PToC_105">Keyboard Usage for Terminals Running the DCConnect Client</A></H2>
<P>
There are a wide variety of terminals supported by the DCConnect Client, each
with different numbers of keys and different layouts. But all keys that are
used are ones that are found on a standard PC keyboard. These include
alphabetic, numeric, arrow keys, F1-F10, Home, Insert, Delete, ...
<P>
Not all PC keyboard keys are available and the function of keys may differ
depending on which of the two transaction modes the terminal is in:
<UL>
<P><LI>Idle mode is when a transaction program is not in progress.
<P><LI>Transaction mode is when a transaction program is in progress.
</UL>
<P>
When in the menus, the keys function in the same way as when in transaction
mode.
<P>
When in Idle mode the following keys are active:
<PRE>
A-Z = Used to start the transaction programs bound to F1 through F26
, or < = Used to start the transaction program bound to F27
F1-F12 = Used to start the transaction programs bound to PF1 through PF12
Home = or ? = Bring up the configuration menus.
Arrow keys = Used to scroll the view of the virtual screen if the display
size is set to anything smaller than 20x40. The arrows move
the 'view port' relative to the virtual screen. For example,
pressing the up arrow will move you closer to row 1 if row 1
is not already displayed.
</PRE>
<P>
When in the menus or in a transaction program the following keys are active:
<PRE>
Arrow keys = If in the menus, sometimes used to scroll through choices
If not in the menus, used to scroll the view of the virtual
screen - just as in idle mode.
Backspace = Delete data in an input field
In some places in the menus it is used to cancel an operation
Tab/Backtab = Used to move between options in the menus.
Enter = Used to complete an input field or accept the information on
a menu screen.
Esc = Cancel a transaction program
End = Used in field navigation to accept the data in all input fields.
Insert = Used to fill in an input field with spaces when in a transaction
program
Delete = Used to clear an input field when in a transaction program.
F1-F12 = Function as PF1-PF12 in transactions in the following cases:
- In an ONKEY/ONSUB (:Z) command to conditionally pass control
based on a key pressed.
- Can also be used to fill alias string text into an input field
if alias string text has been assigned to th PF Keys and if the
input field was produced by a READ (:R) command which has the
PF Keys selected as an input device.
Home = or ? = Bring up the configuration menus (if not already in them)
Space # $ %
& * + . /
0-9, A-Z = These are the valid characters that can be typed into an
entry field (the same set that 7524 terminals has available).
In certain menu options where it might be desirable to
enter other characters into a field, a method is provided by
which the ASCII value of the desired character can be entered.
</PRE>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
While many of the 3rd party terminals have all of the PC keys defined
that are needed by the Client, some such as the Intelligent Instrumentation
TimePoint (Symbol FMT1060) have a more limited keyboard and thus may not be
able to make full use of the Client functions.
</td></tr></table>
<HR>
<H1><A NAME="HDRBADGE" HREF="#PToC_106">Badge-Initiated Transactions</A></H1>
<P>This chapter describes transactions initiated through scanning of
a bar-coded badge or other bar code document.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
Refer to <B>:1 llft</B>,
<B>:4 llft</B>, and <B>;1 lld0</B> in
<A HREF="#TBLKEYCMDS">Table 6</A> for additional information about
parameter values for badge data.
</td></tr></table>
<P>Normally, the DCT initiates a transaction when the operator presses
a function key.
Certain applications may require that an operator only read
a bar code to initiate a transaction. Such functions can be implemented
by using either the time-of-day (TOD) for <I>fast clocking</I> or
an <I>optional badge transaction program</I> for reading a badge
first. The difference between the two
types of transactions is the time of day that they occur.
These transactions are described in the following paragraphs.
<UL>
<P><LI>Fast clocking
<P>Fast clocking allows transactions to be created with only the reading
of a badge (no function key required).
These times are specified in File 1.
This can be used during a factory shift change, when data
defined in record 30 in File 0 can be
collected for time and attendance purposes.
If a transaction program has not been defined for record 30 in File 0,
then the information in bytes 12-15 in File 0 record 00 define the
transaction record created during fast clocking.
Fast clocking transactions are buffered and retrieved by the terminal
server in first in/first out (FIFO) order from the buffer,
regardless of terminal operation mode.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
If record 30 is defined (not NOP<A HREF="#FNNOPDEF">(10)</A>),
the badge data is in user variable
0 (the last read variable). If the badge data is to be validated, the
first command in the record 30 transaction program must be a
<B>:K</B> (validate) command. This badge data
is appended to the transaction record
as the first field by default just before the next data input
instruction in the transaction program.
</td></tr></table>
<P><LI>Optional badge transaction program
<P>An optional badge transaction program, record 29 in File 0, allows
the reading of a badge to initiate a transaction.
This badge-initiated transaction may require other input data to be
included in the transaction in the optional transaction program.
This transaction is initiated when fast clocking is not in effect.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
If record 29 is defined (not NOP), the badge data is in user
variable 0 (the last read variable).
If the badge data is to be validated, the first command in the record
29 transaction program must be a <B>:K</B> (validate) command.
This badge data is appended to the transaction record as the first field
by default just before the next data input instruction in the
transaction program.
</td></tr></table>
</UL>
<P>
If the terminal is not currently in a fast clocking time interval,
and no
program is defined at record 29 in file 0, then when a badge is
read by the
terminal, no program is run and no transaction is generated. The
'invalid
operation message' is usually shown in this situation.
<HR>
<H1><A NAME="HDRSTRINGS" HREF="#PToC_107">Character String Construction and Manipulation</A></H1>
<P>This chapter specifies the requirements for character string
construction and manipulation.
<P>There are 99 built-in character strings, known as user variables (UV),
are available to users for use in transaction programs.
In addition, a system-controlled character string, known as
user variable 0 (UV 0), is available to users.
User variable 0 contains the last data read from any input device
(keyboards, sensors, or
devices connected to the RS-232 port).
User variable 0 is also called the last read variable.
<P>Whenever a transaction program begins execution,
user variables 0 - 9 are automatically cleared
(that is, initialized to null).
User variable 0 is constructed automatically by the system, but user
variables 1-99 can be constructed using the append
(<B>:F</B>), clear (<B>:H</B>),
and format (<B>:J</B>),
key commands (see <A HREF="#TBLKEYCMDS">Table 6</A>).
The user can construct user variables 1-99 using the data from the
result of the last read (that is, the data stored in UV 0),
message record in File 8, PF key definition, touch screen definition,
or another user variable.
A user variable (UV 1-UV 99)
can then be formatted into a specified length and/or
have local validation performed on it.
User variables 0-99
can then be routed to the parallel printer port, the RS-232 port,
or the display, or they can be appended to the current transaction
record (see <A HREF="#FIGTAPREL">Figure 1</A>).
<P>User variables 010-099 are not cleared before each transaction.
This allows carry-over between transactions and the ability to set a
user variable from the terminal server via a
terminal server command.
The terminal server CMD I and CMD IM can be used to set
these variables remotely from the terminal server.
<P>
Transaction program execution can be halted to
wait for the terminal server to send a global user
variable to user variables 010-099 as follows:
clear the variable using
the Clear Data Area (<B>:H</B>)
command and then send a user-defined transaction to the terminal
server using Write To Terminal Server (<B>:W</B>).
Finally, use the Test User Variable
(<B>;N</B>) command in combination with
the Go To (<B>:G</B>)
command to wait for the variable to be set by the terminal server
via CMD I or CMD IM.
<P>
Before each test, the Delay (:D) command should be used so that the
transaction program does not use all of the processor resources
looping around and around testing the user variable. With the delay,
ETS may not get enough processor time to be able to handle commands
from the terminal server - such as the CMD I or CMD IM that is expected.
<HR>
<H1><A NAME="HDRRAMS" HREF="#PToC_108">RAM Files</A></H1>
<P>This chapter specifies the rules for initializing and processing
RAM files, and describes the contents of those files.
File record contents,
parameters, key commands, valid byte values, file structures,
and so forth, are included in the file descriptions.
<P>Certain files are required for the proper
operation of the DCT and ETS. For information about the optional
and required files,
(See<A HREF="#HDRPOWERUP">Powerup and Download Specifications</A>)
These files contain required and optional
terminal operating parameters (for example, barcode configuration
parameters), user-defined transaction programs and record formats,
message text, time period specifications,
text validation data, keyboard redefinition requirements, predefined
data entry strings, custom function routines,
user-specified graphic symbols, and transaction data.
In addition,
certain files are used when various communications control commands
are executed;
(See<A HREF="#HDRDETAIL">DCT Control Command Details</A>) .
<HR>
<H2><A NAME="HDRFILERUL" HREF="#PToC_109">General File Rules</A></H2>
<P>The rules governing file initialization and processing are:
<UL>
<P><LI>Individual files may be reinitialized without reinitializing all the
files.
<P><LI>No reinitialization of File 9 (transaction queue file) is permitted
until File 9 is empty.
<P><LI>Files can be reinitialized only when the DCT is out of service
<P><LI>All files are downloaded in ASCII format
(except files c and d).
</UL>
<HR>
<H2><A NAME="HDRRAMFILE" HREF="#PToC_110">File Descriptions</A></H2>
<P>There are 15 unique RAM files used with ETS:
<UL COMPACT>
<LI>File 0--Terminal Operating Parameters/Programs
<LI>File 1--Fast Clocking Times
<LI>Files 2-7--User Validation Files
<LI>File 8--Message File
<LI>File 9--Transaction Queue File
<LI>File a--User-Defined Keyboard Layout
<P><B>Note: </B>File a is not supported with ETS.
<LI>File b--Alias/Autofill Function
<LI>File c--Custom Function Routines
<LI>File d--Graphics Bitmap Records
<P><B>Note: </B>File d is not supported with ETS.
<LI>File e--Extended Validation Cross-reference Table
<LI>Extended Validation Files (58 files possible, which includes
2-7 mentioned above).
</UL>
<P>This section describes the previously listed files,
which are stored on the DCTs.
Record formats for each file are also described.
<P>Two file attributes are defined under ETS, both applicable
only to the user validation files (files 2-7)
specified in CMD 9B (initialize specified text file):
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>Sorted
</B></TD><TD><P>If numeric, a sorted file has its members arranged in
ascending numerical order.
If alphanumeric, the members are ordered alphabetically.
Files are sorted if they use Code Page 850 collation sequence; no
other type of collation sequence is supported.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
For further information about Code Page 850,
refer to the ASCII code list in your DOS user guide.
</td></tr></table>
</TD></TR><TR VALIGN=TOP><TD><P><B>Fixed length
</B></TD><TD><P>Applicable only to alphanumeric files. True if
all records in the file have the same length.
</TD></TR></TABLE>
<P>
<H3><A NAME="HDRFIL0DSC" HREF="#PToC_111">File 0--Terminal Operating Parameters/Program Storage</A></H3>
<P>Within the context of the ETS software, <I>event</I> describes
an action that requires some response or servicing by the DCT.
Usually, events are serviced by initiating a transaction program.
For example, an operator can initiate a transaction program by pressing a
function key. When a key is pressed or a badge is scanned, one can say
that an <I>event</I> is generated.
<P>Any of the following DCT devices can generate an event:
<UL COMPACT>
<LI>The bar code scanner (integrated or tethered scanner).
<LI>Terminal server communications port
<LI>General purpose communications port (one source)
<LI>Keyboard keys, with additional 12 PF keys
</UL>
<P><B>Note: </B>The transaction program storage locations used on a 7527 terminal for
digital input, shifted PF key, and touch screen region initiated
event may be used with ETS, but there are no physical
input devices on the terminal to allow the operator to start these
programs directly. The only access to the stored programs is
from other transaction programs isomg commands such as Goto and Onkey.
Host command G can also be used to initiate a program that is assigned to
one of these storage locations.
<P>File 0 must have 122 records (0-121) containing entries that
determine basic terminal operating characteristics
(that is, cursor type, display type, fast clocking parameters, and so
forth) and transaction programs.
File 0 is an alphanumeric file that allows the user to customize the
functions of the terminal for a specific application.
<P><A HREF="#TBLRECFIL0">Table 4</A> shows the contents of the records within File 0.
<P>Every record must be terminated by the record separator (RS)
character.
Once the last record is defined which is not a NOP
transaction, the remainder of the file (composed entirely
of NOP transactions) need not be supplied by the terminal server. Up to
this point, however, a NOP command code must be supplied for all events
that are ignored.
ETS fills the rest of the records with NOPs for you.
<P><B>Note: </B>Initialization of File 0 must specify the complete number of bytes for
the entire file with all the NOPs included (that is, space must be
provided for all 122 records).
<P>Individual transaction programs are limited to 65000 bytes in size.
<P>The following tables describe the contents and options for records
in File 0.
<BR>
<P><B><A NAME="TBLRECFIL0">Table 4. Contents of Records in File 0</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Record Number(s)
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=99%>Contents
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>0
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Terminal characteristics (204 bytes)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1-26
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Transaction programs associated with terminal keys A-Z
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>27-28
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Next two keys in keyboard matrix after <B>Z</B>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>29
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Incoming data on sensor, fast clocking not active
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>30
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Incoming data on sensor, fast clocking active
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>31-42
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>PF keys 1-12
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>43-54
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Shift PF keys 1-12
<P><B>Note: </B>ETS does not support shifted PF keys; therefore these programs cannot
be started directly by an event. However, they may be used via
commands in other transaction programs (e.g. Goto, Onkey) or they may
be started via the host command G.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>55
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Incoming data on the GP port 1
<P><B>Note: </B>ETS currently does not support initiating a transaction
via RS-232 'General Purpose' port activity.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>56
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Unassigned
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>57-64
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>State change to trip level on DI ports 0-7
<P><B>Note: </B>ETS does not support digital I/O ports; therefore these programs
cannot be started directly by an event. However, they may be used via
commands in other transaction programs (e.g. Goto, Onkey) or they may
be started via the host command G.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>65-72
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Unassigned
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>73-112
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Touch screen regions 1-40
<P><B>Note: </B>ETS does not support touch screen points; therefore these programs
cannot be started directly by an event. However, they may be used via
commands in other transaction programs (e.g. Goto, Onkey) or they may
be started via the host command G.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>113-120
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>Extra transactions programs, only accessible via other transaction
programs or via the host command G.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>121
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=99%>New hour on the TOD clock
</TD></TR></TABLE>
<P>
All of the unsigned records can also be used to store transaction
programs that can be accessed through the
:G and :Z commands even though
they cannot be started through any physical event.
<P>
<H4><A NAME="Header_112" HREF="#PToC_112">File 0--Record 00 (Configuration Record)</A></H4>
<P><A HREF="#TBLREC0FL0">Table 5</A> specifies the parameters for File 0, record 00.
This record contains numerous setting with which you can affect the
behavior of the terminal.
<BR>
<P><B><A NAME="TBLREC0FL0">Table 5. File 0 Record 00 Parameters</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Offset from Start
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Length in Bytes
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=2%>Parameter Function
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=97%>Parameter Entry
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>0
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Transaction buffering desired or not
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = Buffered Mode
<DD>1 = Interactive Mode
<DD>2 = Interactive/Buffered
</DL>
<P>
This is the default value if the individual transaction program has not
defined its own mode using the <B>:I</B> command or no
terminal server CMD 8 has been executed.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>3
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Format of time display
These configuration bytes may be set, but 7524 ETS currently does
not use them. To conserve battery power, 7524 ETS does not
present a time/date display on the idle screen. However, the DCConnect
Client will use the value configured here if the keyword SHOW_IDLE_TIME
is used in its configuration.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = 12 hour (HH-MM)
<DD>1 = 24 hour (HH-MM)
<DD>2 = 12 hour (HH-t, where t = 10ths of an hour)
<DD>3 = 12 hour (HH-h, where h = 100ths of an hour)
<DD>4 = 24 hour (HH-t)
<DD>5 = 24 hour (HH-th)
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>4
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Idle display format (prompt message from File 8 left-justified)
These configuration bytes may be set, but 7524 ETS currently does
not use them. To conserve battery power, 7524 ETS does not
present a time/date display on the idle screen. However, the DCConnect
Client will use the value configured here if the keyword SHOW_IDLE_TIME
is used in its configuration.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Time display is right-justified
<DL COMPACT>
<DD>0 = Time Only
<DD>1 = Time and Date
<DD>2 = Date Only
</DL>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>5
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Hourly time transaction
Note: ETS currently does not support hourly time transactions.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = No
<DD>1 = Yes
</DL>
<P>Default format of the transaction is the function ID, timestamp as
defined in offset 6, and sequence number if configured.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>6
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Timestamp for transaction records
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = HHMM
<DD>1 = HHMMSS
<DD>2 = YYMMDDHHMM
<DD>3 = YYMMDDHHMMSS
<DD>4 = MMDDYYHHMM
<DD>5 = MMDDYYHHMMSS
<DD>6 = DDMMYYHHMM
<DD>7 = DDMMYYHHMMSS
<DD>8 = JJJYYHHMM
<DD>9 = JJJYYHHMMSS
<DD>A = YYJJJHHMM
<DD>B = YYJJJHHMMSS
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>7
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Error logging mode for application errors
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL>
<DD><P>0 = No error logging to terminal server
for errors in the <I>Application Exceptions</I> category.
(See<A HREF="#HDRAPLXMPL">Application Exceptions</A>) .
<DD><P>1 = Error logging to terminal server
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>8
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Number of beeps, good transaction
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
ETS does not use this parameter. A single beep is issued
only for commands B and C. No beep is issued automatically when
transactions are generated.
</td></tr></table>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>X = Number of good beeps (0-9)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>9
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Duration of beep for a good transaction
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
ETS does not use this parameter. A single beep is issued
only for commands B and C. No beep is issued automatically when
transactions are generated.
</td></tr></table>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>X = Number of .25 sec intervals for a good beep (0-9)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>10
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Number of beeps, bad transaction
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
ETS does not use this parameter. A single beep is issued
only for commands B and C. No beep is issued automatically when
transactions are generated.
</td></tr></table>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>X = Number of bad beeps (0-9)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>11
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Duration of beep for a bad transaction
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
ETS does not use this parameter. A single beep is issued
only for commands B and C. No beep is issued automatically when
transactions are generated.
</td></tr></table>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>X = Number of .25 sec intervals for a bad beep (0-9)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>12
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>File number for validation of fast clocking badges
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = No validation wanted
<DD>2-7 = File number for the validation (no remote validation)
</DL>
<P>Value is ignored if record 30 exists.
This is the default value if record 30 is NOP.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>13
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Type, fast clock file validation
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = Data not in file
<DD>1 = Data in file
</DL>
<P>Value is ignored if record 30 exists.
This is the default value if record 30 is NOP.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>14-15
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Fast clock badge length
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX = Length for validation
<P>Value is ignored if record 30 exists.
This is the default value if record 30 is NOP.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>16-17
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Timer <B>A</B> duration (terminal server communications timeout)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>ETS:
<DL COMPACT>
<DD>00-FF hexadecimal (Time in one-second intervals)
<DD>00 = wait forever for terminal server response
(or until operator cancels)
</DL>
<DD>TS mode:
<DL COMPACT>
<DD>00-99 = Time in .5 second increments.
</DL>
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>18
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Timer <B>B</B> duration (time certain status and error messages
remain on the display)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>X = 0-9 Time in .5 second increments
(0 = no 'good prompt' for buffered transactions and error messages
display for default 3 second)
<P><B>Note: </B>Good prompt message is a global flag which can be changed with a CFR.
This change lasts past the execution of the transaction program or CFR.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>19-20
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Timer <B>C</B> duration (maximum time between operator actions
when in a transaction sequence)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>ETS:
<DL COMPACT>
<DD>00-FF hexadecimal (Time in one-second intervals)
<DD>00 = wait forever (or until operator cancels)
</DL>
<DD>TS mode:
<DL COMPACT>
<DD>00-99 = Time in .5 second increments.
</DL>
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>21
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Add sequence numbers to transaction record.
Sequence numbers start at 0 and recycle at 99 for TS operation and
at 99999 for ETS operation.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = No
<DD>1 = Yes
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>22
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>23
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Auto operate the good read LED on panel on badge input at sensor
ports
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = No
<DD>1 = Yes
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>24
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Fast clocking for sensor ports during time periods specified in
File 1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = No
<DD>1 = Yes
</DL>
<P>Value is ignored if record 30 exists. This is
the default value if record 30 is NOP.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>25-41
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>17
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Bar code decoding to be used for sensor ports
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Each byte can be:
<DL COMPACT>
<DD>B = Straight 2 of 5
<DD>C = USD-1, Interleaved 2 of 5
<DD>F = USD-3, Code 39
<DD>G = Extended Code 39
<DD>H = USD-7, Code 93
<DD>I = USD-4, Codabar
<DD>J = UPC A and E
<DD>K = EAN 8 and 13
<DD>L = USD-8, Code 11
<DD>N = MSI Code
<DD>O = Code 128
</DL>
<P>A space ( ) denotes the end of the list of choices.
<P>ETS defaults to F (Code 39) and J (UPC A and E).
<P>Only one of Code 39 or Extended Code 39 can be chosen.
<P>If only A is used, then ETS uses default barcodes (FJ) also.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
Terminals running the DCConnect Client do not use the values configured
here or any of the barcode configuration defined in bytes 130-199. Instead
the Client relies on tools and drivers from the terminal manufacturer for
configuring bar code symbologies for the terminal. This allows ETS to take
advantage of all capabilities that each terminal model supports.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>42
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Display character set selection (used only with Model 002 DCTs)
Note: ETS currently does not support setting the display size
via these parameters. The terminal always maintains a 20-line x
40-character display buffer; the amount which may be seen at one
time is dependent on the font size selected in the terminal's
set-up menus. The arrow keys may be used to view areas of the 20x40
display which are currently off of the visible area.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = Standard 20L X 40C
<DD>1 = Standard 14L X 32C
<DD>2 = Downloaded 20L X 40C
<DD>3 = Downloaded 14L X 32C
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>43
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>44
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Cursor format to be used during keyboard reads
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = Cursor Off
<DD>1 = Underline Cursor
<DD>2 = Blinking Underline Cursor
<DD>3 = Block Cursor
<DD>4 = Blinking Block Cursor
</DL>
<P>Cursor is only shown during keyboard reads.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>45
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Set the baud rate for the RS-232-C port
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>3 = 1200
<DD>4 = 2400
<DD>5 = 4800
<DD>6 = 9600
<DD>7 = 19200
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>46
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Parity for the RS-232-C port
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = None
<DD>1 = Odd
<DD>2 = Even
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>47
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Set the number of stop bits to be expected on the RS-232-C port
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Specify 1 or 2
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>48
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Set the number of data bits to be expected on the RS-232-C port
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>2 = 7 bits
<DD>3 = 8 bits
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>49
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Asynchronous protocol option for the RS-232-C port: XON/XOFF
support
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = Disable Support
<DD>1 = Enable Support
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>50
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Time display separator
These configuration bytes may be set, but 7524 ETS currently does
not use them. To conserve battery power, 7524 ETS does not
present a time/date display on the idle screen. However, the DCConnect
Client will use the value configured here if the keyword SHOW_IDLE_TIME
is used in its configuration.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = colon (:)
<DD>1 = period (.)
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>51
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Date display separator
These configuration bytes may be set, but 7524 ETS currently does
not use them. To conserve battery power, 7524 ETS does not
present a time/date display on the idle screen. However, the DCConnect
Client will use the value configured here if the keyword SHOW_IDLE_TIME
is used in its configuration.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = slash (/)
<DD>1 = hyphen (-)
<DD>2 = period (.)
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>52
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Numeric input field delimiter
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = period (.)
<DD>1 = comma (,)
<DD>2 = Both
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>53
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Determines idle screen display format
These configuration bytes may be set, but 7524 ETS currently does
not use them. To conserve battery power, 7524 ETS does not
present a time/date display on the idle screen. However, the DCConnect
Client will use the value configured here if the keyword SHOW_IDLE_TIME
is used in its configuration.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = YYMMDD
<DD>1 = MMDDYY
<DD>2 = DDMMYY
<DD>3 = JJJYY
<DD>4 = YYJJJ
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>54
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>55
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>
Asynchronous protocol option for the RS-232-C port: length of
message start sequence (up to 8 characters to
affix to the start of every message written to the port)
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>X = 0-8 Number of characters to be used
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>56-79
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>24
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Asynchronous protocol option for the RS-232-C port: characters
defining the message start sequence
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Each 3 bytes have a value from
000-255, which is the ASCII number
of the character (for example, a <B>< <</B> is represented by
060060000000000000000000).
<P>Zeroes are to be used to pad out the bytes that are not being used.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>80
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Asynchronous protocol option for the RS-232-C port: length of
message end sequence (up to 8 characters
to affix to end of every message written to port)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>X = 0-8 Number of characters to be used in the message end
sequence
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>81-104
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>24
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Asynchronous protocol option for the RS-232-C port: characters
defining the message end sequence
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Each 3 bytes have a value 000-255, which is the ASCII number
of the character (for example, a <B>> ></B> is represented by
062062000000000000000000).
<P>Zeroes are to be used to pad out the bytes that are not being used.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>105
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>
Asynchronous protocol option for the RS-232-C port: strip length
for the start of message (number of characters to strip off start of
input message).
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>X = 0-8 Number of characters to be stripped from start of
message
<P><B>Note.</B> Message starting and ending characters are
automatically stripped.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>106
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>
Asynchronous protocol option for the RS-232-C port: strip length
for the end of message (number of characters to strip off end of input
message).
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
X = 0-8 Number of characters to be stripped from end of message
<P><B>Note.</B> Message starting and ending characters are
automatically stripped.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>107-108
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Asynchronous protocol option for the RS-232-C port: timeout
(read or write)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX = 0-99 seconds
00 = wait forever for last character to be received.
<P>
This timeout refers to the time allowed for the last characters to be
received once the read of the port has started.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>109
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Asynchronous protocol option for the RS-232-C port: retries
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>X = 0-9 Number of retries for reads and writes
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>110
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>111-118
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>8
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>119
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Buffering desired for new hour on TOD clock: default
buffering
Note: ETS does not currently support TOD transactions.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = No
<DD>1 = Yes
</DL>
<P>If not buffered, a new transaction
will not be started based on this hour change.
<P>If buffered, a new transaction
will be started at the end of the current transaction.
<P>Value is ignored if record 121 exists.
This is the default value if record 121 is NOP.
A transaction is
created if record 121 does not exist. This transaction
consists of a two-byte function ID,
timestamp as defined in byte 43, and sequence number.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>120
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Buffer events on DIDO port: default buffering
Note: ETS does not currently support digital I/O ports. This byte is ignored.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = No
<DD>1 = Yes
</DL>
<P>If buffered,
a new transaction will be started based on this DI transaction
when the terminal is idle, if it occurs when the terminal is busy with
another transaction program.
<P>Only one event per point is buffered.
<P>If the DIDO port is buffered, and the condition is no longer true
when the port is ready for service, the transaction program is executed
anyway (records 57-64, if defined).
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>121-123
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>3
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Terminal server timeout for response to remote validation
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>000-999 decimal (Time in one-second intervals)
<DD>000 = infinite wait (or until operator cancels)
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>124-128
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>5
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Idle screen menu with the idle prompt on DCT display
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XXXXX = prompt/screen to display when the DCT is in idle mode
<UL COMPACT>
<LI>00000 = Use the idle prompt (message 0 in File 8) at the bottom of
the screen.
<LI>09000 = Record number in File 8, which is the beginning
of <B>n-1</B> records (depending on size of DCT display)
to be displayed on DCT as the idle menu.
The idle prompt (message 0 in File 8) is always shown on the bottom
of the DCT display.
This feature can be used to show an initial menu or
define the touch screen region.
</UL>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>129
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>130-131
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Minimum number of characters to expect for Straight 2/5
(value B in bytes 25-41)
(if min = max = 0, then no limit is applied and includes all check
digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>132-133
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Maximum length for Straight 2/5
if chosen in bytes 25-41
(if min = max = 0, then no limit is applied and includes all check
digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>134
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Encoded byte for check
digit type, 2 or 5 supplement, optional check
digit, and return check digit for Straight 2/5
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<UL COMPACT>
<LI>Bits 0-4--Not used
<LI>Bit 5--Always 1
<LI>Bits 6 and 7--Always 0
</UL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
See bytes 25-41 for a note about the DCConnect Client's use of all
bytes in the 130-199 range.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>135-136
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Minimum length for USD-1, I 2/5 if chosen in bytes 25-41
(if min = max = 0, then no limit is applied and includes all check
digits). This is in increments of 2.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-98 (must be in increments of 2)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>137-138
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>
Maximum length for USD-1, I 2/5 if chosen in bytes 25-41 (if min = max = 0,
then no limit is applied and includes all check digits).
This is in increments of 2.
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-98 (must be in increments of 2)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>139
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Encoded byte for check digit type, 2 or 5 supplement, optional check
digit, and return check digit for USD-1, I 2/5
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<UL COMPACT>
<LI>Bits 0-2--Not used
<LI>Bit 3--optional check digit (1=Y, 0=N)
<LI>Bit 4--Not used
<LI>Bit 5--Always 1
<LI>Bits 6 and 7--Always 0
</UL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
See bytes 25-41 for a note about the DCConnect Client's use of all
bytes in the 130-199 range.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>140-141
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used; USD-2 is not supported on the 7524.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>142-143
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used; USD-2 is not supported on the 7524.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>144
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used; USD-2 is not supported on 7524 terminals.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>145-146
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used; Code B is not supported on 7524 terminals.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>147-148
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used; Code B is not supported on 7524 terminals.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>149
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used; Code B is not supported on 7524 terminals.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>150-151
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Minimum length for USD-3, Code 39 if chosen in bytes 25-41 (if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>152-153
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Maximum length for USD-3, Code 39 if chosen in bytes 25-41 (if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>154
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Encoded byte for check digit type, 2 or 5 supplement, optional check
digit, and return check digit for USD-3, Code 39
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<UL COMPACT>
<LI>Bits 0-4--Not used
<LI>Bit 5--Always 1
<LI>Bits 6 and 7--Always 0
</UL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
See bytes 25-41 for a note about the DCConnect Client's use of all
bytes in the 130-199 range.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>155-156
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Minimum length for Ext. Code 39 if chosen in bytes 25-41
(if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>157-158
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Maximum length for Ext. Code 39 if chosen in bytes 25-41
(if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>159
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Encoded byte for check digit type, 2 or 5 supplement, optional
check digit, and return check digit for Ext. Code 39
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<UL COMPACT>
<LI>Bits 0-2--Not used
<LI>Bit 3--optional check digit (1=Y, 0=N)
<LI>Bit 4--Not used
<LI>Bit 5--Always 1
<LI>Bits 6 and 7--Always 0
</UL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
See bytes 25-41 for a note about the DCConnect Client's use of all
bytes in the 130-199 range.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>160-161
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Minimum length for USD-7, Code 93 if chosen in bytes 25-41
(if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>162-163
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Maximum length for USD-7, Code 93 if chosen in bytes 25-41
(if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>164
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Encoded byte for check digit type, 2 or 5 supplement, optional
check digit, and return check digit for USD-7, Code 93
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<UL COMPACT>
<LI>Bits 0-4--Not used
<LI>Bit 5--Always 1
<LI>Bits 6 and 7--Always 0
</UL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
See bytes 25-41 for a note about the DCConnect Client's use of all
bytes in the 130-199 range.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>165-166
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Minimum length for USD-4, Codabar if chosen in bytes 25-41
(if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>167-168
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Maximum length for USD-4, Codabar if chosen in bytes 25-41
(if min = max = 0,
then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>169
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Encoded byte for check digit type, 2 or 5 supplement, optional
check digit, and return check digit for USD-4, Codabar
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<UL COMPACT>
<LI>Bits 0-4--Not used
<LI>Bit 5--Always 1
<LI>Bits 6 and 7--Always 0
</UL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
See bytes 25-41 for a note about the DCConnect Client's use of all
bytes in the 130-199 range.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>170-171
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Minimum length for UPC-A, UPC-E chosen in bytes 25-41 (if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99 (not applicable)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>172-173
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Maximum length for UPC-A, UPC-E if chosen in bytes 25-41
(if min = max = 0, then no limit is applied
and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99 (not applicable)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>174
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Encoded byte for check digit type, 2 or 5 supplement, optional
check digit, and return check digit for UPC-A, UPC-E
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<UL COMPACT>
<LI>Bits 0 and 1--Not used
<LI>Bit 2--2 or 5 supplement (1 = Y, 0 = N)
<LI>Bit 3--Not used
<LI>Bit 4--Return check digit (1 = Y, 0 = N)
<LI>Bit 5--Always 1
<LI>Bits 6 and 7--Always 0
</UL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
See bytes 25-41 for a note about the DCConnect Client's use of all
bytes in the 130-199 range.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>175-176
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Minimum length for EAN-8, EAN-13 if chosen in bytes 25-41
(if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99 (not applicable)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>177-178
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Maximum length for EAN-8, EAN-13 if chosen in bytes 25-41
(if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99 (not applicable)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>179
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Encoded byte for check digit type, 2 or 5 supplement, optional
check digit, and return check digit for EAN-8, EAN-13
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%><UL COMPACT>
<LI>Bits 0 and 1--Not used
<LI>Bit 2--2 or 5 supplement (1 = Y, 0 = N)
<LI>Bit 3--Not used
<LI>Bit 4--Return check digit (1 = Y, 0 = N)
<LI>Bit 5--Always 1
<LI>Bits 6 and 7--Always 0
</UL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
See bytes 25-41 for a note about the DCConnect Client's use of all
bytes in the 130-199 range.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>180-181
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Minimum length for USD-8, Code 11 if chosen in bytes 25-41
(if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>182-183
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Maximum length for USD-8, Code 11 if chosen in bytes 25-41
(if min =
max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>184
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Encoded byte for number of check digits for USD-8, code 11.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>Bits 0-2--Not used
<DD>Bit 3--Number of check digits (1=2 digits, 0=1 digit)
<DD>Bits 4-7--Not used
</DL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
See bytes 25-41 for a note about the DCConnect Client's use of all
bytes in the 130-199 range.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>185-186
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used; Ames is not supported on 7524 terminals.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>187-188
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used; Ames is not supported on 7524 terminals.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>189
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used; Ames is not supported on 7524 terminals.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>190-191
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Minimum length for MSI Code,
if chosen in offsets 25-39.
If min = max = 0, the default,
variable length, is applied.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
Must be &lerank. to offset 192-193.
</td></tr></table>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=01-32 (variable and fixed length)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>192-193
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>
Maximum length for MSI Code,
if chosen in offsets 25-39.
If min = max = 0, the default,
variable length, is applied.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
Must be &gerank. to offset 190-191.
</td></tr></table>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=01-32 (variable and fixed length)
</TD></TR><TR>
<TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>194
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not used
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>195-196
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Minimum length for USD-6, Code 128 if chosen in bytes 25-41 (if
min = max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>197-198
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Maximum length for USD-6, Code 128 if chosen in bytes 25-41 (if
min = max = 0, then no limit is applied and includes all check digits)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>XX=00-99
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>199
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Encoded byte for check digit type, 2 or 5 supplement, optional check
digit, and return check digit for USD-6, Code 128
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<UL COMPACT>
<LI>Bits 0-4--Not used
<LI>Bit 5--Always 1
<LI>Bits 6 and 7--Always 0
</UL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
See bytes 25-41 for a note about the DCConnect Client's use of all
bytes in the 130-199 range.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>200
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Touch screen matrix
Note: ETS does not support touch screen. These byte(s) are ignored.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = 5 x 8 matrix (default)
<DD>1 = 5 x 4 matrix
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>201
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Touch screen sense mode
Note: ETS does not support touch screen. These byte(s) are ignored.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = Sense on key press (default)
<DD>1 = Sense on key release
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>202
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Determines whether or not the transaction
release command is sent by the server to the terminal to allow
the transaction to be deleted from the terminal's transaction queue.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
<DL COMPACT>
<DD>0 = no
<DD>1 = yes
</DL>
This byte is used only by the batch terminal.
Networked terminals always requires the transaction release command.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>203
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>TS/ETS operating mode specification.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
2
<BR></TD></TR></TABLE>
<P>
<H4><A NAME="Header_113" HREF="#PToC_113">File 0--Records 01-121</A></H4>
<P><A HREF="#TBLKEYCMDS">Table 6</A> describes the key commands used for File 0,
records 01-121.
These records are used to define the transaction programs for the
events described in <A HREF="#TBLRECFIL0">Table 4</A>. The format of the transaction
programs is multiple key commands terminated by an <I>RS</I>.
<P>
ETS supports the same transaction programming command set as
7527 Extended Terminal Services <I>except</I>:
<UL>
<P><LI>Screen navigation commands are not supported
<P><LI>DBI (display bit image), LINE, and BOX are not supported
(nor are the special escape sequences contained in SHOW (:E) messages
which could specify bit image display or line drawing).
<P><LI>Commands pertaining to digital input/output are not supported
(e.g. :M, :N, and :P commands).
<P><LI>The SEND command (:W) may not target the printer port (ETS does not
yet support printer port).
</UL>
<A NAME="SPTKCMDREF"><I>(Ref #2.)</I></A>
<P><B>Notes: </B><OL>
<P><LI>All commands that do validation are able to
skip to the next command whether the validation results are pass or fail.
These commands have the <B>t</B> parameter defined as follows:
<DL COMPACT>
<DD>t = 0 Exclusive validation, abort if fail
(TS definition)
<DD>t = 1 Inclusive validation, abort if fail
(TS definition)
<DD>t = 2 Exclusive validation, skip if fail
Inclusive validation, skip if pass
<DD>t = 3 Inclusive validation, skip if fail
Exclusive validation, skip if pass
(Exclusive validation = record not in
file, inclusive validation = record in file)
</DL>
If t =2 or 3 and the validation fails, the data that failed is appended
to the transaction record.
If the user requires that the data not be appended to the transaction
record if it does not validate, the user can use :A (autotrans
state) to disable adding the data to the transaction record automatically
After the data does validate, the user can use :F (append) to append
user variable 0 to the transaction record.
<P>
If a 'P' is received as a response to a remote validation, the
transaction program continues execution.
If an 'N' is received as a response to a remote validation or the
terminal server does not respond quickly enough to the validation
request, the transaction program aborts or skips.
<P><LI>Some of the
following commands are prefaced with a colon (:)
while others are prefaced with a semicolon (;).
</OL>
<BR>
<P><B><A NAME="TBLKEYCMDS">Table 6. Key Commands</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=3%>Command
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=98%>Parameter Description
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:0 rr = Display message on display left-justified on
line 1 and column 1.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Specifies record number in File 8 to be displayed (00-99).
Can only display first 100 messages in File 8 (that is, messages
00-99).
<P>Use <B>:E</B> to display messages 0000-9999.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:1 llft = Fixed length badge read with validation.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%><DL COMPACT>
<DD>ll = Length of badge data (01-40 characters).
<DD>f = File ID of validation file (that is, validation file number)
<DL COMPACT>
<DD>0
<DD>2-7, A-Z, a-z = Validation file
</DL>
<DD>t = Validation type
<DL COMPACT>
<DD>0 = Data not in file (negative)
<DD>1 = Data in file (positive).
</DL>
</DL>
<P>The data is obtained from
whichever sensor has the data available.
<P>See notes 1 and 2 immediately preceding this table.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:2 llft(appb) = Numeric keypad input expected
with validation.
<P>Optional advanced feature:
<DL COMPACT>
<DD>appb
<P>Uses autofill, positions cursor, and writes to the display buffer.
</DL>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Values for :2 llft are same as for :1 llft.
<DL>
<DD><P>a= Autofill (optional)
<DL COMPACT>
<DD>0 = No fill characters, underscore to length.
<DD>1 = Underscore to length; fill data sent to terminal server is
ASCII zeroes (0).
</DL>
<DD><P>pp = Place the leftmost character of the field at display
position (01-40).
<DD><P>b = Display buffer
<DL COMPACT>
<DD>0 = <I>Do not</I> use buffer.
<DD>1 = Use buffer.
</DL>
</DL>
<P>The DCT accepts data from the keyboard only.
See note 2 immediately preceding this table.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:3 llft(appb) = Alphanumeric keypad input expected
with validation.
<P>Optional advanced feature:
<DL COMPACT>
<DD>appb
<P>Same as for :2 llft.
</DL>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Values for :3 llft are same as for :1 llft.
<DL COMPACT>
<DD>a= Autofill (optional)
<DL COMPACT>
<DD>0 = No fill characters, underscore to length.
<DD>1 = Underscore to length; fill data sent to terminal server is
ASCII spaces ( ).
</DL>
<DD>pp = Same as for :2 llft.
<DD>b = Same as for :2 llft.
</DL>
<P>Terminal autofills with spaces to the right.
Accepts data from the keyboard only.
See note 2 immediately preceding this table.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:4 llft = Alphanumeric keys or badge input expected
with validation.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Values for :4 llft are same as for :1 llft.
<P>The data is obtained from
whichever sensor has the data available. Accepts data from
the keyboard only.
<P>See notes 1 and 2 immediately preceding this table
(page <A HREF="#SPTKCMDREF">reference #2</A>).
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:6 cmessagec = Message sent from terminal server to be
displayed at the current cursor position.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%><DL COMPACT>
<DD>c = Character to delimit the end of the text to display on
the screen (allows any other character
in the message)
<DD>message = Text of message to be displayed
<DD>c = Actual delimiter character; repeated to indicate end of message
</DL>
<P>This command can only be used within CMD D from the terminal
server.
A :6 at the beginning of a transaction program clears the
screen and places the cursor at 1,1 (top left corner), just like the
:T (clear screen).
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:8 = Link function.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>A second key will always follow.
After the execution of the rest of the commands defined in the current
transaction program, message 9 from message File 8 is displayed to prompt
for the second key to be pressed.
All information collected by both transaction programs is sent back in
a single transmission.
<P>Must be used in the first position of a transaction program.
The usual data validation is allowed in the second key.
<P>A latched key (has a <B>;2</B>--see description under
";2 = Latching function" in this table)
can be the second key,
but the second key cannot have a linked function.
If it does, the transaction is aborted and an error message
is displayed on the terminal display (local error).
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:9 = Key not used (NOP).
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Must be used to define all unused key positions.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>;0 = <B>Hot</B> key.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Creates a transaction with function ID and timestamp, plus
sequence number if configured (must be the only command in a
transaction program).
<P>The format of the transaction record created by this command is
as follows:
<DL COMPACT>
<DD>Three-byte header
<DD>Timestamp as defined in offset 6 in record 00
<DD>Sequence number if configured in offset 21 in record 00
<DD>RS (record separator).
</DL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
For details about transaction records,
(See<A HREF="#HDRFUNID">File 9--Transaction Queue File</A>) .
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>;1 lld0 = Read variable length badge with no validation.
Use only with magnetic stripe or Code 3 of 9. <I>Do not</I> use
with UPC/A or I 2 of 5 bar codes.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>ll = Length of badge data (01-40 characters). Terminal will
left-justify data padded with ASCII spaces.
<DD>d = Controls for data display:
<DL COMPACT>
<DD>0 = <I>Do not</I> display data. No Enter key required.
<DD>1 = Display data. Enter key required to complete transaction.
</DL>
</DL>
<P>The data is obtained from whichever sensor has the data available.
<P>See note 1 immediately preceding this table
(page <A HREF="#SPTKCMDREF">reference #2</A>).
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>;2 = Latching function.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>This command must be used at the beginning of the transaction program.
The transaction record created by this transaction program is processed,
and this transaction program command is executed again.
Timer C is disabled during this type of transaction program.
<P>Latching transactions with interfacing errors (syntax errors)
abort the transaction program and return to the idle screen.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:A c = Autotrans state.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>c = Concatenate data to
transaction record when the next data read occurs.
<DL COMPACT>
<DD>0 = FALSE--Do not append to the transaction record
<DD>1 = TRUE --Append to the transaction record (DEFAULT)
</DL>
<P>
This command can be called repeatedly in any single transaction program. The
value is set to TRUE at the start of any transaction program. When any
data read operation is executed, the result of the read is saved in user
variable 0, and if Autotrans is TRUE, the data just read is appended to
the transaction record. If Autotrans is FALSE, the data read is not
automatically appended to the transaction record; you must append
the data to the transaction record yourself, using <B>:F</B>,
if you wish it to be there.
<P>If Autotrans is FALSE at the end of the transaction, you must write
the transaction record to the transaction queue file yourself.
(See<A HREF="#HDRFUNID">File 9--Transaction Queue File</A>) .
(Use <B>:W</B> to write transaction record to host)
Otherwise, if Autotrans is TRUE at the end of a transaction, the
transaction record is automatically written to the transaction queue
file.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:D ll = Delay.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>ll = 01-99 seconds
<P>Delay execution of the transaction program for a given amount of time.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:E srrrrrxxyya = Display message on display at row xx
and column yy.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>s = Source of message to be displayed
<DL COMPACT>
<DD>0 = From message File 8
<DD>1 = From user variable, number follows
<DD>2 = Other (transaction record, PF keys, touch screen regions)
</DL>
<DD> rrrrr = Record number or user variable number
<DL COMPACT>
<DD>rrrrr = Record number in File 8 if s = 0
<DD>rrrrr = 00000-00099 if s = 1 (can display user variable 0)
<DD>rrrrr = 00100 transaction record, if s = 2
<DD>rrrrr = 00101-00164 if s = 2 (101-112 PF keys
and 125-164 if touch screen regions in File <B>b</B>)
</DL>
<DD>xx = 01-20--Row on display
<DD>yy = 01-40--Column on display
<DD>if xx = 00 and yy = 00, then display at current
cursor position
<DD>a = display attribute for data on screen (valid only for
a particular message, and does not affect any subsequent message
that goes to the display)
<DL COMPACT>
<DD>0 = No blinking, normal, no underline (DEFAULT)
<DD>1 = No blinking, normal, underline
<DD>2 = No blinking, reverse video, no underline
<DD>3 = No blinking, reverse video, underline
<DD>4 = Blinking, normal, no underline
<DD>5 = Blinking, normal, underline
<DD>6 = Blinking, reverse video, no underline
<DD>7 = Blinking, reverse video, underline
</DL>
</DL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The source message in the :E command can be used to beep
the terminal rather than show a message. To beep the
terminal, use the hex BEL character 0x07 as the first
character in the message. The terminal will beep once. If
the BEL character is repeated, the beep will be repeated
with a half second delay following each.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:F nnnsrrrrr = Append.
Two other formats of this command are supported:
<P>
:F nnnsrrrrrPppplll = append from a given position 'ppp' for a
specific length 'lll'
<P>
:F nnnsrrrrrFfffddd = append specific field using delimiter 'ddd' to determine
where the fields are.
<P>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>nnn = Variable to be appended to
<DL COMPACT>
<DD>001-099 = Append to selected user variable #
(cannot append to user variable 0)
<DD>100 = append to transaction record
<DD>101-112 = Append to PF key as defined in File <B>b</B>
<DD>125-164 = Append to touch screen regions as defined in
File <B>b</B>
</DL>
<DD>s = Source of string to be appended
<DL COMPACT>
<DD>0 = From message File 8
<DD>1 = From user variable, number follows
<DD>2 = Other (transaction record, PF keys, touch screen regions)
</DL>
<DD>rrrrr = Record number or user variable number
<DL COMPACT>
<DD>rrrrr = Record number in file 8 if s = 0
<DD>rrrrr = 00000-00099 if s = 1
<DD>rrrrr = 00100 transaction record, if s = 2
<DD>rrrrr = 00101-00112 = PF key as defined in File <B>b</B>
<DD>rrrrr = 00125-00164 = Touch screen regions as defined in
File <B>b</B>
</DL>
</DL>
<P>If any modification is made to the PF key strings
during the transaction program, these values are reset
to their original values as defined in File <B>b</B> upon completion of the
transaction program.
<P>
If appending from a specific position/length from the source, then the
extra parameter bytes 'Pppplll' must follow the :Fnnnsrrrrr and they
have the following meaning:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>P
</B></TD><TD><P>is a constant letter indicate the Source Field is a starting position/
length pair.
</TD></TR><TR VALIGN=TOP><TD><P><B>ppp
</B></TD><TD><P>is the starting position (1-based)
</TD></TR><TR VALIGN=TOP><TD><P><B>lll
</B></TD><TD><P>is the length. A value of 000 means to take the rest of the user
variable/message/...
</TD></TR></TABLE>
<P>
If the specified position or length goes past the data that is available in
the source, an error will result and the transaction program will be aborted.
If there is no data in the source, it is not an error if position is set to
001 and the length is set to to 000.
<P>
If appending from a specific field using a delimeter to define the field, then
the extra parameter bytes 'Ffffddd' must follow the :Fnnnsrrrrr and they
have the following meaning:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>F
</B></TD><TD><P>is a constant letter indicate the Source Field is a Field number/Delimiter
character pair.
</TD></TR><TR VALIGN=TOP><TD><P><B>fff
</B></TD><TD><P>is the field number (1-based)
</TD></TR><TR VALIGN=TOP><TD><P><B>ddd
</B></TD><TD><P>is the ASCII value of the delimiter character used to determine where
the fields are in the data. For example, if the delimeter is a semicolon
then 059 should be used for this value.
</TD></TR></TABLE>
<P>
When appending a field, the delimeter character is not part of the data that
is appended.
<P>
If the specified field number does not exist in the data that is available in
the source, an error will result and the transaction program will be aborted.
It is not an error to specify a field that is empty - as long as the
delimeter character follows it; this would be the case where two delimters
are encountered in a row.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:G dddsss = GOTO a transaction program or to
the idle screen (abort).
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>ddd=000 for go to idle screen
<DD>ddd=001-121 for goto transaction program
<DD>ddd=999 to stay within current transaction program
<DD>sss=step within transaction program,
001-999 (sss ignored for ddd=000)
</DL>
This command has the following restrictions:
<OL>
<P><LI>Since the transaction program is parsed and executed as the
instructions are encountered, jumping to the middle of one
which has a ;2 (latch) as its first instruction doesn't enable
latching since the ;2 was not executed.
This is also true for the :8 (link) and :I (set mode)
command.
<P><LI>Cannot stay within the same transaction program if the current
transaction program is from a CMD D (function ID of 253).
</OL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:GS dddsss = GOSUB, branch to a subroutine.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
A subroutine can start at any step in any transation program but it must
eventually lead to a Return (;R) command at some step. When the Return
command is encounterd, control branches back to the step following the
GOSUB command.
<P>
Subroutines can call other subroutines - up to 50 levels of nesting deep.
<P>
Other than the S following the :G, this command has the same syntax
and restrictions as the GOTO (:G) command described previously.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:H nnn = Clear user variable nnn.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>nnn = Variable to clear
<DL COMPACT>
<DD>001-099 = User variable number (cannot clear user variable 0)
<DD>100 = transaction record
<DD>101-112 = PF key as defined in File <B>b</B>
<DD>125-164 = Touch screen regions as defined in File
<B>b</B>
</DL>
</DL>
<P>Turns variable to a null string.
<P>If any modification is made to the PF key strings
or touch screen regions
during the transaction program, these values are reset to
their original values as defined in File <B>b</B> upon completion
of the transaction program.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:I m = Set mode of transaction queue for current transaction.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>m = Mode of transaction queue:
<DL COMPACT>
<DD>0 = Interactive mode
<DD>1 = Buffered mode
</DL>
<P>This must be used at the start of a transaction program, and the mode is
valid for the duration of the current transaction. Mode selected in a
second link function key is ignored.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:J nnnlllrccclcccfccc = Format user variable.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>nnn = Source variable to format
<DL COMPACT>
<DD>001-099 = User variable number (cannot
format user variable 0)
</DL>
<DD>lll = Length of the resulting variable
<DL COMPACT>
<DD>000 = Variable length desired (no truncation or fill done to
variable)
<DD>001-128 = Exact length of resulting variable
</DL>
<DD>r = Strip characters on right indicator
<DL COMPACT>
<DD>0 = Do not strip characters on right
<DD>1 = Strip characters on right
</DL>
<DD>ccc = Number in ASCII of character to strip from right of string
(000-255; usually an ASCII space or zero--032 or 048)
<DD>l = Strip characters on left indicator
<DL COMPACT>
<DD>0 = Do not strip characters on left
<DD>1 = Strip characters on left
</DL>
<DD>ccc = Number in ASCII of character to strip from left of string
(000-255; usually an ASCII space or zero--032 or 048)
<DD>f = Truncation/fill direction
<DL COMPACT>
<DD>0 = Truncate/fill on left
<DD>1 = Truncate/fill on right
</DL>
<DD>ccc = Number in ASCII of character used to fill
(000-255; usually an ASCII space or zero--032 or 048)
</DL>
<P>Formats the selected string into a field of length <B>lll</B>.
Strips indicated leading and trailing characters, truncates field to the
length specified, or fills out the remainder of the field with the
indicated character.
<P>If lll = 000, then only the stripping is done.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:K nnnft = Validate user variable nnn.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>nnn = Variable to validate
<DL COMPACT>
<DD>000-099 = User variable number (can validate user variable 0)
</DL>
<DD>f = File ID of validation file
<DL COMPACT>
<DD>2-7, A-Z, a-z = Validation files
</DL>
<DD>t = Inclusive/exclusive validation type
<DL COMPACT>
<DD>0 = Data NOT in file
<DD>1 = Data in file
</DL>
</DL>
<P>Validates the contents of variable <B>nnn</B> against the validation file
specification. Continues with transaction if
validation succeeds; otherwise, cancels transaction.
<P>See note 2 immediately preceding this table
(page <A HREF="#SPTKCMDREF">reference #2</A>).
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:M pp = Read value of DIDO point.
<P><B>Note: </B> This command is not supported.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>pp = 0-7 DIDO point number to read
<P>Capable of reading output ports as well as digital input.
The value returned is the ASCII representation of the data read.
Logs error transaction if parallel/DIDO switch in wrong position.
(Interface error)
<P>
When a read from DI is requested, this initiates
the debouncing of the DI.
As with events, it must hold the state for 55 millisec.
A latency of 100 millisec for the <B>read</B> to return is possible.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:N ppvtt = Wait DI.
<P><B>Note: </B>ETS does not support digital I/O ports. This command is not supported.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>pp = 0-7--DI point number to read
<DD>v = Boolean value to wait for
<DL COMPACT>
<DD>0 = Point bit clear
<DD>1 = Point bit set
</DL>
<DD>tt = Timeout in seconds
<DL COMPACT>
<DD>00 = Wait forever
<DD>99 = 99 seconds is maximum timeout
</DL>
</DL>
<P>Suspends execution of currently defined transaction program in File 0
until value of DI point <B>pp</B>
equals <B>v</B>. If DI reading is not
satisfied before timeout expires, then transaction is cancelled.
Logs error transaction if
parallel/DIDO switch in wrong position and if <B>pp</B> is not a DI
point (application errors).
<P>If point is already in the correct state, no wait is done.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:P ppvtt = Write DO point.
<P><B>Note: </B>ETS does not support digital I/O ports. This command is not supported.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>pp = 0-7--DO point to write
<DD>v = Value to write
<DL COMPACT>
<DD>0 = Clear point p
<DD>1 = Set point p
<DD>T = Toggle current state of the DO
</DL>
<DD>tt = 00-99 = Time in seconds; 00 means forever and is
the default
</DL>
<P>Logs error transaction if parallel/DIDO switch in wrong position
and if <B>pp</B> is not a DO point (application error).
<P>If a point is set and the command is to set it for a specified time,
after the timeout the point reverts back to its original
state (set in this case).
<P>If <B>v=T</B> and <B>tt</B>
is not equal to zero, then this is the way to pulse a DO.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:Q = Terminate the current key definition and
send transaction created so far.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Generates a "T" transaction for terminated in
interactive mode or a "U" transaction for
terminated in buffered mode. For example,
this command allows the data accumulated so
far in a transaction to be transmitted
instead of aborting the entire transaction on
a validation error.
<P>
Transaction types are:
<DL COMPACT>
<DD>I = Interactive mode
<DD>B = Buffered mode
<DD>E = Error transaction - interactive mode
<DD>F = Error transaction - buffered mode
<DD>V = Validation needed
<DD>T = Transaction truncated - interactive mode
<DD>U = Transaction truncated - buffered mode
</DL>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:R abcdefghijk rlllfte = Read data with validation.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>a-k = Device mask. The position is set to 1 if a read
from that device is required.
Multiple positions can be set on to allow for many combinations.
<DL COMPACT>
<DD>a = Numeric keyboard: 0-9, minus sign (-),
period (.), comma (,)
<DD>b = Alpha keyboard (alphanumeric)
<DD>c = PF key
<DD>d = Touch screen
<DD>e = Sensor port
<DL COMPACT>
<DD>0 = No sensor input
<DD>1 = Alphanumeric sensor data allowed
<DD>2 = Numeric data only allowed
</DL>
<DD>f = RS-232 (GP communications)
<DL COMPACT>
<DD>0 = No RS-232 input
<DD>1 = Alphanumeric RS-232 data allowed
<DD>2 = Numeric data only allowed
</DL>
<DD>g-k = Reserved (set to 0)
</DL>
<DD>r = Type of read
<DL COMPACT>
<DD>0 = Fixed length read
<DD>1 = Variable length read
</DL>
<DD>lll = Max length of read if variable read or
exact length of read if fixed length read
(that is, actual length or max length
returned to the application program)
<DD>f = File ID of validation file
<DL COMPACT>
<DD>0 = No validation
<DD>2-7, A-Z, a-z = Validation files
</DL>
<DD>t = Inclusive/exclusive validation type
<DL COMPACT>
<DD>0 = Data NOT in file
<DD>1 = Data in file
</DL>
<DD>e = Echo to display/timeout
<DL COMPACT>
<DD>0 = Echo off, normal timeout
<DD>1 = Echo on, normal timeout
<DD>2 = Echo off, wait forever
<DD>3 = Echo on, wait forever
</DL>
</DL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
ETS supports PF Key strings 1-12 as input but it does not support Shifted PF
Key strings or Touch Screen strings as input.
<P>
ETS does not currently support reading from the RS-232 (GP communications)
port using the READ (:R) command. To read from the RS-232 port, use the
CFR API ComRead().
</td></tr></table>
<P>Data is read into user variable 0.
See note 2 immediately preceding this table.
The maximum length for keyboard read is 40, and the maximum
length for GP communications is 128.
<P>In the case of GP communications,
the DCT reads no more than <B>lll</B> characters, or up to the
message end sequence if it exists, whichever comes first.
It times out after <B>timeout</B> in configuration
table (byte 107/108).
The message start and the message end
sequences are not returned as part of the string
read, but are flushed from the buffer.
If neither <B>lll</B> characters nor the message
end sequence is present, the DCT will wait up to configuration table
<B>timeout</B> time for one of these conditions to be satisfied.
If value of 0 supplied for <B>lll</B>,
it will immediately read however many
characters are in the buffer for any device and wait for the message end
sequence if any is configured in record 00.
<P>If input from several sources (including the general purpose port)
is allowed, and invalid data is being detected from the general
purpose port,
pressing the <B>CLEAR</B> key (Esc for DCConnect Client) will allow data to
be entered from the other devices selected in this command.
(Continued on next page)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:R abcdefghijk rlllfte = Read data with validation
(continued).
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<P>Sensor read times out after Timer <B>C</B> timeout and data is
obtained from whichever sensor has the data available.
<P>Likewise, any keyboard read which is not satisfied is aborted
after Timer <B>C</B> timeout.
<P>If Echo is on, information from device read (except the RS-232 port)
is displayed at the current cursor position.
Any input data caused by pressing a PF key
or touch screen region is also echoed.
<P>The current
cursor position defines the beginning of where the underscore (_)
will begin on the display line. The actual placement of the cursor
for the data entry will still be at the start of the input field (which
is the far right for numeric data and the far left for alphanumeric
data).
For additional information about numeric and alphanumeric data entries,
(See<A HREF="#HDRVALID">Validation of Device Input Data</A>) .
<P>See notes 1 and 2 immediately preceding this table
(page <A HREF="#SPTKCMDREF">reference #2</A>).
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:S uuu d ooo = Set a shift offset factor for
adding to the characters of a user variable.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>uuu = the user variable number(001-099)
<DD>d = the direction of offset
0 = positive
1 = negative
<DD>ooo = the ASCII representation of the offset (000-255)
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:T (rr cc ll) = Clear display and put cursor
in upper left corner of the display.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
Optional parameters:
<DL COMPACT>
<DD>rr = row (01-20), if 00 current row is used
<DD>cc = column (01-40), if 00 current column is used
<DD>ll = length to clear (01-99), if 00 clear from rrcc to end of line
</DL>
With no parameters present the command
executes as in TS. The parameters are not
available when ETS is operating in TS mode.
If the optional parameters are used, the cursor is placed at the
end of the cleared field.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:U rrcc = Set cursor position.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>rr = Row number = 01-20
<DD>cc = Column number = 01-40
</DL>
<P>Logs error transaction if row and/or column are out of range for
this DCT display (application error).
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:W tsrrrrr = Write data from source to target.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>t = Target
<DL COMPACT>
<DD>0 = RS-232 (GP communications)
<DD>1 = Printer (Not supported by ETS)
<DD>2 = Host (terminal server)
</DL>
<DD>s = Source of write
<DL COMPACT>
<DD>0 = From message File 8
<DD>1 = From user variable, number follows
<DD>2 = Other (transaction record, PF keys, touch screen regions)
</DL>
<DD> rrrrr = Record number or user variable number
<DL COMPACT>
<DD>rrrrr = Record number in file 8 if s = 0
<DD>rrrrr = 00000-00099 if s = 1 (can write from user variable 0)
<DD>rrrrr = 00100 transaction record, if s = 2
<DD>rrrrr = 00101-00112--PF key as defined in
File <B>b</B>
<DD>rrrrr = 00125-00164--Touch screen regions as defined in
File <B>b</B>
</DL>
</DL>
<P>
If you are writing a transaction record to the host (terminal server)
the timestamp and sequence number are automatically appended
to the record before it is written.
<P>If you are writing to the RS-232 port, you must
provide all the required framing characters.
This is not automatically done by ETS if these sequences are not
defined in File 0 record 00. If the message start/end
sequences are
defined, then they are appended to the message before it is
written to the RS-232 port.
<P>
In most cases, the function ID that is returned in the transaction
data is for the program that initiated the transaction.
However, when using any command that branches to another program
(e.g. :G = GOTO or :Z = ONKEY) there is an exception.
If the execution branches to another program and that program or
any other issues a :W (write) to the host, the function
ID that is returned in the transaction data will be that of the program
that issued the :W.
In other words, whatever program does the :W, this is the function
ID used in the transaction data.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:X = Denote the beginning and end of the
screen navigation region.
<P><B>Note: </B>Screen navigation is not supported by ETS.
<A NAME="SPTCOLONX"><I>(Ref #3.)</I></A>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:Y = Denote a pause for input point in the
screen navigation region
<P><B>Note: </B>Screen navigation is not supported by ETS.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:Z tcccdddsss(cccdddsss...) = ONKEY goto.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Wait for a single key and jump to another
point in the current transaction program or
another transaction program or to the idle screen
(abort the transaction).
<DL COMPACT>
<DD>t = 0 for wait forever, = 1 for wait for timer C (operator input timeout)
<DD>ccc = Key event to look for:
<DL COMPACT>
<DD>001-026 terminal keys A-Z
<DD>027-028 next two keys in keypad matrix after Z
<DD>031-042 PF keys 1-12
<DD>043-054 Shifted PF keys 1-12 (not supported by ETS)
<DD>073-112 touch screen regions 1-40 (not supported by ETS)
</DL>
<DD>ddd = 000 for go to idle screen
<DD>ddd = 001-121 for goto transaction program
<DD>ddd = 999 to stay within current transaction program
<DD>sss = step within transaction program, 001-999 (sss
ignored for ddd = 000 but must be present)
</DL>
The sequence "cccdddsss" is repeated as
necessary for each key event to be detected. If
none of the keys (as specified by the "ccc"
fields) are hit, the command waits for another
key or until the timeout period expires (if
enabled by "t", which aborts the transaction)
or until "Cancel" is hit (which, as always,
aborts the transaction).
<P>This command has the following restriction(s):
<OL COMPACT>
<LI>Since the transaction program is parsed and executed as the
instructions are encountered, jumping to the middle of one
which has a ;2 (latch) as its first instruction doesn't enable
latching since the ;2 was not executed.
This is also true for the :8 (link) and :I (set mode)
command.
</OL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>Even though ETS does not support
DI points, touch screen regions,
shifted PF keys, and so forth, the :Z command can still
branch to transaction programs in
file <B>0</B> at the record numbers used for those
events or any other event.
</td></tr></table>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>:ZS tcccdddsss(cccdddsss...) = ONSUB, wait for key and then branch
to a subroutine.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
A subroutine can start at any step in any transation program but it must
eventually lead to a Return (;R) command at some step. When the Return
command is encounterd, control branches back to the step following the
ONSUB command.
<P>
Subroutines can call other subroutines - up to 50 levels of nesting deep.
<P>
Other than the S following the :Z, this command has the same syntax
and restrictions as the ONKEY (:Z) command described previously.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>;7 uuullltext... = Append data to user
variables from inline strings of data
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>uuu = the user variable number (001-099)
<DD>lll = the length of the string
<DD>text... = the string to append to the user variable
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>;A nn = Alias transaction ID
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>This command is used to assign an alias identification to the
transaction in progress.
If the terminal server processes transactions differently
according to the key or other event which started the transaction, the
alias command can be used to allow the terminal server to accept a
transaction as if it were initiated by another event.
<DL COMPACT>
<DD>nn = the transaction ID change target in ASCII hex (00-FF)
</DL>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>;C ltt = Activate selected LED for selected interval
<P><B>Note: </B>The Panel LED is physically indicated on the 7524 terminal with a display
annunciator (icon). The magnetic port LEDs are not supported. The
DCConnect Client do not support any LEDs.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>l = Selected LED
<DL COMPACT>
<DD>0 = Panel LED
<DD>1 = Magnetic port 1 LED1
<DD>2 = Magnetic port 1 LED2
<DD>3 = Magnetic port 1 LED3
<DD>4 = Magnetic port 2 LED1
<DD>5 = Magnetic port 2 LED2
<DD>6 = Magnetic port 2 LED3
</DL>
<DD>tt = Number of 20 millisec intervals (00 = stay on forever)
</DL>
<P>User can activate multiple LEDs at the same time.
<BR></TD></TR><TR>
<A NAME="SPTCALLCFR"><I>(Ref #4.)</I></A>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>;M fnn(abcd...) = Command to call CFR
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<UL COMPACT>
<LI>f = function number
<UL COMPACT>
<LI>0 = initialization
<LI>2 = power-fail restart
<LI>Other values user defined.
</UL>
<LI>nn = number of parameter characters that
follow, must be 00 if none
<LI>abcd... = optional parameters for CFR (CFR
returns flag to skip, not skip, or abort following command)
</UL>
This command does not clear the screen when it is called or after it is completed.
Areas written by the CFR can be overwritten by the transaction program.
Therefore, if a transaction program does not do anything to the screen except
within the CFR, the user should use :T (Clear screen) in the
transaction program.
This will indicate to ETS that something was done to the screen, causing
the idle screen/prompt to be refreshed at the end of the transaction
program.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>;N uuu = Test user variable
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%> uuu = user variable number (000-099)
This command tests for the user variable to
be not null. It skips the next command if
the data is not null; otherwise the next
command is executed.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>;O d uuu = Save the cursor position to a user
variable (UV) or restore the cursor position
from a user variable.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<DL COMPACT>
<DD>d = direction
<DL COMPACT>
<DD>0 = save to UV,
<DD>1 = restore from UV
</DL>
<DD>uuu = user variable number (001-099)
</DL>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=3%>;R = RETURN from a subroutine
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
Use this command to return from a subroutine that
was called from either a GOSUB (:GS) or ONSUB (:ZS)
command.
<P>
If no subroutine has been called and the RETURN command is used, an error
will result and the transaction program will be aborted.
<P>
Subroutines can call other subroutines - up to 50 levels of nesting deep.
<BR></TD></TR></TABLE>
<P>
<H4><A NAME="Header_114" HREF="#PToC_114">Examples of Function Key Record Formats for File 0</A></H4>
<P><A HREF="#TBLFKEYREC">Table 7</A> contains examples of
typical function key record formats for File 0, for selected records.
<BR>
<P><B><A NAME="TBLFKEYREC">Table 7. Sample Function Key Record Formats for File 0</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP>Record Number
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Record Format
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=98%>Meaning
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Result
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>01
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>:9RS
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>:9 = Unused key.
<P>RS = Record separator.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>None
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>02
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>:012:10641RS
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<P>:012 = Write record 12 (File 8) to display.
<P>:10641 = Read badge. Validate length =6. Validate data in
File 4 with positive file search.
<P>RS = Record separator.
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Transaction record follows:
<P>Function ID = 02
<P>Badge data = BBBBBB
<P>Timestamp = HHMMSS (see note).
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>06
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>;0RS
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<P>;0 = Hot key.
<P>RS = Record separator.
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Transaction record follows:
<P>Function ID = 06
<P>Timestamp = HHMMSS (see note).
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>07
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>:206001031RS
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<P>:20600 = Accept keyed numeric data. Length = 6. No
validation.
<P>1031 = Advanced feature parameters available on (:2) and
(:3). Parameter values:
<P>1 = Fill with zeroes to length (overrides length check).
<P>03 = Position the leftmost character at display position 03.
<P>1 = Write to the display buffer.
<P>RS = Record separator.
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Transaction record follows:
<P>Function ID = 07
<P>Numeric data = NNNNNN
<P>Timestamp = HHMMSS (see note).
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP COLSPAN=4><B>Note: </B>Timestamp is selected in byte 6 of File 0, record 00.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP>08
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>:I0:U1307
:R100000000000010000
:W0200100:A0RS
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>:I0 = Set transaction queue mode to interactive for this
transaction
<P>:U1307 = Set cursor to row 13, column 7
<P>:R1000000000 = Read from numeric keypad
<P>0 = Fixed length read
<P>010 = Length of read is 10
<P>0 = No validation
<P>0 = Data not in file
<P>0 = Echo off, normal timeout
<P>:W0200100 = Write transaction record to RS-232
<P>:A0 = Do <I>not</I> append data to transaction record
<P>RS = Record separator.
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>No transaction record is created.
</TD></TR></TABLE>
<P>
<H3><A NAME="HDRFIL1FCT" HREF="#PToC_115">File 1--Fast Clocking Times</A></H3>
<P>File 1 is used to hold the start and stop times when the terminal
will automatically switch to a fast clocking mode.
<P>
<H4><A NAME="HDRR0TIMPR" HREF="#PToC_116">Record 0--Fast Clocking Time Periods</A></H4>
<DL COMPACT>
<DD>colon (:) in first byte = Fast clocking not used or
<DD>semicolon (;) in first byte = Continuous fast
clocking or
<DD>HHMM:HHMM = Start-stop in 24-hour format.
</DL>
<P>
<H4><A NAME="HDRR199ADD" HREF="#PToC_117">Records 1-99--Additional Time Periods</A></H4>
<DL COMPACT>
<DD>HHMM:HHMM = Start-stop in 24-hour format.
</DL>
<P>
<H3><A NAME="HDRFIL27US" HREF="#PToC_118">Files 2-7--User Validation Files</A></H3>
<P>Files 2-7 are text validation files.
These files are alphanumeric.
They may contain variable or fixed length text records for validation
of data entered from any source.
If fixed length is used, then all records in the file must be of equal
length.
The maximum file size is 65000 bytes.
<P>The number of records is user-defined, based on the amount of storage
allocated for these files. Files may be sorted or unsorted.
The records are separated by <I>RS</I>.
<P>
After download, all <I>RS</I> characters are converted to
NULL characters (which have an ASCII value of 0).
<P>
<H3><A NAME="HDRFIL8MSG" HREF="#PToC_119">File 8--Message File</A></H3>
<P>File 8, an alphanumeric file, contains
message records, which are written to the display under control
of ETS and the key commands <B>:0</B> or
<B>:E</B>.
Both <B>:0</B> and <B>:E</B> may be
used to display messages in File 8,
but only <B>:E</B> may be used to display the
full range of messages (0000-9999) in addition to
a row and column specification.
<P>File 8 has a maximum width of 44 characters and contains
between 99 and 9999 records.
The first four characters define the record number.
<P>Data transparency is handled by leading ESC characters, which then
allows embedded RS, ESC, and other special characters in the message.
To embed special characters in File 8, use the escape sequences
given in <A HREF="#TBLMBEDESC">Table 8</A>.
<BR>
<P><B><A NAME="TBLMBEDESC">Table 8. Escape Sequences for Embedding Special Characters in File 8</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Decimal Value
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>ASCII Character
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=98%>Escape Sequence
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>00
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>NUL
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>ESC-ESC-ESC-ESC-000
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>01
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>SOH
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>ESC-SOH
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>02
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>STX
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>ESC-STX-ESC
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>03
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>ETX
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>ESC-ETX
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>21
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>NAK
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>ESC-NAK
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>27
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>ESC
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>ESC-ESC-ESC-ESC
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>30
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>RS
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>ESC-ESC-RS
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP COLSPAN=3><B>Note: </B>
NUL = Null character
SOH = Start of header
All other ASCII characters are defined in <A HREF="#TBLASCII">Table 1</A>.
These characters do not require ESC characters.
</TD></TR></TABLE>
<P>Records 0-9999 are used by the DCTs.
The records in the file are in sequence
but are not necessarily contiguous.
(Records are sorted in ascending order by
record number; however, it is not necessary that all numbers be there.
The first 10 must always be there.)
<P>If configured in File 0 record 00 bytes 124-128 to have
an idle menu as well as an idle prompt,
the <B>n-1</B> records (<B>n</B> is the number of lines
on the DCT display) that make up the idle menu are within
9000-9019 of File 8.
The last line on the display is the idle prompt found
in message 0 in File 8.
<P>All messages sent to the DCTs will be transmitted as
variable length records terminated with a record separator
(<I>RS</I>).
<P>The total number of records is user-defined; however, the first ten
records (0-9) are reserved for system messages.
An <I>RS</I> must end each record, even if the text of the
message is exactly 40 bytes or less.
<P>The following system
messages should be downloaded by the user:
<UL COMPACT>
<LI>0000-0009
<LI>9000-9400
<LI>9601-9899.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
See <A HREF="#TBLFILE8">Table 9</A> for message contents.
</td></tr></table>
</UL>
<P><A HREF="#TBLFILE8">Table 9</A> specifies
the use of the previously listed messages for the records within
File 8.
<BR>
<P><B><A NAME="TBLFILE8">Table 9. File 8 Record Descriptions</A></B><BR>
<TABLE>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=2%>File 8 Record Number
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=98%>Message Description
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>0000
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Idle menu prompt
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>0001
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Operator timeout (Timer <B>C</B>) message
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>0002
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Invalid length on barcode or badge message
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>0004
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Invalid operation message
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>0005
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Fast clocking idle loop message
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>0006
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Waiting for terminal server (interactive mode) message
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>0007
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Host down, buffering data (interactive mode) message
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>0008
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Good read message (after the transaction completes when DCT is in
buffered mode)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>0009
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Link message
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>0010-8999
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>User messages
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>9000-9999
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>Reserved for system messages
<UL COMPACT>
<LI>9000-9100 = Local system messages
<UL COMPACT>
<LI>9000-9029 = Idle menu messages
<LI>9030 = Remote validation in process
<LI>9039 = Buffer full message (while in buffered mode)
<LI>9040 = Out-of-service message (CMD A)
<LI>9041 = Second key in a linked function contains a link function
<LI>9042 = Message not in File 8
<LI>9044 = RS-232 input--cannot have variable length with no end
message configured
<LI>9045 = RS-232 input--maximum length reached
<LI>9047 = RS-232 input timeout--no start message found
<LI>9048 = RS-232 input timeout--no end message found
<LI>9049 = RS-232 input timeout--length not matched
<LI>9051 = Message cannot be displayed while out of service
<LI>9052 = RS-232 retry
<LI>9053 = RS-232 input--invalid length
</UL>
</UL>
Errors returned from BIOS API calls
<UL>
<P><LI>9201-9300 = Failed POST on device #n
<P><LI>9301 = Error return from BIOS #n call message
<P><LI>9316 = BIOS error--ComWrite
<P><LI>9354 = BIOS error--Activate LED
</UL>
<UL COMPACT>
<LI>9601-9800 = Application exception messages
<UL COMPACT>
<LI>9602 = Port not DI port
<LI>9603 = Port not DO port
<LI>9604 = Row and/or column out of range
<LI>9605 = String operation exceeds the maximum length of string
variable
<LI>9606 = Timeout waiting for DI to change state
<LI>9607 = String to display too long for display at current
cursor position
<LI>9608 = Port not configured for printer
<LI>9610 = Maximum data length reached for transaction
<LI>9611 = Failure of data in remote validation
<LI>9612 = Failure of data validation in file 2
<LI>9613 = Failure of data validation in File 3
<LI>9614 = Failure of data validation in File 4
<LI>9615 = Failure of data validation in File 5
<LI>9616 = Failure of data validation in File 6
<LI>9617 = Failure of data validation in File 7
<LI>9618 = RS-232 input--invalid data
<LI>9619 = Failure of data validation in
extended validation file
<LI>9620 = Graphics not supported on Model 001
<LI>9671 = Only numeric data valid
<LI>9672 = No CFR downloaded
<LI>9673 = Maximum data files reached
</UL>
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>9000-9999 (continued)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=98%>
<LI>9801-9899 = Interfacing error messages
<UL COMPACT>
<LI>9801 = Error in key event command string
<LI>9802 = Parameter out of range
<LI>9803 = Error in host command
<LI>9804 = Host time out
<LI>9805 = Trying to download past end of file
<LI>9806 = Trying to download uninitialized file
<LI>9807 = Invalid file size
<LI>9808 = Invalid record number in File 8
<LI>9809 = No download allowed--data in File 9
<LI>9810 = Invalid command
<LI>9811 = No download allowed--terminal in service
<LI>9812 = Download error--not enough memory available
<LI>9813 = Error in cursor control sequence
<LI>9814 = File not downloaded
<LI>9815 = Set mode command (<B>:I</B>) must be first in
key definition
<LI>9816 = Latch key command (<B>;2</B>) must be first in
key definition
<LI>9817 = Link key command (<B>:8</B>) must be first in
key definition
<LI>9818 = Parameter out of range in File 0 record 00--default used
<LI>9819 = Parallel/DIDO switch in wrong position
<LI>9820 = File 0 record 00 must be 202 or 204
bytes long--must redownload
<LI>9821 = Syntax error in File 1--FastClocking disabled
<LI>9822 = File <B>A</B> must be 161 bytes long--keypad not
remapped
<LI>9823 = Must clear file 9 before going in service
<LI>9824 = Syntax error in Graphics Sequence
<LI>9825 = A CMD :X must mark end of Editing
command
<LI>9826 = An editing command must contain :Y.
<LI>9827 = Only one :R may be associated with
each :Y.
<LI>9828 = File D not downloaded.
<LI>9829 = Record number not found in File D.
</UL>
</UL>
<UL COMPACT>
<LI>9900-9999 = Special ASCII character strings
<UL COMPACT>
<LI>9900-9931 = First 32 ASCII
<LI>9941 = 1 space
<LI>9942 = 2 spaces
<LI>9943 = 3 spaces
<LI>9944 = 4 spaces
<LI>9945 = 5 spaces
<LI>9946 = 6 spaces
<LI>9947 = 7 spaces
<LI>9948 = 8 spaces
<LI>9949 = 9 spaces
<LI>9950 = 10 spaces
<LI>9951 = 20 spaces
<LI>9952 = 40 spaces
</UL>
</UL>
<BR></TD></TR></TABLE>
<P>
<H3><A NAME="HDRFUNID" HREF="#PToC_120">File 9--Transaction Queue File</A></H3>
<P>File 9 is the transaction queue file. It is used by ETS
to store buffered transaction records. These
records are sent in a FIFO sequence by the terminal when the host
is able to accept and release them.
<P>All transaction records begin with a three-byte header.
The first byte contains the type of transaction, and the next two bytes
contain the function (transaction) ID (in ASCII hex).
The maximum size of a transaction record is 129 bytes, which includes
the framing characters STX, CS1, CS2, and ETX.
<P>Valid values for byte 1 are:
<DL COMPACT>
<DD>I = Interactive mode
<DD>B = Buffered mode
<DD>E = Error transaction--interactive mode
<DD>F = Error transaction--buffered mode.
<DD>V = Request for remote validation
<DD>T = Transaction terminated - interactive mode
<DD>U = Transaction terminated - buffered mode
</DL>
<P>Bytes 2 and 3 bytes represent the
function or transaction ID as an ASCII hex string if byte 1 is I, B, E, F, T, or U.
<P>The transaction data follows the ID as it was entered,
in most cases.
The timestamp follows the data.
A sequence number can follow the timestamp.
The last entry of each transaction record is always <I>RS</I> (record
separator).
<P>
<H4><A NAME="Header_121" HREF="#PToC_121">Validation Transaction Format</A></H4>
The validation transaction format accommodates
1-12 character file names. The format is:
<DL COMPACT>
<DD>V = validation transaction
<DD>nn = field number
<DD>RS = record separator, present if file
name is more than 1 character
<DD>fff..ff = file name (1-12 characters)
<DD>RS = record separator, present if file
name more than 1 character
<DD>v = validation type, inclusive or exclusive
<DD>ll = length of field
<DD>ddd..dd = data to validate
</DL>
<P>
<H4><A NAME="Header_122" HREF="#PToC_122">Transaction IDs</A></H4>
<P>The transaction (also known as "function") IDs
in hex (with corresponding record numbers in File 0,
in decimal format) are given in <A HREF="#TBLFIDS">Table 10</A>.
<BR>
<P><B><A NAME="TBLFIDS">Table 10. Transaction ID Cross-Reference</A></B><BR>
<TABLE>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Transaction ID (Hex)
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=2%>File 0 Record Numbers (Decimal)
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=97%>Description
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>01-1A
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>01-26
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Terminal keys A-Z.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1B-1C
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>27-28
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Next two keys in keyboard matrix after <B>Z</B>.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1D
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>29
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Incoming data on sensors, fast clocking not active =
badge-initiated transaction with no fast clocking.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1E
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>30
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Incoming data on sensors, fast clocking active =
badge-initiated transaction with fast clocking.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>1F-2A
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>31-42
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>PF keys 1-12.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>2B-36
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>43-54
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Shift PF keys 1-12.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>37
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>55
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Incoming data GP port 1.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>38
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>56
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Unassigned.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>39-40
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>57-64
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>DI ports 0-7 programs
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>41-48
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>65-72
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Unassigned.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>49-70
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>73-112
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Touch screen regions 1-40 program locations.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>71-78
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>113-120
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Unassigned. Extra keys.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>79
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>121
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>New hour on the TOD clock.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>FC
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>252 (Not in File 0)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
Transaction created as result of the configured error logging requested
in File 0, record 00, byte 7.
Error message follows.
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>FD
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>253 (Not in File 0)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>
Transaction created by terminal server CMD D (initiate
data collection from terminal server).
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>FE
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>254 (Not in File 0)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Transaction created by interfacing error on the DCT.
Error information follows.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>FF
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>255 (Not in File 0)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>Transaction created by device error on the DCT.
Error information follows.
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>ZZ
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=2%>Not applicable
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=97%>ETS initialization detected a device failed its POST.
Error information follows.
</TD></TR></TABLE>
In the case of a transaction requesting remote validation,
the format of the transaction record is as follows:
<UL>
<P><LI>Byte 1 = ASCII V
<P><LI>Byte 2 - 3 = Decimal number (01 - 99) which indicates the nth ':'
or ';' in the transaction program
<P><LI>Byte 4 = File ID of validation file on the terminal server
(A - Z)
<P><LI>Byte 5 = Validation type
<UL>
<P><LI>0 = Data not in file (negative)
<P><LI>1 = Data in file (positive)
</UL>
<P><LI>Byte 6 - 7 = Length of data field to validate in decimal (01 - 99)
<P><LI>Bytes 8 - end = ASCII data that needs remote validation.
</UL>
<P>
<H3><A NAME="Header_123" HREF="#PToC_123">File c--Custom Function Routine Support</A></H3>
<P>
Custom Function Routines (CFRs) are loaded into file c, and flexible
calling and return sequences are defined.
For more information on CFRs,
(See<A HREF="#HDRCH1">Introduction to C Programming on terminals running 7524 ETS or the DCConnect Client</A>) ,
(See<A HREF="#HDRCFR">Writing Custom Function Routines</A>) , and
(See<A HREF="#HDRC9">Device-level CFR Functions</A>) .
<P>
<H3><A NAME="Header_124" HREF="#PToC_124">File e--Extended Validation Support</A></H3>
<P>
File "e" is a downloadable lookup table that
provides a cross reference between single
character file names and multi-character
(extended) file names of validation files.
Key definition commands reference validation
files (58 total) by the single-character
names 2-7, A-Z, and a-z and the files can be
local or at the terminal server.
Multi-character file names can be up to 12 characters.
For compatibility with TS, the lookup table will
default to files 2-7 and A-Z cross referenced
to single character file names '2' - '7' and 'A' - 'Z',
with no entries for files a-z.
<P>
The single-character names are used in several
transaction program commands as
well as in file 0 record 0; the full file name is
not used in either of these
places. The full file name is used by ETS in validation
transactions, in the
commands NA, NB, NC and ND, and can be used in calls to the
CFR APIs DataFile()
and Validation().
<P>Each record in file "e" has the format:
<B>x,f,f,f,...f,f,RS</B>
where:
<DL COMPACT>
<DD>x = the single character name
<DD>f,f,f,...f,f = the multi-character file name
<DD>RS = the ASCII record separator
</DL>
<HR>
<H1><A NAME="HDRERROR" HREF="#PToC_125">Error Reporting</A></H1>
<P>This chapter specifies ETS's error reporting capabilities
and describes the types of errors that can occur in ETS. Examples of
each error type are included.
<P>Under ETS, errors are grouped into four categories:
<OL>
<P><LI>Device errors and system software failures
<P><LI>Interfacing errors
<P><LI>Application exceptions
<P><LI>Local errors.
</OL>
<P>All errors in the first two categories generate an error transaction
record.
For further details about errors in the first category,
(See<A HREF="#HDRDEVCERR">Device Errors and System Software Failures</A>) .
For further details about errors in the second category,
(See<A HREF="#HDRINTFERR">Interfacing Errors</A>) .
<P>Errors in the third category generate an error transaction
record only if configured in the configuration table
(File 0 record 00 byte 7).
For further details,
(See<A HREF="#HDRAPLXMPL">Application Exceptions</A>) .
<P>Errors in the fourth category are reported to the local display
only and not to the terminal server.
For further details,
(See<A HREF="#HDRLOCLERR">Local Errors</A>) .
<P>The error transaction record provides an error identifier and
additional information to enable the user to
find out what caused the error.
<P><B>Notes: </B><OL>
<P><LI>The errors discussed in this chapter are transmitted as error
messages to the terminal server.
These errors correspond to the messages listed in
<A HREF="#TBLFILE8">Table 9</A> (records 9000-9999 in File 8).
<P><LI>For details about the
transaction record data format used for errors,
(See<A HREF="#HDRFUNID">File 9--Transaction Queue File</A>) .
</OL>
<HR>
<H2><A NAME="HDRDEVCERR" HREF="#PToC_126">Device Errors and System Software Failures</A></H2>
<P>The device errors are:
<UL COMPACT>
<LI>16 = ROM Microcode error--Com Write
<LI>54 = ROM Microcode error--Activate LED.
</UL>
<P>If a device error occurs during the execution of a transaction program
sequence, the following information is recorded:
<UL COMPACT>
<LI>Function ID (see <A HREF="#TBLFIDS">Table 10</A>.)
<LI>Sequence number of the command within the transaction program
<LI>Number of the ROM microcode subroutine call
<LI>Error code returned from the ROM microcode subroutine call.
</UL>
<P>The error information
is routed to the DCT display, using the
appropriate message in File 8 (messages 9201-9600) and remains displayed
for the time specified for Timer <B>B</B> in File 0 record 00. An
error transaction record in the following format
is also sent to the terminal server:
<OL>
<P><LI>The first byte has an <B>E</B> or <B>F</B> to indicate if
the error occurred during interactive or buffered mode.
<P><LI>The next two bytes contain <B>FF</B> to indicate that a
device/system software error has occurred.
<P><LI>The next series of bytes has the following fields, each separated
by an ASCII space:
<UL COMPACT>
<LI>Function ID (in hex) of transaction program executed (2 bytes).
(<B>ZZ</B> in
the two bytes indicates that there has been a failed POST detected by
the ETS initialization and the device number follows in the following
field instead of the sequence number.)
<LI>Sequence number of the failed command within the transaction program
(the device number if the above function ID is <B>ZZ</B>)
<LI>Number of the call that failed
<LI>The error code that was returned from the ETS subroutine
<LI>Optional text field, which can have a system message number
of a record in File 8.
</UL>
<P><LI>Timestamp
<P><LI>Sequence number.
</OL>
<HR>
<H2><A NAME="HDRINTFERR" HREF="#PToC_127">Interfacing Errors</A></H2>
<P> Some examples of interfacing errors are:
<UL COMPACT>
<LI>Parameter out of range in a transaction program command
<LI>Syntax error in a user file or terminal server message
<LI>Terminal server communication timeout.
</UL>
<P>If there is an interfacing error,
the following information is recorded:
<UL COMPACT>
<LI>File number
<LI>Indication of type of error
<LI>Record number
<LI>Byte position within the record.
</UL>
<P>The error
information is routed to the DCT display, using
the appropriate message in File 8 (messages 9801-9900) and remain
displayed for the time specified for Timer <B>B</B> in File 0
record 00. An
error transaction record in the following format is also sent to
the terminal server:
<OL>
<P><LI>The first byte has an <B>E</B> or <B>F</B> to indicate if
the error occurred during interactive or buffered mode.
<P><LI>The next two bytes contain <B>FE</B> to indicate that
an interfacing error has occurred.
<P><LI>The next series of bytes has the following fields, each separated by
an ASCII space:
<UL COMPACT>
<LI>f = file number where the error occurred (0-9, a-e).
(A <B>9</B> in
this field indicates that there is a problem involving the terminal
server.)
<LI>Indication of error type
<UL COMPACT>
<LI>1 = Error in transaction program command string
<LI>2 = Parameter out of range
<LI>3 = Syntax error in terminal server command
(the command and any associated text are
returned in the next two fields instead of the record number and the
byte position)
<LI>4 = Terminal server timeout
<LI>5 = Trying to download past end of file
<LI>6 = Trying to download uninitialized file
<LI>7 = Invalid file size
<LI>8 = Invalid record number in File 8
<LI>9 = No download allowed--data in File 9
<LI>10 = Invalid command
<LI>11 = No download allowed--terminal in service
<LI>12 = Download error--not enough memory available
<LI>13 = Error in cursor control sequence
<LI>14 = File not downloaded
<LI>15 = Set mode command (<B>:I</B>) must be first in
key definition
<LI>16 = Latch key command (<B>;2</B>) must be first in
key definition
<LI>17 = Link key command (<B>:8</B>) must be first in
key definition
<LI>18 = Parameter out of range in File 0 record 00--default used
<LI>19 = Parallel/DIDO switch in wrong position
<LI>20 = File 0 record 00 must be 202 bytes long--must redownload
<LI>21 = Syntax error in File 1--fast clocking disabled
<LI>22 = File <B>a</B> must be 161 bytes long--keypad not
remapped
<LI>23 = Must clear File 9 before going in service
<LI>24 = Syntax error in Graphics Sequence
<LI>25 = A CMD :X must mark end of Editing
command
<LI>26 = An editing command must contain :Y.
<LI>27 = Only one :R may be associated with
each :Y.
<LI>28 = File D not downloaded.
<LI>29 = Record number not found in File D.
<LI>30 = Goto command cannot jump into middle
of Edit Screen sequence.
<LI>31 = Goto command cannot jump out of the
middle of Edit Screen sequence.
<LI>32 = :Yrrcc and :Y are only allowed
inside an Edit Screen sequence.
<LI>33 = :Yrrcc not first command inside edit
sequence.
<LI>34 = One and only one :Y must be
associated with each :Yrrcc.
</UL>
<LI>Record number in file where the error occurred
(not used in terminal server communications timeout)
<LI>Byte position within the record where the error occurred
(not used in terminal server communications timeout).
</UL>
<P><LI>Timestamp
<P><LI>Sequence number.
</OL>
<HR>
<H2><A NAME="HDRAPLXMPL" HREF="#PToC_128">Application Exceptions</A></H2>
<P>Some examples of application exceptions are:
<UL COMPACT>
<LI>Failed validation
<LI>Port not a DI
<LI>Port not a DO
<LI>Row and/or column out of range for display
<LI>String operation exceeds maximum length of a string variable
<LI>Timeout waiting for digital input (DI) to change state
</UL>
<P>These are reported to the terminal server only if
configured in byte 7 in record 00 of File 0,
and always reported on the local display.
<P>The error information is routed to the DCT display,
using the appropriate message in File 8 (messages
9601-9800) and remain displayed for the time specified for
Timer <B>B</B>
in File 0 record 00. An error transaction record in the
following format can be sent to the terminal server:
<OL>
<P><LI>The first byte has an <B>E</B> or <B>F</B> to indicate if
the error occurred
during interactive or buffered mode.
<P><LI>The next two bytes contain <B>FC</B> to indicate that this is a
configurable error logging record, determined by the error logging mode
in byte 7 of record 00 in File 0.
<P><LI>The next series of bytes has the following fields, each separated by
an ASCII space:
<UL COMPACT>
<LI>Function ID (in hex) of transaction program executed (2 bytes)
<LI>Sequence number of the failed command within the transaction program
<LI>Number of the exception (error) that occurred.
<P>The application exception numbers are as follows:
<UL COMPACT>
<LI>2 = Port not DI port
<LI>3 = Port not DO port
<LI>4 = Row and/or column out of range
<LI>5 = String operation exceeds the maximum length of string
variable
<LI>6 = Timeout for DI to change state
<LI>7 = String to display too long for display at current position
<LI>8 = Port not configured for printer
<LI>10 = Maximum data length reached for transaction
<LI>11 = Failure of data from remote validation
<LI>12 = Failure of data validation in file 2
<LI>13 = Failure of data validation in File 3
<LI>14 = Failure of data validation in File 4
<LI>15 = Failure of data validation in File 5
<LI>16 = Failure of data validation in File 6
<LI>17 = Failure of data validation in File 7
<LI>18 = RS-232 input--invalid data
<LI>19 = Validation failure using an extended validation file.
<LI>20 = Graphics not supported on Model 1
<LI>71 = Only numeric data valid
<LI>72 = No CFR downloaded
<LI>73 = Maximum data files reached
<P>
<DL COMPACT>
<DD>The format of the transaction created by
exception 19 is different than that of
other application exceptions in that the
extended validation file code is inserted in the transaction.
The file code used is the single character name
that is cross-referenced to the multi-character file name in
file "e".
The transaction is formatted as follows
(with each field separated by an ASCII space):
<UL>
<P><LI>"E" or "F" for interactive or buffered (1 byte)
<P><LI>"FC" for application exception (2 bytes)
<P><LI>Function ID (2 bytes)
<P><LI>Sequence number of the failed command within key/event handler.
<P><LI>Application exception number
</UL>
</DL>
</UL>
</UL>
<P><LI>Timestamp
<P><LI>Sequence number.
</OL>
<HR>
<H2><A NAME="HDRLOCLERR" HREF="#PToC_129">Local Errors</A></H2>
<P>Some examples of local errors are:
<UL>
<P><LI>Buffer full while still in buffered mode
<P><LI>Out-of-service message when the terminal is out of service
<P><LI>Second key in linked key contains a link function.
</UL>
<P>The error information is routed to the DCT display,
using the appropriate message in File 8 (messages 9000-9100),
and remains displayed for the
time specified for Timer <B>B</B> in File 0 record 00.
<P>The following local errors are used:
<UL COMPACT>
<LI>39 = Buffer full message (while in buffered mode)
<LI>40 = Out of service message (CMD A)
<LI>41 = Second key in a linked function contains a link function
<LI>42 = Message not in File 8
<LI>44 = RS-232 input--cannot have variable length with no end
message configured
<LI>45 = RS-232 input--maximum length reached
<LI>47 = RS-232 input timeout--no start message found
<LI>48 = RS-232 input timeout--no end message found
<LI>49 = RS-232 input timeout--length not matched
<LI>50 = RS-232 overflow
<LI>51 = Message cannot be displayed while out of service
<LI>52 = RS-232 retry
<LI>53 = RS-232 input--invalid length.
</UL>
<HR>
<H1><A NAME="HDRPART2" HREF="#PToC_130">C Language Programming for Extended Terminal Services</A></H1>
<P><A NAME="PToC2" HREF="#ToC">Partial Table-of-Contents</A>
<MENU>
<P><B><LI><A NAME=PToC_131 HREF="#HDRCH1" >Introduction to C Programming on terminals running 7524 ETS or the DCConnect Client</A></B>
<MENU>
<LI><A NAME=PToC_132 HREF="#Header_132" >General Requirements</A>
<LI><A NAME=PToC_133 HREF="#Header_133" >Non-Volatile Storage</A>
<LI><A NAME=PToC_134 HREF="#Header_134" >Memory Models</A>
<LI><A NAME=PToC_135 HREF="#Header_135" >Function Prototypes</A>
<LI><A NAME=PToC_136 HREF="#Header_136" >C Library Function Usage</A>
<LI><A NAME=PToC_137 HREF="#Header_137" >Program Development</A>
</MENU>
<P><B><LI><A NAME=PToC_138 HREF="#HDRCFR" >Writing Custom Function Routines</A></B>
<MENU>
<LI><A NAME=PToC_139 HREF="#HDRTOOLS" >CFR Programming Tools</A>
<LI><A NAME=PToC_140 HREF="#Header_140" >CFR Operating Modes</A>
<LI><A NAME=PToC_141 HREF="#Header_141" >Examples of CFR Usage</A>
<MENU>
<LI><A NAME=PToC_142 HREF="#Header_142" >Mode 1 CFRs</A>
<LI><A NAME=PToC_143 HREF="#Header_143" >Mode 2 CFRs</A>
</MENU>
<LI><A NAME=PToC_144 HREF="#Header_144" >Operating with a Mode 1 CFR</A>
<MENU>
<LI><A NAME=PToC_145 HREF="#Header_145" >Calling the CFR</A>
<LI><A NAME=PToC_146 HREF="#Header_146" >CFR APIs to ETS</A>
<LI><A NAME=PToC_147 HREF="#Header_147" >CFR Functions</A>
<LI><A NAME=PToC_148 HREF="#Header_148" >Creating and Sending Transactions</A>
<LI><A NAME=PToC_149 HREF="#Header_149" >Example Mode 1 CFR</A>
</MENU>
<LI><A NAME=PToC_150 HREF="#Header_150" >Operating with a Mode 2 CFR</A>
<MENU>
<LI><A NAME=PToC_151 HREF="#Header_151" >Calling the CFR</A>
<LI><A NAME=PToC_152 HREF="#Header_152" >CFR APIs to ETS</A>
<LI><A NAME=PToC_153 HREF="#Header_153" >CFR Functions</A>
<LI><A NAME=PToC_154 HREF="#HDRM2SEND" >Creating and Sending Transactions</A>
<LI><A NAME=PToC_155 HREF="#Header_155" >Example Mode 2 CFR</A>
</MENU>
<LI><A NAME=PToC_156 HREF="#Header_156" >Power-Failure Recovery Considerations</A>
<LI><A NAME=PToC_157 HREF="#Header_157" >Returning to the Transaction Program</A>
<LI><A NAME=PToC_158 HREF="#Header_158" >Battery Operation Time Considerations</A>
<LI><A NAME=PToC_159 HREF="#Header_159" >Using CFRs Developed for the 7526 and 7527</A>
<LI><A NAME=PToC_160 HREF="#Header_160" >Compiling and Linking a CFR</A>
<MENU>
<LI><A NAME=PToC_161 HREF="#Header_161" >General</A>
<LI><A NAME=PToC_162 HREF="#Header_162" >Required Compiler/Linker</A>
<LI><A NAME=PToC_163 HREF="#Header_163" >Compile Command for IBM C/2</A>
<LI><A NAME=PToC_164 HREF="#Header_164" >Link Command for IBM C/2</A>
<LI><A NAME=PToC_165 HREF="#Header_165" >Compile Command for Borland Turbo C++ 3.0 for DOS</A>
<LI><A NAME=PToC_166 HREF="#Header_166" >Link Command for Borland Turbo C++ 3.0 for DOS</A>
</MENU></MENU>
<P><B><LI><A NAME=PToC_167 HREF="#HDRC9" >Device-level CFR Functions</A></B>
<MENU>
<LI><A NAME=PToC_168 HREF="#HDRC8" >Introduction</A>
<LI><A NAME=PToC_169 HREF="#Header_169" >Summary List of Device-Level CFR functions</A>
<MENU>
<LI><A NAME=PToC_170 HREF="#HDRKBDF" >Keyboard</A>
<LI><A NAME=PToC_171 HREF="#HDRDTF" >Date/Time</A>
<LI><A NAME=PToC_172 HREF="#HDRSIPF" >Sensor Input Ports</A>
<LI><A NAME=PToC_173 HREF="#HDRSPKF" >Speaker</A>
<LI><A NAME=PToC_174 HREF="#HDRDISF" >LCD Display</A>
<LI><A NAME=PToC_175 HREF="#HDRMSF" >General Support</A>
<LI><A NAME=PToC_176 HREF="#Header_176" >Communications Port</A>
<LI><A NAME=PToC_177 HREF="#HDRTMRF" >Timer Support</A>
</MENU>
<LI><A NAME=PToC_178 HREF="#HDRKEY" >Reference - Keyboard</A>
<MENU>
<LI><A NAME=PToC_179 HREF="#Header_179" >KbdReadAscii</A>
<MENU>
<LI><A NAME=PToC_180 HREF="#Header_180" >C Format</A>
<LI><A NAME=PToC_181 HREF="#Header_181" >Comments</A>
</MENU>
<LI><A NAME=PToC_182 HREF="#Header_182" >KbdHandleArrowKeys</A>
<MENU>
<LI><A NAME=PToC_183 HREF="#Header_183" >C Format</A>
<LI><A NAME=PToC_184 HREF="#Header_184" >Comments</A>
</MENU></MENU>
<LI><A NAME=PToC_185 HREF="#HDRDATT" >Reference - Date/Time</A>
<MENU>
<LI><A NAME=PToC_186 HREF="#Header_186" >RtcGetAsciiDate</A>
<MENU>
<LI><A NAME=PToC_187 HREF="#Header_187" >C Format</A>
<LI><A NAME=PToC_188 HREF="#Header_188" >Comments</A>
</MENU>
<LI><A NAME=PToC_189 HREF="#Header_189" >RtcGetAsciiTime</A>
<MENU>
<LI><A NAME=PToC_190 HREF="#Header_190" >C Format</A>
<LI><A NAME=PToC_191 HREF="#Header_191" >Comments</A>
</MENU>
<LI><A NAME=PToC_192 HREF="#Header_192" >RtcGetDate</A>
<MENU>
<LI><A NAME=PToC_193 HREF="#Header_193" >C Format</A>
<LI><A NAME=PToC_194 HREF="#Header_194" >Comments</A>
</MENU>
<LI><A NAME=PToC_195 HREF="#Header_195" >RtcGetTime</A>
<MENU>
<LI><A NAME=PToC_196 HREF="#Header_196" >C Format</A>
<LI><A NAME=PToC_197 HREF="#Header_197" >Comments</A>
</MENU></MENU>
<LI><A NAME=PToC_198 HREF="#HDRSIP" >Reference - Sensor Input Ports</A>
<MENU>
<LI><A NAME=PToC_199 HREF="#Header_199" >SenActLed</A>
<MENU>
<LI><A NAME=PToC_200 HREF="#Header_200" >C Format</A>
<LI><A NAME=PToC_201 HREF="#Header_201" >Comments</A>
</MENU>
<LI><A NAME=PToC_202 HREF="#Header_202" >SenPower</A>
<MENU>
<LI><A NAME=PToC_203 HREF="#Header_203" >C Format</A>
<LI><A NAME=PToC_204 HREF="#Header_204" >Comments</A>
</MENU>
<LI><A NAME=PToC_205 HREF="#Header_205" >SenQueryData</A>
<MENU>
<LI><A NAME=PToC_206 HREF="#Header_206" >C Format</A>
<LI><A NAME=PToC_207 HREF="#Header_207" >Comments</A>
</MENU>
<LI><A NAME=PToC_208 HREF="#Header_208" >SenRead</A>
<MENU>
<LI><A NAME=PToC_209 HREF="#Header_209" >C Format</A>
<LI><A NAME=PToC_210 HREF="#Header_210" >Comments</A>
</MENU></MENU>
<LI><A NAME=PToC_211 HREF="#HDRTRANS" >Reference - Beeper</A>
<MENU>
<LI><A NAME=PToC_212 HREF="#Header_212" >SpkBeep</A>
<MENU>
<LI><A NAME=PToC_213 HREF="#Header_213" >C Format</A>
<LI><A NAME=PToC_214 HREF="#Header_214" >Comments</A>
</MENU>
<LI><A NAME=PToC_215 HREF="#Header_215" >SpkQuery</A>
<MENU>
<LI><A NAME=PToC_216 HREF="#Header_216" >C Format</A>
</MENU></MENU>
<LI><A NAME=PToC_217 HREF="#HDRLCDD" >Reference - LCD Displays</A>
<MENU>
<LI><A NAME=PToC_218 HREF="#Header_218" >VioClear</A>
<MENU>
<LI><A NAME=PToC_219 HREF="#Header_219" >C Format</A>
</MENU>
<LI><A NAME=PToC_220 HREF="#Header_220" >VioGetCurPos</A>
<MENU>
<LI><A NAME=PToC_221 HREF="#Header_221" >C Format</A>
<LI><A NAME=PToC_222 HREF="#Header_222" >Comments</A>
</MENU>
<LI><A NAME=PToC_223 HREF="#Header_223" >VioQuery</A>
<MENU>
<LI><A NAME=PToC_224 HREF="#Header_224" >C Format</A>
<LI><A NAME=PToC_225 HREF="#Header_225" >Comments</A>
</MENU>
<LI><A NAME=PToC_226 HREF="#Header_226" >VioReadCell</A>
<MENU>
<LI><A NAME=PToC_227 HREF="#Header_227" >C Format</A>
<LI><A NAME=PToC_228 HREF="#Header_228" >Comments</A>
</MENU>
<LI><A NAME=PToC_229 HREF="#Header_229" >VioReadCellStr</A>
<MENU>
<LI><A NAME=PToC_230 HREF="#Header_230" >C Format</A>
<LI><A NAME=PToC_231 HREF="#Header_231" >Comments</A>
</MENU>
<LI><A NAME=PToC_232 HREF="#Header_232" >VioReadChar</A>
<MENU>
<LI><A NAME=PToC_233 HREF="#Header_233" >C Format</A>
<LI><A NAME=PToC_234 HREF="#Header_234" >Comments</A>
</MENU>
<LI><A NAME=PToC_235 HREF="#Header_235" >VioReadCharStr</A>
<MENU>
<LI><A NAME=PToC_236 HREF="#Header_236" >C Format</A>
<LI><A NAME=PToC_237 HREF="#Header_237" >Comments</A>
</MENU>
<LI><A NAME=PToC_238 HREF="#Header_238" >VioSetCurPos</A>
<MENU>
<LI><A NAME=PToC_239 HREF="#Header_239" >C Format</A>
<LI><A NAME=PToC_240 HREF="#Header_240" >Comments</A>
</MENU>
<LI><A NAME=PToC_241 HREF="#Header_241" >VioSetCurType</A>
<MENU>
<LI><A NAME=PToC_242 HREF="#Header_242" >C Format</A>
<LI><A NAME=PToC_243 HREF="#Header_243" >Comments</A>
</MENU>
<LI><A NAME=PToC_244 HREF="#Header_244" >VioWrtCellString</A>
<MENU>
<LI><A NAME=PToC_245 HREF="#Header_245" >C Format</A>
<LI><A NAME=PToC_246 HREF="#Header_246" >Comments</A>
</MENU>
<LI><A NAME=PToC_247 HREF="#Header_247" >VioWrtCharStr</A>
<MENU>
<LI><A NAME=PToC_248 HREF="#Header_248" >C Format</A>
<LI><A NAME=PToC_249 HREF="#Header_249" >Comments</A>
</MENU>
<LI><A NAME=PToC_250 HREF="#Header_250" >VioWrtCharStrAtt</A>
<MENU>
<LI><A NAME=PToC_251 HREF="#Header_251" >C Format</A>
<LI><A NAME=PToC_252 HREF="#Header_252" >Comments</A>
</MENU>
<LI><A NAME=PToC_253 HREF="#Header_253" >VioWrtNCell</A>
<MENU>
<LI><A NAME=PToC_254 HREF="#Header_254" >C Format</A>
<LI><A NAME=PToC_255 HREF="#Header_255" >Comments</A>
</MENU>
<LI><A NAME=PToC_256 HREF="#Header_256" >VioWrtNChar</A>
<MENU>
<LI><A NAME=PToC_257 HREF="#Header_257" >C Format</A>
<LI><A NAME=PToC_258 HREF="#Header_258" >Comments</A>
</MENU></MENU>
<LI><A NAME=PToC_259 HREF="#HDRGSPT" >Reference - General Support</A>
<MENU>
<LI><A NAME=PToC_260 HREF="#Header_260" >HitWatchdog</A>
</MENU>
<LI><A NAME=PToC_261 HREF="#HDRCPREF" >Reference - Communications Port</A>
<MENU>
<LI><A NAME=PToC_262 HREF="#Header_262" >ComGetParms</A>
<MENU>
<LI><A NAME=PToC_263 HREF="#Header_263" >C Format</A>
<LI><A NAME=PToC_264 HREF="#Header_264" >Comments</A>
</MENU>
<LI><A NAME=PToC_265 HREF="#Header_265" >ComGetProtocol</A>
<MENU>
<LI><A NAME=PToC_266 HREF="#Header_266" >C Format</A>
<LI><A NAME=PToC_267 HREF="#Header_267" >Comments</A>
</MENU>
<LI><A NAME=PToC_268 HREF="#Header_268" >ComQuery</A>
<MENU>
<LI><A NAME=PToC_269 HREF="#Header_269" >C Format</A>
</MENU>
<LI><A NAME=PToC_270 HREF="#Header_270" >ComQueryData</A>
<MENU>
<LI><A NAME=PToC_271 HREF="#Header_271" >C Format</A>
<LI><A NAME=PToC_272 HREF="#Header_272" >Comments</A>
</MENU>
<LI><A NAME=PToC_273 HREF="#Header_273" >ComRead</A>
<MENU>
<LI><A NAME=PToC_274 HREF="#Header_274" >C Format</A>
<LI><A NAME=PToC_275 HREF="#Header_275" >Comments</A>
</MENU>
<LI><A NAME=PToC_276 HREF="#Header_276" >ComSetMdmCtl</A>
<MENU>
<LI><A NAME=PToC_277 HREF="#Header_277" >C Format</A>
<LI><A NAME=PToC_278 HREF="#Header_278" >Comments</A>
</MENU>
<LI><A NAME=PToC_279 HREF="#HDRCSETP" >ComSetParms</A>
<MENU>
<LI><A NAME=PToC_280 HREF="#Header_280" >C Format</A>
<LI><A NAME=PToC_281 HREF="#Header_281" >Comments</A>
</MENU>
<LI><A NAME=PToC_282 HREF="#Header_282" >ComWrite</A>
<MENU>
<LI><A NAME=PToC_283 HREF="#Header_283" >C Format</A>
<LI><A NAME=PToC_284 HREF="#Header_284" >Comments</A>
</MENU></MENU>
<LI><A NAME=PToC_285 HREF="#HDRTMRSPT" >Reference - Timer functions</A>
<MENU>
<LI><A NAME=PToC_286 HREF="#Header_286" >TimerSetAlarm</A>
<MENU>
<LI><A NAME=PToC_287 HREF="#Header_287" >C Format</A>
<LI><A NAME=PToC_288 HREF="#Header_288" >Comments</A>
<LI><A NAME=PToC_289 HREF="#Header_289" >Example</A>
</MENU>
<LI><A NAME=PToC_290 HREF="#Header_290" >TimerClearAlarm</A>
<MENU>
<LI><A NAME=PToC_291 HREF="#Header_291" >C Format</A>
</MENU>
<LI><A NAME=PToC_292 HREF="#Header_292" >TimerSetInterval</A>
<MENU>
<LI><A NAME=PToC_293 HREF="#Header_293" >C Format</A>
<LI><A NAME=PToC_294 HREF="#Header_294" >Comments</A>
<LI><A NAME=PToC_295 HREF="#Header_295" >Example</A>
</MENU>
<LI><A NAME=PToC_296 HREF="#Header_296" >TimerClearInterval</A>
<MENU>
<LI><A NAME=PToC_297 HREF="#Header_297" >C Format</A>
</MENU></MENU></MENU>
<P><B><LI><A NAME=PToC_298 HREF="#HDRAPICFR" >Application-level CFR APIs</A></B>
<MENU>
<LI><A NAME=PToC_299 HREF="#Header_299" >Summary of Application-level CFR APIs</A>
<LI><A NAME=PToC_300 HREF="#Header_300" >Summary of Return Codes</A>
<LI><A NAME=PToC_301 HREF="#Header_301" >Application-level CFR API Reference</A>
<MENU>
<LI><A NAME=PToC_302 HREF="#HDRATID" >AliasTransID</A>
<MENU>
<LI><A NAME=PToC_303 HREF="#Header_303" >C Format</A>
<LI><A NAME=PToC_304 HREF="#Header_304" >Description</A>
<LI><A NAME=PToC_305 HREF="#Header_305" >Parameters</A>
<LI><A NAME=PToC_306 HREF="#Header_306" >Return Codes</A>
<LI><A NAME=PToC_307 HREF="#Header_307" >Example</A>
</MENU>
<LI><A NAME=PToC_308 HREF="#HDRCKD" >CallKeyDef</A>
<MENU>
<LI><A NAME=PToC_309 HREF="#Header_309" >C Format</A>
<LI><A NAME=PToC_310 HREF="#Header_310" >Description</A>
<LI><A NAME=PToC_311 HREF="#Header_311" >Parameters</A>
<LI><A NAME=PToC_312 HREF="#Header_312" >Return Codes</A>
<LI><A NAME=PToC_313 HREF="#Header_313" >Example</A>
</MENU>
<LI><A NAME=PToC_314 HREF="#Header_314" >ClearUserVariable</A>
<MENU>
<LI><A NAME=PToC_315 HREF="#Header_315" >C Format</A>
<LI><A NAME=PToC_316 HREF="#Header_316" >Description</A>
<LI><A NAME=PToC_317 HREF="#Header_317" >Parameters</A>
<LI><A NAME=PToC_318 HREF="#Header_318" >Return Codes</A>
<LI><A NAME=PToC_319 HREF="#Header_319" >Example</A>
</MENU>
<LI><A NAME=PToC_320 HREF="#Header_320" >DataFile</A>
<MENU>
<LI><A NAME=PToC_321 HREF="#Header_321" >C Format</A>
<LI><A NAME=PToC_322 HREF="#Header_322" >Description</A>
<LI><A NAME=PToC_323 HREF="#Header_323" >Parameters</A>
<LI><A NAME=PToC_324 HREF="#Header_324" >Return Codes</A>
<LI><A NAME=PToC_325 HREF="#Header_325" >Example</A>
</MENU>
<LI><A NAME=PToC_326 HREF="#Header_326" >GetPowerState</A>
<MENU>
<LI><A NAME=PToC_327 HREF="#Header_327" >C Format</A>
<LI><A NAME=PToC_328 HREF="#Header_328" >Description</A>
<LI><A NAME=PToC_329 HREF="#Header_329" >Return Codes</A>
<LI><A NAME=PToC_330 HREF="#Header_330" >Example</A>
</MENU>
<LI><A NAME=PToC_331 HREF="#Header_331" >GetTerminalAddress</A>
<MENU>
<LI><A NAME=PToC_332 HREF="#Header_332" >C Format</A>
<LI><A NAME=PToC_333 HREF="#Header_333" >Description</A>
<LI><A NAME=PToC_334 HREF="#Header_334" >Return Codes</A>
<LI><A NAME=PToC_335 HREF="#Header_335" >Example</A>
</MENU>
<LI><A NAME=PToC_336 HREF="#Header_336" >GetTerminalSettings</A>
<MENU>
<LI><A NAME=PToC_337 HREF="#Header_337" >C Format</A>
<LI><A NAME=PToC_338 HREF="#Header_338" >Description</A>
<LI><A NAME=PToC_339 HREF="#Header_339" >Return Codes</A>
<LI><A NAME=PToC_340 HREF="#Header_340" >Example</A>
</MENU>
<LI><A NAME=PToC_341 HREF="#Header_341" >IdleManager</A>
<MENU>
<LI><A NAME=PToC_342 HREF="#Header_342" >C Format</A>
<LI><A NAME=PToC_343 HREF="#Header_343" >Description</A>
<LI><A NAME=PToC_344 HREF="#Header_344" >Return Codes</A>
<LI><A NAME=PToC_345 HREF="#Header_345" >Example</A>
</MENU>
<LI><A NAME=PToC_346 HREF="#Header_346" >MaxMemory</A>
<MENU>
<LI><A NAME=PToC_347 HREF="#Header_347" >C Format</A>
<LI><A NAME=PToC_348 HREF="#Header_348" >Description</A>
<LI><A NAME=PToC_349 HREF="#Header_349" >Parameter</A>
<LI><A NAME=PToC_350 HREF="#Header_350" >Return Codes</A>
<LI><A NAME=PToC_351 HREF="#Header_351" >Example</A>
</MENU>
<LI><A NAME=PToC_352 HREF="#Header_352" >PntrFile0</A>
<MENU>
<LI><A NAME=PToC_353 HREF="#Header_353" >C Format</A>
<LI><A NAME=PToC_354 HREF="#Header_354" >Description</A>
<LI><A NAME=PToC_355 HREF="#Header_355" >Return Value</A>
<LI><A NAME=PToC_356 HREF="#Header_356" >Example</A>
</MENU>
<LI><A NAME=PToC_357 HREF="#Header_357" >QueryTransactionCnt</A>
<MENU>
<LI><A NAME=PToC_358 HREF="#Header_358" >C Format</A>
<LI><A NAME=PToC_359 HREF="#Header_359" >Description</A>
<LI><A NAME=PToC_360 HREF="#Header_360" >Parameters</A>
<LI><A NAME=PToC_361 HREF="#Header_361" >Return Codes</A>
<LI><A NAME=PToC_362 HREF="#Header_362" >Example</A>
</MENU>
<LI><A NAME=PToC_363 HREF="#Header_363" >ReadUserVariable</A>
<MENU>
<LI><A NAME=PToC_364 HREF="#Header_364" >C Format</A>
<LI><A NAME=PToC_365 HREF="#Header_365" >Description</A>
<LI><A NAME=PToC_366 HREF="#Header_366" >Parameters</A>
<LI><A NAME=PToC_367 HREF="#Header_367" >Return Codes</A>
<LI><A NAME=PToC_368 HREF="#Header_368" >Example</A>
</MENU>
<LI><A NAME=PToC_369 HREF="#Header_369" >ResizeFile</A>
<MENU>
<LI><A NAME=PToC_370 HREF="#Header_370" >Command</A>
</MENU>
<LI><A NAME=PToC_371 HREF="#Header_371" >SendTransaction</A>
<MENU>
<LI><A NAME=PToC_372 HREF="#Header_372" >C Format</A>
<LI><A NAME=PToC_373 HREF="#Header_373" >Description</A>
<LI><A NAME=PToC_374 HREF="#Header_374" >Parameters</A>
<LI><A NAME=PToC_375 HREF="#Header_375" >Return Codes</A>
<LI><A NAME=PToC_376 HREF="#Header_376" >Example</A>
</MENU>
<LI><A NAME=PToC_377 HREF="#Header_377" >TransactionMsg</A>
<MENU>
<LI><A NAME=PToC_378 HREF="#Header_378" >C Format</A>
<LI><A NAME=PToC_379 HREF="#Header_379" >Description</A>
<LI><A NAME=PToC_380 HREF="#Header_380" >Parameter</A>
<LI><A NAME=PToC_381 HREF="#Header_381" >Return Codes</A>
<LI><A NAME=PToC_382 HREF="#Header_382" >Example</A>
</MENU>
<LI><A NAME=PToC_383 HREF="#Header_383" >Validation</A>
<MENU>
<LI><A NAME=PToC_384 HREF="#Header_384" >C Format</A>
<LI><A NAME=PToC_385 HREF="#Header_385" >Description</A>
<LI><A NAME=PToC_386 HREF="#Header_386" >Parameters</A>
<LI><A NAME=PToC_387 HREF="#Header_387" >Return Codes</A>
<LI><A NAME=PToC_388 HREF="#Header_388" >Example</A>
</MENU>
<LI><A NAME=PToC_389 HREF="#HDRWTEVNT" >WaitEvent</A>
<MENU>
<LI><A NAME=PToC_390 HREF="#Header_390" >C Format</A>
<LI><A NAME=PToC_391 HREF="#Header_391" >Description</A>
<LI><A NAME=PToC_392 HREF="#Header_392" >Return Codes</A>
<LI><A NAME=PToC_393 HREF="#Header_393" >Return Codes</A>
<LI><A NAME=PToC_394 HREF="#Header_394" >Example</A>
</MENU>
<LI><A NAME=PToC_395 HREF="#Header_395" >WriteToTrans</A>
<MENU>
<LI><A NAME=PToC_396 HREF="#Header_396" >C Format</A>
<LI><A NAME=PToC_397 HREF="#Header_397" >Description</A>
<LI><A NAME=PToC_398 HREF="#Header_398" >Parameter</A>
<LI><A NAME=PToC_399 HREF="#Header_399" >Return Codes</A>
<LI><A NAME=PToC_400 HREF="#Header_400" >Example</A>
</MENU>
<LI><A NAME=PToC_401 HREF="#Header_401" >WriteUserVariable</A>
<MENU>
<LI><A NAME=PToC_402 HREF="#Header_402" >C Format</A>
<LI><A NAME=PToC_403 HREF="#Header_403" >Description</A>
<LI><A NAME=PToC_404 HREF="#Header_404" >Parameters</A>
<LI><A NAME=PToC_405 HREF="#Header_405" >Return Codes</A>
<LI><A NAME=PToC_406 HREF="#Header_406" >Example</A>
</MENU></MENU></MENU>
<P><B><LI><A NAME=PToC_407 HREF="#HDRKEYALLW" >Command and Special Key Relationships</A></B>
<P><B><LI><A NAME=PToC_408 HREF="#HDRCRLC" >Comparison of ETS, 7526, 7527 Command Capabilities</A></B>
<P><B><LI><A NAME=PToC_409 HREF="#HDRGLO" >Terms and Abbreviations</A></B>
</MENU><HR><P>
<HR>
<H1><A NAME="HDRCH1" HREF="#PToC_131">Introduction to C Programming on terminals running 7524 ETS or the DCConnect Client</A></H1>
<HR>
<H2><A NAME="Header_132" HREF="#PToC_132">General Requirements</A></H2>
The information in this chapter is pertinent for writing Custom
Function Routines (CFRs) which
enhance the function of <I>Extended Terminal Services</I>.
<P>
In most respects, a C language program for ETS is like a program
written for a personal computer.
The specific interfaces, devices, available storage, and
performance requirements are different from a PC, but the concepts and
common programming strategies for applications remain the same. When
programming specifically for the 7524 terminal, standard C functions that
access devices and storage that might be found on a PC are not valid because
these do not exist on a 7524 terminal. But if using the DCConnect Client on
a DOS platform or Windows platform, you actually do have access to the
resources available on the platform, although most of the time you would not
access these directly.
<P>
A set of C APIs is available when writing C programs for ETS. These are what
you would use most of the time to get access to resource such as the keyboard,
scanner, RS-232 port, etc. regardless of what terminal is being used.
<P>
Other differences between PC programs and ETS application programs exist
because of the unique elements of the ETS programming environment, including:
<UL>
<P><LI>Battery backed-up RAM
<P><LI>Support for special devices, including bar code readers.
<P><LI>Multiple video display types with greatly differing capabilities
<P><LI>Absence of disk drives, math-coprocessor, and so forth
<P><LI>Substitute interfaces for other I/O such as the keyboard, display,
and printer.
</UL>
Programs for the ETS are developed on your personal computer, using
a few specific compile and link options, and certain special files for
linking which take care of the differences between the startup of a
EXE file on a personal computer and a ETS.
<P>
The tools supported/required for building C programs for use with ETS vary
depending on the type of terminal being used:
<UL>
<P><LI>7524 terminal
<P><LI>Terminal running the DOS version of DCConnect Client
<P><LI>Terminal running the 32-bit Windows version of DCConnect Client
<P><LI>Terminal running the Windows CE version of DCConnect Client
</UL>
<P>For the 7524 terminal, the following programs are
required on the development personal computer:
<UL>
<P><LI>The CFR header file (CFRAPI24.H) and library file (CFRAPI24.LIB).
These are available in the latest fix pack for 7524 ETS flash which is
available from our website:
<PRE>
http://www.ibm.com/software/data/dcconnect
</PRE>
<P>
Follow the link to "Product Downloads" and then "7524 ETS Flash Loads and CFR
Samples, Programming Tools".
<P><LI>IBM C/2 Compiler Version 1.1 or above
<P><LI>IBM DOS 3.3 or above, or any operating system in which the IBM C/2
Compiler can run (e.g. DOS window of both OS/2 and Windows/NT).
</UL>
<P>
For terminals running the DCConnect Client, whether DOS or Windows based,
there are more options for compilers (IBM, Borland, Microsoft) and different
header files and library files for each. To get the latest information
concerning which compilers to use and how to set them up, please see the
DCConnect User's Guide. To get the latest header files and libraries as well
as sample code, please see our website:
<PRE>
http://www.ibm.com/software/data/dcconnect
</PRE>
<P>
Follow the link to "Product Downloads" and then "DCConnect Client".
<P>
The following special procedures or requirements must be followed for
7524 terminals:
<UL>
<P><LI>DOS-specific function calls may not be used (for example,
DOS versions
of calls which use input or output specific to the IBM Personal Computer
or Personal System/2, including keyboard, screen, printer, and disk
input and output.
C/2 functions such as "printf" and "sprintf" should
not be used because they bring in DOS-specific functions).
<P><LI>Link with the special CRT0 "C" runtime modules (included in
CFRAPI24.LIB), which
allow programs
developed on a personal computer to be run on a 7524 terminal.
<P><B>Note: </B>These programs then <B>will not</B> run on a personal computer.
</UL>
<HR>
<H2><A NAME="Header_133" HREF="#PToC_133">Non-Volatile Storage</A></H2>
Another difference between how a personal computer and the 7524 load and
run the executable program is that the 7524 has no disk drives. The program,
once loaded, remains in battery-backed pseudo-static RAM. This includes all of
your program's data variables. All of the <B>global variables</B> in
your program will retain their values through power-on/off cycles.
This allows you to have large amounts of data retained on the 7524 through
power failures or over a holiday.
<P>
Terminals running the DCConnect Client have varying kinds of power management.
Many support a suspend mode which leave the DCConnect Client running with all
of its memory battery backed up. When the terminal resumes, the Client
picks up right where it was at the time the terminal was suspended.
<P>
However, some terminals that are supported by the DCConnect Client do not have
any kind of suspend mode. If these are turned off, the Client is immediately
aborted and any data in memory is lost. Transactions are written to disk - in
non-volatile storage if it is available. So these should survive the power
off/on but only if the disk storage is non-volatile.
<HR>
<H2><A NAME="Header_134" HREF="#PToC_134">Memory Models</A></H2>
Programs for the 7524 which are written as Custom Function Routines
must be compiled with a customized large memory model
(See<A HREF="#HDRCFR">Writing Custom Function Routines</A>) .
<P>
For those applications which are written in C/2, a 7524 specific,
custom CRT0 module is provided.
This is the C run-time initialization
module which sets up the environment to be consistent with the
compiler's code generation assumptions.
Under PC-DOS, it provides the
standard file streams, access to command line parameters, access to
environment variables, and sets up the various segments and registers
according to the selected memory model.
Most of these services are not available on the 7524,
therefore the custom CRT0 module must be
substituted for the standard one normally in the C library.
The main function of the custom CRT0 module is to establish the
segment and register conventions based on the selected memory model.
You must be sure to link-in the version of the custom CRT0 module which
matches the memory model of the application.
For CFRs, the CRT0 routine is imbedded in the
CFRAPI24.LIB library, and is not explicitly linked.
<HR>
<H2><A NAME="Header_135" HREF="#PToC_135">Function Prototypes</A></H2>
All CFR
API's use a PC-DOS style interface. That is, parameters are
placed in processor registers and the appropriate software interrupt
is invoked. Thus, it is possible to use the API's from any language that
can both write to and read from the processor registers, either directly
or indirectly.
To facilitate use of the API's from high level languages,
an API library is supplied which supports the C language calling
convention.
<P>
Because the current language compilers support mixed memory models,
the CFR API library uses a large model interface. For applications
written in C/2, it is essential to include the subsystem header files
for the API's used in the program.
These header files contain function
prototypes for each API in the subsystem.
These prototypes will cause
the compiler to generate the correct calling sequence regardless of the
memory model used by the application.
The header files also contain
definitions of manifest constants and structures used with the API's.
The defined constants should be used exclusively to avoid conflicts
with possible future changes to an API.
The CFRAPI24.H file contains API subsystem function and structure declarations as
well as parameter definitions.
<HR>
<H2><A NAME="Header_136" HREF="#PToC_136">C Library Function Usage</A></H2>
<P>The 7524 / DCCOnnect Client program environment is different from PC-DOS,
and thus not all the
IBM C/2 library functions can be supported on the 7524. In general,
all functions that are hardware- or operating system-dependent cannot be
used by the 7524 application programs. The following is a list of
categories of such C library functions.
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>Directory Control
</B></TD><TD><P>Examples are (chdir, mkdir, rmdir). The 7524 does not support a
file system.
</TD></TR><TR VALIGN=TOP><TD><P><B>File Handling
</B></TD><TD><P>Examples are (remove, rename). The 7524 does not support a file
system.
</TD></TR><TR VALIGN=TOP><TD><P><B>Standard I/O
</B></TD><TD><P>Examples are (getc, putc, gets, puts). The 7524 does not support
DOS INT 21 functions. The API keyboard and video function calls
support these features on the 7524.
</TD></TR><TR VALIGN=TOP><TD><P><B>Math (floating point)
</B></TD><TD><P>Examples are (_clear87, _control87). The 7524 does not
support a math co-processor. The alternate math library is supported.
</TD></TR><TR VALIGN=TOP><TD><P><B>Allocation Storage
</B></TD><TD><P>Examples are (alloc, free, halloc). These calls are operating
system dependent. The 7524 does not support these calls.
</TD></TR><TR VALIGN=TOP><TD><P><B>Process Control
</B></TD><TD><P>Examples are (abort, exit, signal). The 7524 does not directly
support multi-processing.
</TD></TR><TR VALIGN=TOP><TD><P><B>Time
</B></TD><TD><P>Examples are (asctime, ctime, time). The API Real Time Clock
function calls support these features in the 7524.
</TD></TR><TR VALIGN=TOP><TD><P><B>Printf
</B></TD><TD><P>The printf, sprintf, scanf, etc. family of library routines should not
be used because they pull in much program material which is specific to
personal computers.
</TD></TR></TABLE>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The DCConnect Client, which runs on DOS and Windows platforms, could probably
use some of the restricted functions mentioned above, but only in rare
circumstances such as writing a file to disk. However,
when possible, the CFR APIs should be used to get access to resources such
as the keyboard, display, clock, RS-232 port, ... The APIs interact with
ETS which will itself be accessing the keyboard, display, clock, RS-232 port, ...
In order to properly cooridinate the use of these resource, the CFR APIs should
be used.
<P>
Also be aware that any function called runs on the stack of the CFR. So
calling a function such as sprintf() which uses a bit of stack space, be sure
the CFR stack has been made sufficiently large enough.
</td></tr></table>
<HR>
<H2><A NAME="Header_137" HREF="#PToC_137">Program Development</A></H2>
Because of the differences between the 7524 and other terminals and a standard
IBM personal computer, you cannot use all of the code development tools
which you may be accustomed to (for example,
CodeView, debug, and so forth).
However, the 7524 terminal and other terminals do have their own display,
keyboard, and RS-232, so the traditional basic debugging facility -
displaying key variables at strategic points -
is easily available.
<HR>
<H1><A NAME="HDRCFR" HREF="#PToC_138">Writing Custom Function Routines</A></H1>
<P>
Custom Function routines (CFRs) can be used to enhance the
functionality of <I>Extended Terminal Services</I>.
In most cases, if ETS
does not include some flexibility your application requires, it is easier
to add-on to ETS with a CFR rather than write a complete terminal
application program from the ground up.
Simply adding on to ETS with a CFR lets you maintain
use of the extensive efforts which have been invested in making
it a robust, general, and error-resistant product, as well as maintaining
compatibility with the Data Collection Connection program product.
<P>
The CFR is created as a single executable (.EXE) program (or in the
case of Windows platforms running the DCConnect Client it is a .DLL). If the
CFR must handle special work for many different, unrelated functions, then
these functions must be merged into a single executable file. This leads
most naturally to a program structure in which the first step is to do a
flow-of-control "switch" based on the function (and then
perhaps a sub-function switch) desired in the particular invocation of the
CFR.
You cannot
load more than one CFR to a terminal at one time. Of course, your executable
program may be made up of many source modules compiled or assembled into
object files, and then linked together.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The total size of a downloaded CFR (including code segments,
32 byte header, and stack space) cannot be larger than 64 Kb.
</td></tr></table>
<P>
Sample CFRs for 7524 ETS as well as the DCConnect Client are available from
our website:
<PRE>
http://www.ibm.com/software/data/dcconnect
</PRE>
<P>
Follow the link to "Product Downloads" and then "7524 ETS Flash Loads and CFR
Samples, Programming Tools" or "DCConnect Client".
<HR>
<H2><A NAME="HDRTOOLS" HREF="#PToC_139">CFR Programming Tools</A></H2>
The programming tools required for compiling and linking Custom
Function Routines for ETS on all platforms are available from our website,
mentioned in the previous sections.
<HR>
<H2><A NAME="Header_140" HREF="#PToC_140">CFR Operating Modes</A></H2>
CFRs may operate in one of two modes:
<UL>
<P><LI>Mode 1 CFRs are treated as user extensions to the Extended Terminal
Services transaction programming command set. The CFR
is called automatically
upon completion of its loading, does any initialization work required, and
returns control to the main ETS program. From then on, the CFR is
called only when a Call CFR command is encountered in your transaction program.
Once your CFR has completed its work, it returns control to the main ETS
program.
The CFR can return to the transaction program either a SKIP (skip the next
statement), NO_SKIP (do not skip the next statement), or ABORT (same as
Cancel).
<P><LI>Mode 2 CFRs operate as the main line program for the terminal, and
use the ETS program as a set of utilities and support functions.
Your CFR operates in mode 2 if it <I>does not</I> do a return to
ETS during the CFR initialization call. The mode 2 CFR provides the
front-end processing for the terminal application (doing at least the same type
of work that the idle mode usually does in ETS). The mode 2 CFR
can call transaction programs written with the ETS command set.
When the transaction program ends normally, control returns
to the mode 2 CFR rather than to the idle mode.
If the transaction is aborted, control returns to the mode 2 CFR with
a return code set to signify an error or Cancel key activation.
</UL>
<HR>
<H2><A NAME="Header_141" HREF="#PToC_141">Examples of CFR Usage</A></H2>
If your application requires functions similar to the examples given
below, then adding a CFR may be called for.
<P>You should consider keeping the CFRs as general as possible, and do
as much of your programming as possible within the
commands of the transaction program.
This allows changes or enhancements to the operation of the terminal
to be done via the parameter-driven programming of Data Collection
Connection (or other terminal server software) as possible,
requiring less skill and time to complete.
<P>
<H3><A NAME="Header_142" HREF="#PToC_142">Mode 1 CFRs</A></H3>
Example mode 1 CFRs could include the following (most of these functions
are included in our sample CFR):
<UL>
<P><LI>String compares -
specify in the parameter string 2 user variables,
X and Y, and an operator code for "greater than", "less than", etc.
(e.g. GT, LT, GE, LE, EQ), and the CFR could compare the 2 strings with
<B>strcmp</B> and return
SKIP if the operator is true and NO_SKIP if false
<P><LI>Getting time and date stamps into user variables
<P><LI>Device driver to print bar codes on dot matrix printers
<P><LI>Loop counters
<P><LI>Mathematics -
subtracting tare weights, doing pricing calculations
<P><LI>Bar code identifier reading/sorting for AIAG and FACT labels
<P><LI>Create local data bases and customized searching; using large
non-volatile RAM files
<P><LI>Full screen message storage and presentation (scrolling, etc.)
<P><LI>Type and range checking for bar code or keyboard inputs (check for valid
integer or real, position of sign, value, etc.)
<P><LI>Do on-terminal validation for MAPICS or COPICS -
numeric field,
number of decimal places, valid choices, pre-filling of choices,
checking turnaround numbers, check badge checksums
<P><LI>Clear and restore layers of pop-up
windows
<P><LI>Load a machine tool with CNC files.
</UL>
<P>
<H3><A NAME="Header_143" HREF="#PToC_143">Mode 2 CFRs</A></H3>
Examples of mode 2 CFRs include:
<UL>
<P><LI>A user front end which can take a transaction initiated by one event
but send the transaction back from a different event
<P><LI>Any other application which requires automatic control over the
terminal at any power-on or restart time.
</UL>
<HR>
<H2><A NAME="Header_144" HREF="#PToC_144">Operating with a Mode 1 CFR</A></H2>
<P>
<H3><A NAME="Header_145" HREF="#PToC_145">Calling the CFR</A></H3>
Your CFR is called automatically by ETS whenever the
terminal is put into service and on each power-on of a 7524 terminal -
provided the terminal was already downloaded before it was powered off.
The automatic call can be used to do initialization work for the CFR.
The CFR may then be called from any place within a transaction program by
using the <B>;M</B> (Call CFR) operation code of ETS.
Refer to <A HREF="#SPTCALLCFR">reference #4</A> for details of the <B>;M</B> command.
For users of <I>Data Collection Connection</I>,
the transaction programming command <B>CCFR</B> (Call CFR) is utilized
to create the <B>;M</B> command and its arguments.
<P>
A mode 1 CFR is called with 2 arguments supplied by the caller to the CFR
code (these arguments are passed much like command line arguments in a
personal computer program). The first argument is a single-digit integer
<B>function number</B>, with value between 0 and 9.
The second argument is a
variable length <B>parameters</B>
string of up to 101 characters.
<P>
The <B>function number</B> has 2 reserved values:
<UL>
<P><LI>Function set to 0 indicates that this is the initialization call, and
is made right after loading of the CFR. When this function number is
received, the CFR code should switch to an area of code which takes care
of any initialization work (e.g. chaining to the timer interrupt vector,
setting counters to zero,
reading in "validation" files to extract data, etc.).
<P><LI>Function set to 2 indicates that the terminal has been restarted, usually
by being powered off and on again. Certain initialization work may need to
be re-done at this time (for example,
initializing some data structures may need to be done on each restart).
</UL>
<P>
The <B>parameter string</B> may be used to transfer
up to 99 characters of string data to the CFR.
The meaning of the data is dependent on the code in the CFR.
Uses for this string may include encoding of sub-function
numbers, passing of input and output user variable numbers, and
passing of program flags.
The first 2 characters represent a number from 00 to 99,
which should be set to the number of characters remaining in the string
(the DCConnect transaction program editor automatically counts the number
of characters in the parameter string for the CCFR command and prefixes the
string with this number).
If there are no additional parameters, then the first 2
characters of the string must be set to "00".
The CFR code which processes the parameter string should look at the
first 2 characters to obtain the string length (offsets 0 and 1), and
characters 3 and on for the rest of the data (offset 2 and on).
<P>
<H3><A NAME="Header_146" HREF="#PToC_146">CFR APIs to ETS</A></H3>
Once the mode 1 CFR has been called from a transaction program,
the CFR has access to a set of ETS application program interfaces
which provide services to the CFR.
The following are some of the "API" calls are available to the CFR writer
in mode 1:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>DataFile
</B></TD><TD><P>Returns a pointer to a named validation file,
and returns the file size.
</TD></TR><TR VALIGN=TOP><TD><P><B>IdleManager
</B></TD><TD><P>Provided for compatibility with CFRs originally developed
for 7526 and 7527 DCTs.
</TD></TR><TR VALIGN=TOP><TD><P><B>MaxMemory
</B></TD><TD><P>Returns the maximum memory available in the terminal.
</TD></TR><TR VALIGN=TOP><TD><P><B>PntrFile0
</B></TD><TD><P>Returns a pointer to ETS file 0.
</TD></TR><TR VALIGN=TOP><TD><P><B>ReadUserVariable
</B></TD><TD><P>Returns a pointer to the contents of a user variable.
</TD></TR><TR VALIGN=TOP><TD><P><B>TransactionMsg
</B></TD><TD><P>Turns the "Good Transaction" message on/off.
</TD></TR><TR VALIGN=TOP><TD><P><B>Validation
</B></TD><TD><P>Validation with local or remote files.
</TD></TR><TR VALIGN=TOP><TD><P><B>WaitEvent
</B></TD><TD><P>Places the terminal's processors in a low-power state while waiting
for input from the operator or for commands from the host.
Allows obtaining maximum operating time with battery-powered hand held
terminals.
</TD></TR><TR VALIGN=TOP><TD><P><B>WriteToTrans
</B></TD><TD><P>Appends data to a transaction.
</TD></TR><TR VALIGN=TOP><TD><P><B>WriteUserVariable
</B></TD><TD><P>Appends data to a user variable.
</TD></TR></TABLE>
<P>For detail on these API calls,
(See<A HREF="#HDRAPICFR">Application-level CFR APIs</A>) .
<P>
<H3><A NAME="Header_147" HREF="#PToC_147">CFR Functions</A></H3>
For a description of other APIs available in both mode 1 and mode 2 CFRs,
(See<A HREF="#HDRC9">Device-level CFR Functions</A>) .
These APIs provide low-level access to terminal functions.
<P>
<H3><A NAME="Header_148" HREF="#PToC_148">Creating and Sending Transactions</A></H3>
<P>
The transaction record is initialized at the
beginning of execution of a transaction
program, and the transaction record is transmitted at the
end of the transaction program.
CFRs operating in Mode 1 can add directly to the current transaction by
using the CFR API call "WriteToTrans", or it may pass its results
back in an appropriate user variable, from which the transaction program
may copy it to the transaction record.
<P>
The transaction can be sent to the host by the transaction program after
the CFR returns, or it can be sent directly by the CFR using the CFR API
"SendTransaction".
<P>
The transaction buffer can be cleared from the CFR using the API call
"ClearUserVariable" with the parameter TRANS_BUFFER.
<P>
<H3><A NAME="Header_149" HREF="#PToC_149">Example Mode 1 CFR</A></H3>
<P>
This example of a Mode 1 CFR does the following:
<OL>
<P><LI>There are three function entry points: Function
"0" to initialize, function "2" to notify the
CFR of a power-fail restart, and function "3"
to validate the data in user variable 1.
If any other function number is used an error
message is displayed using the CFR API "VioWrtCharStr",
which also shows the bad function number.
There is no initialization required by this sample CFR,
so a dummy function call is shown for completeness.
<P><LI>The function "ValidateInput" is part of the CFR
and is used to perform this CFR's validation
function. The parameter for this function is a
pointer to the parameters that were supplied by
the CFR call.
<P><LI>"ValidateInput" uses the CFR API function
"PntrFile0" to get a pointer to ETS file "0".
From file "0", the CFR gets the parameters which specify the number of
beeps to be used to indicate "good" and "bad".
Next the operator is prompted with "Validate data? (Y/N)"
using the microcode API call
"VioWrtCharStr", and the keyboard is tested for
input with the microcode API call "KbdReadAscii".
While waiting for operator input, the CFR API
call "WaitEvent" is used to conserve power by putting the
processors to sleep until a key is pressed or other input event
occurs.
<P>
When a "Y" is hit on the keyboard, the CFR API
call "ReadUserVariable" is then used to get
user variable 1 for validation, and the CFR API
call "Validation" is used to perform the validation.
The validation file and the type of validation are supplied
in the parameter list.
If validation passes, the data is written
to the current transaction using the CFR API
call "WriteToTrans" and the "good" beeps are
sounded using the microcode API call "SpkBeep".
If validation fails, the data is written to user variable 15
(for later use by some other function) using the CFR API call
"WriteUserVariable" and the "bad" beeps are sounded.
The results of the validation are returned by
returning whether to skip (SKIP) or not (NO_SKIP) to the calling
transaction program process.
<P>
When an "N" is hit on the keyboard the "NO_SKIP" return code
is returned to the calling transaction program process.
</OL>
The example code is shown in <A HREF="#FIGSAMCFR1">Figure 2</A>.
<P><B><A NAME="FIGSAMCFR1">Figure 2. A sample CFR Mode 1 program</A></B><BR>
<TABLE BORDER WIDTH=100%><TR><TD><BR>
<PRE>
//**************************
// Sample CFR Mode 1 Program
//**************************
#include "cfrapi24.h" // ETS CFR defines and function prototypes
#include <string.h>
#include <stdlib.h>
// Function prototypes
int main(int, char far *);
int ValidateInput(char far *);
//****************************************************************************
int far cdecl main(int Function, char * parameters)
// Function - Function number being called
// parameters - String of parameters if required for function
{
int skipflag;
unsigned short count;
switch (Function) {
case 0:
// Function 0 is called when terminal goes into service
InitializeCFR();
return;
case 2:
// Function 2 is called to notify CFR of a power-fail restart of
// the terminal. The CFR should reestablish any volatile BIOS or
// terminal settings at this time.
return;
case 3:
// Function to validate data in user variable 1
skipflag = ValidateInput(parameters);
// Return to ETS whether or not to skip next command
return(skipflag);
</PRE><BR>
<PRE>
default:
// API to display a string on screen
VioWrtCharStr("Error invalid function number",29,1,1,&count,CURSOR_MOVE);
// Tell ETS there was an error and to abort transaction
return(ABORT);
}
} // main
//****************************************************************************
InitializeCFR()
{
// Any initialization needed would be performed here
} // InitializeCFR
//****************************************************************************
int ValidateInput(char far * ValidationParameters)
{
int i;
int skip; // Skip flag to return
int ParmListLength;
int NumberBadBeeps;
int NumberGoodBeeps;
char ValidationType;
char Input[128]; // Buffer for input to validate
char * File0; // Pointer for pointer to file 0
char * ValFilename;
char * ParmListLengthStr;
unsigned short count;
unsigned short key;
// ETS API function to get pointer to file 0 record 0
File0 = PntrFile0();
// Index into file 0 record 0 to get Number of Good Beeps Parameter
NumberGoodBeeps = File0[8] - '0'; // Convert ASCII character to integer
// Index into file 0 record 0 to get Number of Bad Beeps Parameter
NumberBadBeeps = File0[10] - '0'; // Convert ASCII character to integer
// API to display string on the screen
VioWrtCharStr("Validate data? Y/N ",20,1,1,&count,CURSOR_MOVE);
</PRE><BR>
<PRE>
for(;;) {
// API call to wait for a key to be hit
while(KbdReadAscii(&key) == E_NO_DATA) {
// API to put terminal to sleep until an input event
// occurs. Must check if it was a keystroke because
// an input event could also be a command coming in
// from the host or a bar code scan.
WaitEvent(0L);
}
if (key == 'Y' »» key == 'N')
break;
}
if (key == 'Y') { // If validation desired
// ETS API to read data to be validated from User variable 1
ReadUserVariable(1,Input);
// Parse parameter list length from ValidationParameters
strncpy(ParmListLengthStr, ValidationParameters, 2);
ParmListLengthStr[2] = '\0';
// Convert parameter list length string to an integer
ParmListLength = atoi(ParmListLengthStr);
// Parse validation filename from ValidationParameters
strncpy(ValFilename, ValidationParameters+2, ParmListLength-1);
ValFilename[ParmListLength-1] = '\0';
// Parse validation type from ValidationParameters
ValidationType = ValidationParameters[ParmListLength+1];
// ETS API to validate
skip = Validation(ValFilename,ValidationType,Input);
if (!skip) { // If validation passed
// ETS API to write input to transaction buffer and put a
// message to the screen
WriteToTrans(Input);
VioWrtCharStr(" ",40,0,0,&count,0);
VioWrtCharStr("Validation passed",17,0,5,&count,0);
// Perform Good beeps
for (i=0 ; i < NumberGoodBeeps ; ++i) {
SpkBeep(FREQ_700, DEFAULT_VOLUME,2);
}
</PRE><BR>
<PRE>
}
else { // If validation failed
// ETS API to write data to user variable 15 for later use
// and put a message to the screen
WriteUserVariable(15,Input);
VioWrtCharStr(" ",40,0,0,&count,0);
VioWrtCharStr("Validation failed",17,0,5,&count,0);
// Perform Bad beeps
for (i=0 ; i < NumberBadBeeps ; ++i) {
SpkBeep(FREQ_700, DEFAULT_VOLUME,2);
}
}
// Return skip flag to tell ETS to skip next command
return(skip);
}
else {
// Return skip flag to tell ETS not to skip next command
return(NO_SKIP);
}
} // ValidateInput
//******************************
// End Sample CFR Mode 1 Program
//******************************
</PRE><BR>
</TD></TR></TABLE>
<HR>
<H2><A NAME="Header_150" HREF="#PToC_150">Operating with a Mode 2 CFR</A></H2>
<P>
<H3><A NAME="Header_151" HREF="#PToC_151">Calling the CFR</A></H3>
As with a mode 1 CFR, a mode 2 CFR is also
called automatically by ETS whenever the terminal is put into service and
whenever a 7524 terminals powered on.
For the mode 2 CFR, there is no return to ETS from this call.
From this point on, the CFR is in control of the terminal and it can call
functions of ETS as required.
<P>
A mode 2 CFR is called with only the single-digit integer
<B>function number</B>, being used.
The <B>function number</B> has 2 reserved values:
<UL>
<P><LI>Function set to 0 indicates that this is the initialization call, and
is made right after loading of the CFR. When this function number is
received, the CFR code should switch to an area of code which takes care
of any initialization work (e.g. chaining to the timer interrupt vector,
setting counters to zero,
reading in "validation" files to extract data, etc.), and go to the
beginning logic of the CFR.
<P><LI>Function set to 2 indicates that the terminal has been restarted,
usually by being powered off and on again.
Certain initialization work may need to be re-done at this time
(for example,
installing your
timer interrupt routine
must be re-done on each restart).
</UL>
<P>
The <B>parameter string</B> is not used with a mode 2 CFR.
<P>
When a mode 2 CFR starts up, ETS is generally out of service since the
'in service' command from the terminal server arrives
after the start of the CFR command.
Often the CFR must wait for ETS to go in service in order to proceed
(to do a CallKeyDef, for instance).
ETS can only go in service if the mode 2 CFR allows the incoming command
to be processed.
The CFR can do this by the following:
<PRE>
while(IdleManager( 250 ) == TERMINAL_OFFLINE);
</PRE>
where <B>250</B> is 250 milliseconds.
(OFFLINE is the old term used for 'out of service' that is still used in
the .H file for backwards compatability).
<P>
<H3><A NAME="Header_152" HREF="#PToC_152">CFR APIs to ETS</A></H3>
Once the mode 2 CFR has been started,
it has access to a set of CFR application program interfaces
which provide services to the CFR.
The following are some of the "API" calls are available to the
CFR writer in mode 2:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>CallKeyDef
</B></TD><TD><P>Transfers control to ETS, which then runs the desired transaction
program.
At the end of the transaction program, control returns to the CFR.
The transaction program can do a CFR call as part of its procedure.
<P>
A mode 2 CFR can execute a transaction program with the
<B>CallKeyDef</B> API.
This transaction program may call the mode 2 CFR provided the CFR takes
all the precautions necessary to avoid reentrancy problems and not
attempt to call <B>CallKeyDef</B> again.
If the CFR does attempt to call <B>CallKeyDef</B> again,
the API will return the <B>TRANS_IN_PROGRESS</B> return
code without executing the transaction program.
</TD></TR><TR VALIGN=TOP><TD><P><B>DataFile
</B></TD><TD><P>Returns a pointer to a named validation file,
and returns the file size.
</TD></TR><TR VALIGN=TOP><TD><P><B>IdleManager
</B></TD><TD><P>Provided for compatibility with CFRs originally developed
for 7526 and 7527 DCTs.
</TD></TR><TR VALIGN=TOP><TD><P><B>MaxMemory
</B></TD><TD><P>Returns the maximum memory available in the terminal.
</TD></TR><TR VALIGN=TOP><TD><P><B>PntrFile0
</B></TD><TD><P>Returns a pointer to ETS file 0.
</TD></TR><TR VALIGN=TOP><TD><P><B>ReadUserVariable
</B></TD><TD><P>Returns a pointer to the contents of a user variable.
</TD></TR><TR VALIGN=TOP><TD><P><B>ResizeFile
</B></TD><TD><P>Clears and resizes a named validation file.
</TD></TR><TR VALIGN=TOP><TD><P><B>TransactionMsg
</B></TD><TD><P>Turns the "Good Transaction" message on/off.
</TD></TR><TR VALIGN=TOP><TD><P><B>Validation
</B></TD><TD><P>Validation with local or remote files.
</TD></TR><TR VALIGN=TOP><TD><P><B>WaitEvent
</B></TD><TD><P>Places the terminal's processors in a low-power state while waiting
for input from the operator or for commands from the host.
Allows obtaining maximum operating time with battery-powered hand held
terminals.
</TD></TR><TR VALIGN=TOP><TD><P><B>WriteUserVariable
</B></TD><TD><P>Appends data to a user variable.
</TD></TR></TABLE>
<P>For detail on these API calls,
(See<A HREF="#HDRAPICFR">Application-level CFR APIs</A>) .
<P>
<H3><A NAME="Header_153" HREF="#PToC_153">CFR Functions</A></H3>
For a description of other APIs available in both mode 1 and mode 2 CFRs,
(See<A HREF="#HDRC9">Device-level CFR Functions</A>) .
These APIs provide low-level access to terminal functions.
<P>
<H3><A NAME="HDRM2SEND" HREF="#PToC_154">Creating and Sending Transactions</A></H3>
<P>
In a mode 2 CFR, the API call "WriteToTrans" can be used
to append to the transaction buffer and the API call "SendTransaction"
can be used to send the transaction to the terminal server.
<P>
The API call ClearUserVariable() can be used to clear the transaction buffer if
TRANS_BUFFER is specified as the parameter for this call.
<P>
The transaction record and all non-global user variables (1-9)
are initialized at the beginning of execution of a transaction
program, and the transaction is transmitted at the
end of the transaction program - unless automatic-transaction appending
has been turned off using the AUTO (:A) command.
<P>
<H3><A NAME="Header_155" HREF="#PToC_155">Example Mode 2 CFR</A></H3>
<P>
This example of a Mode 2 CFR does the following:
<OL>
<P><LI>There are two function entry points:
Function "0" to initialize and take control of the terminal
and function "2" to resume processing after a power-fail restart
of the terminal.
If any other function number is used, a return is made to the
calling ETS.
<P><LI>The main program under function 0 displays a prompt
(if it has not already been displayed) and waits for keyboard input.
While waiting for input it calls the CFR API "CallKeyDef" for
transaction program number 1.
Transaction program 1, in this case, is expected to be
programmed as simply a "NO-OP" so that any pending host communication
commands are processed and the watchdog is hit.
<P>
If a key is hit and it's a '1' then
transaction program 2 is executed to do
some CFR functions.
If key '2' is hit then a function called
"Unique_CFR_Function" is executed.
In this case this function merely prints out a message to show
that it has been called, then calls a time delay function
("WaitAWhile"), forces a redisplay of the
prompt by setting "prompt_displayed" to 'N', and returns.
<P><LI>If, while executing the transaction program 2,
an error occurs (such as a timeout) or the Cancel key is pressed,
a return to the CFR is made with the abort return code set.
In this case a message and a beep are output, the
time delay function is called, the redisplay of
the prompt is forced ("prompt_displayed" = 'N')
and normal processing is resumed.
<P><LI>If the power to the terminal is lost and then
restored ETS calls the CFR with the function parameter set to "2".
</OL>
The example code is shown in <A HREF="#FIGSAMCFR2">Figure 3</A>.
<P><B><A NAME="FIGSAMCFR2">Figure 3. A sample CFR Mode 2 program</A></B><BR>
<TABLE BORDER WIDTH=100%><TR><TD><BR>
<PRE>
//**************************
// Sample CFR Mode 2 Program
//**************************
#include "cfrapi24.h" // ETS CFR define (CallKeyDef)
char prompt_displayed;
// Function prototypes
int main(int, char far *);
void Unique_CFR_Func(void);
void WaitAWhile(unsigned short);
//*************************************************************************
int main (int Function, char far * parameters)
// Function - Function number being called
// parameters - String of parameters if required for function
{
unsigned short key;
unsigned short count;
prompt_displayed = 'N'; // set flag to say prompt needs to be displayed
for (;; ) {
if (Function == 0) {
// Function 0 always called when terminal is put into service. Since
// this is a mode 2 CFR, no return is made to the calling ETS program.
// If prompt message has not been displayed, display it now.
if (prompt_displayed == 'N') {
VioClear();
VioWrtCharStr("Execute option 1 or 2? ",23,1,1,&count,CURSOR_MOVE);
prompt_displayed == 'Y';
}
</PRE><BR>
<PRE>
// API call to wait for a key to be hit
while (KbdReadAscii(&key) != E_OK)
{
// ETS API call to execute transaction program defined for key 1 (F8).
// In this case, transaction program 1 has been assumed to be
// programmed with just a NO-OP.
while (CallKeyDef(8) == TERMINAL_OFFLINE) {
VioWrtCharStr("Terminal is out of service",26,1,1,&count,CURSOR_MOVE);
}
}
switch (key) {
case '1' :
// Use ETS transaction program 2 to do something
CallKeyDef(2);
// Force clear and redisplay of prompt
prompt_displayed = 'N';
break;
case '2' :
// Special code to do something
Unique_CFR_Func();
break;
default:
break;
}
}
else if (Function == 1) {
// Function 1 is the reentry point after a transaction program has aborted
// API calls to clear, display abort message and sound beeper
VioClear();
VioWrtCharStr("Function aborted!!!",19,1,1,&count,CURSOR_MOVE);
SpkBeep(FREQ_700, DEFAULT_VOLUME,2);
// Wait 2 seconds
WaitAWhile(2);
// Set flag to resume normal processing
Function = 0;
// Force clear and redisplay of prompt
prompt_displayed = 'N';
}
else if (Function == 2) {
</PRE><BR>
<PRE>
// Function 2 is the reentry point after a power-fail restart of the
// terminal. The CFR should reestablish any volatile terminal or
// settings here.
return;
}
else {
// If Function parameter illegal return to calling ETS, returned code
// irrelevant.
return(0);
}
}
} // main
//*************************************************************************
void Unique_CFR_Func ()
{
unsigned short count;
// This can be any function which
// can not be done using the normal ETS command processing.
// API calls clear display and display dummy message
VioClear();
VioWrtCharStr("Doing Unique CFR Function",25,1,1,&count,CURSOR_MOVE);
// Set flag to cause redisplay of prompt
prompt_displayed = 'N';
// Dummy pause to display message
WaitAWhile(2);
} // Unique_CFR_Funct
//*************************************************************************
void WaitAWhile(unsigned short secs)
{
WaitEvent( (ULONG)secs * 1000L );
} // WaitAWhile
//******************************
// End Sample CFR Mode 2 Program
//******************************
</PRE><BR>
</TD></TR></TABLE>
<HR>
<H2><A NAME="Header_156" HREF="#PToC_156">Power-Failure Recovery Considerations</A></H2>
<P>Some recovery problems that occur after a power failure can be traced
to the use of statically-initialized global variables.
C language statically-initialized global variables
are NOT re-initialized
when the terminal is re-started after a power failure.
<P>For example:
<PRE>
USHORT InLoop = FALSE;
main()
{
if (!InLoop) {
InLoop = TRUE;
(do something)
InLoop = FALSE;
}
{
</PRE>
<P>
In this example, if the power fails in the middle of "do something", that
code will never be executed again.
The problem could be avoided by dynamically initializing InLoop at the
top of main.
<P><B>Note: </B>This problem does not apply to local variables.
Local variables are allocated from the stack and re-initialized each
time into the procedure.
<HR>
<H2><A NAME="Header_157" HREF="#PToC_157">Returning to the Transaction Program</A></H2>
On exit, the CFR returns a flag which determines
the next action in a transaction
program. The return flags are:
<DL>
<DD><P>NO_SKIP (0) = do not skip the next command
<DD><P>SKIP (1) = skip the next command
<DD><P>ABORT (2) = to abort the transaction
</DL>
The CFR and the transaction program(s) which use it should agree on a
convention as to what the return code should be for which conditions.
<HR>
<H2><A NAME="Header_158" HREF="#PToC_158">Battery Operation Time Considerations</A></H2>
Many terminals operate from
a battery pack. To keep weight and size to a minimum, this battery
must have a rather limited energy content.
In order to provide as much run time as possible from this energy source,
the terminal's programs must be written taking energy consumption into
account.
<P>
The terminal has advanced power management capabilities which require
cooperation from your programs in order to be most effective.
Whenever the terminal is waiting for input (e.g. keystrokes, bar code
scan, host response, etc.), most of its processing is put in a
"sleep" mode --
suspended
to keep power use by the microprocessors and memory devices to a
minimum. An auxiliary processor monitors the input devices of the
terminal and "wakes" the other processors when an input event
occurs.
However, to know when it can "sleep", your program needs to
inform the system that it is now awaiting input. This is done
by calling the WaitEvent function
(See<A HREF="#HDRWTEVNT">WaitEvent</A>)
whenever your program is waiting for input.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The discussion above applies specifically to 7524 terminals which are
tightly integrated into the 7524 ETS flash with regard to power management
functions. Terminals running the DCConnect Client, are not tied as tightly
to the hardware and thus aren't able to tell processors to shut down when
the terminal is idle or waiting for something. Nonetheless, the techniques
described above should still be used when writing your CFR to minimize the
amount of processor time is spent in the CFR.
</td></tr></table>
<HR>
<H2><A NAME="Header_159" HREF="#PToC_159">Using CFRs Developed for the 7526 and 7527</A></H2>
<P>
Some CFRs originally developed for the 7526 or the
7527 will be usable with ETS
only if the CFR header file(s) included are
replaced with the inclusion
of CFRAPI24.H and the CFR is then recompiled. In
addition, the resulting
object module(s) must be relinked with CFRAPI24.LIB
instead of any other CFR
library. This will be true if:
<UL>
<P><LI>The CFR uses only APIs which are supported by ETS.
<A HREF="#TBLCFRFAPI">Table 14</A> compares the CFR functions and APIs available
on each of the different 752x DCT products.
In general, if an API name listed in
(See<A HREF="#HDRC9">Device-level CFR Functions</A>) or
(See<A HREF="#HDRAPICFR">Application-level CFR APIs</A>)
is the same as one listed in the 7527 ETS or 7526
programming manuals, then compilation is the same as for the other
products. (An exception to this is IdleManager: ETS's format is
the same as that for the 7526, but 7527 ETS does not have a delay
parameter and thus 7527 programs which call IdleManager must be modified
with time delay value and re-compiled).
<P><LI>The CFR does not contain any indefinite input loops which
could dramatically reduce battery operation time
(See<A HREF="#HDRWTEVNT">WaitEvent</A>) .
</UL>
If an API which was used is not supported by ETS, or if
WaitEvent calls should be added to maintain battery operation time,
then the CFR source code must be modified and re-compiled and linked.
<P>
In general, you must modify the source code to include
CFRAPI24.H instead of the header files used for 7526 and 7527 ETS and
re-compile the code. This will provide a thorough check
of which functions were used in the source. The compiler will provide
warning reports of any 7526/7527 functions which were used but which are
not supported in the CFRAPI24.H.
<HR>
<H2><A NAME="Header_160" HREF="#PToC_160">Compiling and Linking a CFR</A></H2>
<P>
<H3><A NAME="Header_161" HREF="#PToC_161">General</A></H3>
<P>The remainder of this discussion applies to building CFRs for 7524
terminals specifically. For terminals running any version of the DCConnect
Client, please see the DCConnect Client documentation for information about
how to compile and link CFRs.
<P>
CFRs build for 7524 terminals and for DOS versions of the DCConnect Client
are interchangeable provided none of the restricted C library functions are
used in the CFR.
<P>
The CFR writer need only write a function with a
"main(function,*paramlist)" entry point, compile
with the appropriate "include" files, and link with
the <B>CFRAPI24.LIB</B> library provided (and any other
libraries required) to create a CFR program file.
Compiling and linking a mode 1 or mode 2 CFR is accomplished in
the same manner.
<P>
The CFR application program interface library,
<B>CFRAPI24.LIB</B>, contains:
<UL>
<P><LI>A CFRCRT0 module to link with the CFR which
provides for parameter passing to the CFR, BSS
initialization, stack switching, and return to
ETS. CFRCRT0.OBJ substitutes for the normal
CRT0.OBJ linked with "C" language code
For this reason, you must arrange for CFRAPI24.LIB to
be used for linking before any other standard C library file
which may include a suitable object module for resolving the link.
<P><LI>API modules to link with the CFR to make the
calls to the CFR APIs.
</UL>
An "include" file "CFRAPI24.H" is provided for the CFR
writer which contains CFR API function prototypes,
defined constants, and return code defines.
<P>
<P>
<H3><A NAME="Header_162" HREF="#PToC_162">Required Compiler/Linker</A></H3>
<DL>
<DD><P>IBM C/2 Version 1.10 or later
<DD><P> or
<DD><P>Borland Turbo C++ 3.0 for DOS (not 4.5 for Windows)
</DL>
<P>
<H3><A NAME="Header_163" HREF="#PToC_163">Compile Command for IBM C/2</A></H3>
The following compiler invocation command is recommended:
<DL>
<DD><P><B>cl -c -nologo -Fl -ALw -FPa -Zpe -Ox -W3 -G1s -I[path]cfr.h mycfr.c</B>
<DL>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>-c
</B></TD><TD><P>suppress automatic linking
</TD></TR><TR VALIGN=TOP><TD><P><B>-nologo
</B></TD><TD><P>suppress logo and copyright in output stream
</TD></TR><TR VALIGN=TOP><TD><P><B>-Fl
</B></TD><TD><P>create object file
</TD></TR><TR VALIGN=TOP><TD><P><B>-ALw
</B></TD><TD><P>large model, separate stack
segment, does not load DS at
each module entry point.
</TD></TR><TR VALIGN=TOP><TD><P><B>-FPa
</B></TD><TD><P>Use alternate math library (can't use emulated or 8087 math library)
</TD></TR><TR VALIGN=TOP><TD><P><B>-Zpe
</B></TD><TD><P>pack structures, enables C language extensions
</TD></TR><TR VALIGN=TOP><TD><P><B>-W3
</B></TD><TD><P>Use warning level 3 for warning/error messages
</TD></TR><TR VALIGN=TOP><TD><P><B>-Ox
</B></TD><TD><P>maximum optimization
</TD></TR><TR VALIGN=TOP><TD><P><B>-G1s
</B></TD><TD><P>186 instruction set, no stack checking (to make compatible with
more levels)
</TD></TR><TR VALIGN=TOP><TD><P><B>-I[path]cfrapi24.h
</B></TD><TD><P>location of include file, path optional
</TD></TR><TR VALIGN=TOP><TD><P><B>mycfr.c
</B></TD><TD><P>CFR source file
</TD></TR></TABLE>
</DL>
</DL>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
You must be sure that CFRAPI24.H is
in the path specified in the
SET INCLUDE statement for your C compiler.
</td></tr></table>
<P>
<H3><A NAME="Header_164" HREF="#PToC_164">Link Command for IBM C/2</A></H3>
The following format is recommended for the link operation:
<DL>
<DD><P>
<B>
link mycfr+...,mycfr.exe,mycfr.map,cfrapi24.lib llibcar.lib /DO /NOD /NOI;
</B>
<DL>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>mycfr+....
</B></TD><TD><P>list of object modules
</TD></TR><TR VALIGN=TOP><TD><P><B>mycfr.exe
</B></TD><TD><P>output executable file name
</TD></TR><TR VALIGN=TOP><TD><P><B>mycfr.map
</B></TD><TD><P>output map file name
</TD></TR><TR VALIGN=TOP><TD><P><B>cfrapi24.lib
</B></TD><TD><P>CFR API library, required - supplies CFRCRT0.OBJ as a
minimum, plus modules for CFR APIs. Be sure to use the IBM C/2
version of this library.
</TD></TR><TR VALIGN=TOP><TD><P><B>llibcar.lib
</B></TD><TD><P>Large model, combined, alternate math library for <B><I>real mode</I></B>
of the microprocessor (do not use <B><I>protect mode</I></B> libraries).
</TD></TR><TR VALIGN=TOP><TD><P><B>/NOI
</B></TD><TD><P>don't ignore upper and lower case
</TD></TR><TR VALIGN=TOP><TD><P><B>/DO
</B></TD><TD><P>arrange segments in DOS fashion
</TD></TR><TR VALIGN=TOP><TD><P><B>/NOD
</B></TD><TD><P>no default library usage; link only with libraries specified on link
command line
</TD></TR></TABLE>
</DL>
</DL>
<P><B>Note: </B>You should link with a REAL MODE "C" library, not with a PROTECTED MODE
library. Also you must ensure that you are linking with the IBM C2 version of
the CFRAPI24.LIB file (it's in the \CFR\IBMC2 directory of the CD/package) and that it
is in the current directory or in the path specified in the SET LIB= statement
of your environment. It is also important to compile and link specifying the
alternate math library instead of the emulation or 8087 math libararies.
<P>
<H3><A NAME="Header_165" HREF="#PToC_165">Compile Command for Borland Turbo C++ 3.0 for DOS</A></H3>
The following compiler invocation command is recommended:
<DL>
<DD><P>
<B>tcc -c -ml mycfr.c
</B>
<DL>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>-c
</B></TD><TD><P>suppress automatic linking
</TD></TR><TR VALIGN=TOP><TD><P><B>-ml
</B></TD><TD><P>Compile using large memory model
</TD></TR><TR VALIGN=TOP><TD><P><B>mycfr.c
</B></TD><TD><P>CFR source file
</TD></TR></TABLE>
</DL>
</DL>
<P>
<H3><A NAME="Header_166" HREF="#PToC_166">Link Command for Borland Turbo C++ 3.0 for DOS</A></H3>
The following format is recommended for the link operation:
<DL>
<DD><P>
<B>tlink mycfr1 mycfr2, mycfr.exe, mycfr.map, cfrapi24.lib cl.lib
</B>
<DL>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>mycfr1 mycfr2
</B></TD><TD><P>list of object modules
</TD></TR><TR VALIGN=TOP><TD><P><B>mycfr.exe
</B></TD><TD><P>output executable file name
</TD></TR><TR VALIGN=TOP><TD><P><B>mycfr.map
</B></TD><TD><P>output map file name
</TD></TR><TR VALIGN=TOP><TD><P><B>cfrapi24.lib
</B></TD><TD><P>Client CFR API library, required - supplies CFR start up
code as a minimum, plus modules for CFR APIs to interface with Client
Be sure to use the Borland version of this library.
</TD></TR><TR VALIGN=TOP><TD><P><B>cl.lib
</B></TD><TD><P>Large model standard real mode library
</TD></TR></TABLE>
</DL>
</DL>
<P><B>Note: </B>Be sure to link with the Borland Turbo C++ version of the CFRAPI24.LIB
library (it's in the \CFR\BORLAND directory of the CD/package). Also be sure it is
the first library in the link list to ensure that the correct CFR linkage and
parameter passing routines are executed during CFR calls.
<HR>
<H1><A NAME="HDRC9" HREF="#PToC_167">Device-level CFR Functions</A></H1>
<HR>
<H2><A NAME="HDRC8" HREF="#PToC_168">Introduction</A></H2>
<P>
This chapter contains reference material for making C
calls to the Device-level CFR functions.
The following CFR functions are covered:
<UL>
<P><LI>Keyboard
(See<A HREF="#HDRKEY">Reference - Keyboard</A>) .
<P><LI>Date/Time
(See<A HREF="#HDRDATT">Reference - Date/Time</A>) .
<P><LI>Sensor Input Ports
(See<A HREF="#HDRSIP">Reference - Sensor Input Ports</A>) .
<P><LI>Speaker
(See<A HREF="#HDRTRANS">Reference - Beeper</A>) .
<P><LI>LCD Display
(See<A HREF="#HDRLCDD">Reference - LCD Displays</A>) .
<P><LI>General Support
(See<A HREF="#HDRGSPT">Reference - General Support</A>) .
<P><LI>Communications Port
(See<A HREF="#HDRCPREF">Reference - Communications Port</A>) .
<P><LI>Timer Support
(See<A HREF="#HDRTMRSPT">Reference - Timer functions</A>) .
</UL>
<A HREF="#TBLCFRFAPI">Table 14</A> compares the CFR functions available in ETS with those
available in the 7526 and 7527 terminal families.
<HR>
<H2><A NAME="Header_169" HREF="#PToC_169">Summary List of Device-Level CFR functions</A></H2>
<P>
<H3><A NAME="HDRKBDF" HREF="#PToC_170">Keyboard</A></H3>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>KbdReadAscii
</TD><TD><P>Returns the next make code in ASCII form
</TD></TR><TR VALIGN=TOP><TD><P>KbdHandleArrowKeys
</TD><TD><P>Used to disable/enable the terminal's handling of arrow keys for scrolling
</TD></TR></TABLE>
<P>
<H3><A NAME="HDRDTF" HREF="#PToC_171">Date/Time</A></H3>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>RtcGetAsciiDate
</TD><TD><P>Returns the date in ASCII format
</TD></TR><TR VALIGN=TOP><TD><P>RtcGetAsciiTime
</TD><TD><P>Returns the time in ASCII format
</TD></TR><TR VALIGN=TOP><TD><P>RtcGetDate
</TD><TD><P>Returns the binary value of the date
</TD></TR><TR VALIGN=TOP><TD><P>RtcGetTime
</TD><TD><P>Returns the binary value of the time
</TD></TR></TABLE>
<P>
<H3><A NAME="HDRSIPF" HREF="#PToC_172">Sensor Input Ports</A></H3>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>SenActLed
</TD><TD><P>Lights the sensor port LED's for a predetermined time
</TD></TR><TR VALIGN=TOP><TD><P>SenPower
</TD><TD><P>Turns power to the sensor port (scanner) on or off.
</TD></TR><TR VALIGN=TOP><TD><P>SenQueryData
</TD><TD><P>Returns the number of sensor data records available
</TD></TR><TR VALIGN=TOP><TD><P>SenRead
</TD><TD><P>Returns the next sensor data record available
</TD></TR></TABLE>
<P>
<H3><A NAME="HDRSPKF" HREF="#PToC_173">Speaker</A></H3>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>SpkBeep
</TD><TD><P>Sounds the speaker
</TD></TR><TR VALIGN=TOP><TD><P>SpkQuery
</TD><TD><P>Returns the on/off state of the speaker
</TD></TR></TABLE>
<P>
<H3><A NAME="HDRDISF" HREF="#PToC_174">LCD Display</A></H3>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>VioClear
</TD><TD><P>Clears the video display
</TD></TR><TR VALIGN=TOP><TD><P>VioGetCurPos
</TD><TD><P>Returns the current row and column position
</TD></TR><TR VALIGN=TOP><TD><P>VioQuery
</TD><TD><P>Returns the current VIO configuration information
</TD></TR><TR VALIGN=TOP><TD><P>VioReadCell
</TD><TD><P>Returns the character/attribute pair from the display
</TD></TR><TR VALIGN=TOP><TD><P>VioReadCellStr
</TD><TD><P>Reads a character/attribute pair string from the display
</TD></TR><TR VALIGN=TOP><TD><P>VioReadChar
</TD><TD><P>Reads a character from the display
</TD></TR><TR VALIGN=TOP><TD><P>VioReadCharStr
</TD><TD><P>Reads a character string from the display
</TD></TR><TR VALIGN=TOP><TD><P>VioSetCurPos
</TD><TD><P>Sets the cursor at the indicated row and column
</TD></TR><TR VALIGN=TOP><TD><P>VioSetCurType
</TD><TD><P>Sets the current cursor type
</TD></TR><TR VALIGN=TOP><TD><P>VioWrtCellStr
</TD><TD><P>Writes a string of character/attribute pairs to the display
</TD></TR><TR VALIGN=TOP><TD><P>VioWrtCharStr
</TD><TD><P>Writes a character string to the display
</TD></TR><TR VALIGN=TOP><TD><P>VioWrtCharStrAtt
</TD><TD><P>Writes a character string with a common attribute to the display
</TD></TR><TR VALIGN=TOP><TD><P>VioWrtNCell
</TD><TD><P>Writes a character/attribute pair a specified number of times
to the display
</TD></TR><TR VALIGN=TOP><TD><P>VioWrtNChar
</TD><TD><P>Writes character a specified number of times to the display
</TD></TR></TABLE>
<P>
<H3><A NAME="HDRMSF" HREF="#PToC_175">General Support</A></H3>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>HitWatchdog
</TD><TD><P>Provided for compatibility with 7527
</TD></TR></TABLE>
<P>
<H3><A NAME="Header_176" HREF="#PToC_176">Communications Port</A></H3>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>ComGetParms
</TD><TD><P>Returns the communication parameters for the indicated port
</TD></TR><TR VALIGN=TOP><TD><P>ComGetProtocol
</TD><TD><P>Returns the values of the protocol options
</TD></TR><TR VALIGN=TOP><TD><P>ComQuery
</TD><TD><P>Returns the communications subsystem POST status
</TD></TR><TR VALIGN=TOP><TD><P>ComQueryData
</TD><TD><P>Returns the number of data items available for a given port
</TD></TR><TR VALIGN=TOP><TD><P>ComRead
</TD><TD><P>Reads a block of data from the specified port
</TD></TR><TR VALIGN=TOP><TD><P>ComSetMdmCtl
</TD><TD><P>Sets the DTR and RTS modem control lines on the EIS-232 port
</TD></TR><TR VALIGN=TOP><TD><P>ComSetParms
</TD><TD><P>Set the communication parameters for the selected port
</TD></TR><TR VALIGN=TOP><TD><P>ComWrite
</TD><TD><P>Sends data to the communication driver of the specified port
</TD></TR></TABLE>
<P>
<H3><A NAME="HDRTMRF" HREF="#PToC_177">Timer Support</A></H3>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>TimerSetAlarm
</TD><TD><P>Sets alarm to trigger at selected times throughout the day to
call a transaction program or CFR.
</TD></TR><TR VALIGN=TOP><TD><P>TimerClearAlarm
</TD><TD><P>Clears all alarms set by the TimerSetAlarm function.
</TD></TR><TR VALIGN=TOP><TD><P>TimerSetInterval
</TD><TD><P>Sets one or more alarms to trigger at a user-specified interval in
order to call a transaction program or CFR.
</TD></TR><TR VALIGN=TOP><TD><P>TimerClearAlarm
</TD><TD><P>Clears all interval alarms set by the TimerSetInterval function.
</TD></TR></TABLE>
<HR>
<H2><A NAME="HDRKEY" HREF="#PToC_178">Reference - Keyboard</A></H2>
<P>
<H3><A NAME="Header_179" HREF="#PToC_179">KbdReadAscii</A></H3>
<P>
This function returns the next make code in the buffer in ASCII
form. All break codes and Shift keys are skipped.
<P>
<H4><A NAME="Header_180" HREF="#PToC_180">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT KbdReadAscii(code)
USHORT FAR *code // Returned code
Returns: E_OK // If no error occurred
E_NO_DATA // If no valid code in buffer
</PRE>
<P>
<H4><A NAME="Header_181" HREF="#PToC_181">Comments</A></H4>
<P>
If a key has an extended ASCII value, the low byte
contains 00 and the high byte contains the extended
ASCII value.
<P>
Refer to the <B>cfrapi24.h</B> file for key code defines.
<P>
<H3><A NAME="Header_182" HREF="#PToC_182">KbdHandleArrowKeys</A></H3>
<P>
This function can be used to enable or disable the terminal's handling of
arrow keys to scroll the screen. By default the terminal handles these
arrow keys. When the arrow keys are handled, they are never seen by the
KbdReadAscii API call. If you want KbdReadAscii to see the arrow keys, then
use KbdHandleArrowKeys to disable ETS's handling of these keys.
<P>
The constants used for the arrow keys, which are defined in CFRAPI24.H are:
<UL>
<P><LI>CURSOR_UP
<P><LI>CURSOR_DOWN
<P><LI>CURSOR_LEFT
<P><LI>CURSOR_RIGHT
</UL>
<P>
<H4><A NAME="Header_183" HREF="#PToC_183">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT KbdHandleArrowKeys(flag)
UCHAR flag // Flag to enable/disable
Returns: E_OK // If no error occurred
E_PARAM // If invalid parameter is provided
</PRE>
<P>
<H4><A NAME="Header_184" HREF="#PToC_184">Comments</A></H4>
<P>
The parameter 'flag' can take one of the following two constants, which are
defined in CFRAPI24.H:
<UL>
<P><LI>01h HANDLE_ARROWS_YES
<P><LI>00h HANDLE_ARROWS_NO
</UL>
<HR>
<H2><A NAME="HDRDATT" HREF="#PToC_185">Reference - Date/Time</A></H2>
<P>
<H3><A NAME="Header_186" HREF="#PToC_186">RtcGetAsciiDate</A></H3>
<P>
This function returns the date in ASCII format.
The returned string is <B>not</B> null-terminated.
The data buffer should be large enough to take the largest format.
<P>
<H4><A NAME="Header_187" HREF="#PToC_187">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT RtcGetAsciiDate(format, buffer, default_format)
UCHAR format // Format of date
UCHAR FAR *buffer // Pointer to date buffer
UCHAR FAR *default_format // Pointer to returned
// default format.
Returns: E_OK // If no error occurred
E_PARAM // If format was invalid
E_DEVICE // If clock was busy
</PRE>
<P>
<H4><A NAME="Header_188" HREF="#PToC_188">Comments</A></H4>
<P>Defined values for date format are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h DEFAULT_DATE
</TD><TD><P>Use the format set in keylock setup mode.
</TD></TR><TR VALIGN=TOP><TD><P>01h MMDDYY
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>02h DDMMYY
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>03h YYMMDD
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>04h JJJYY
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>05h YYJJJ
</TD><TD><P>
</TD></TR></TABLE>
<P>
<H3><A NAME="Header_189" HREF="#PToC_189">RtcGetAsciiTime</A></H3>
<P>
This function returns the time in ASCII format.
The returned string is <B>not</B> null-terminated.
<P>
<H4><A NAME="Header_190" HREF="#PToC_190">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT RtcGetAsciiTime(format, buffer, default_format)
UCHAR format // Format of time
UCHAR FAR *buffer // Pointer to time buffer
UCHAR FAR *default_format // Pointer to returned
// default format.
Returns: E_OK // If no error occurred
E_PARAM // If format was invalid
E_DEVICE // If clock was busy
</PRE>
<P>
<H4><A NAME="Header_191" HREF="#PToC_191">Comments</A></H4>
<P>
An <I>am</I> or <I>pm</I> is appended to the end of the time
string in 12-hour format.
<P>Defined values for time format are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h DEFAULT_TIME
</TD><TD><P>Use the format set in keylock setup mode.
</TD></TR><TR VALIGN=TOP><TD><P>01h HHMMSS_12
</TD><TD><P>(Comes back with eight characters, which includes <I>am</I>
or <I>pm</I>)
</TD></TR><TR VALIGN=TOP><TD><P>02h HHMMSS_24
</TD><TD><P>
</TD></TR></TABLE>
<P>
<P>
<H3><A NAME="Header_192" HREF="#PToC_192">RtcGetDate</A></H3>
<P>
This function returns the binary value of the year, month, and
day in the specified format.
<P>
<H4><A NAME="Header_193" HREF="#PToC_193">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT RtcGetDate(format, year, month, day, default_format)
UCHAR format // Format of date
UCHAR FAR *year // Pointer to returned year
UCHAR FAR *month // Pointer to returned month
UCHAR FAR *day // Pointer to returned day
UCHAR FAR *default_format // Pointer to returned
// default format.
Returns: E_OK // If no error occurred
E_PARAM // If format was invalid
E_DEVICE // If clock was busy
</PRE>
<P>
<H4><A NAME="Header_194" HREF="#PToC_194">Comments</A></H4>
<P>Defined values for date format are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h DEFAULT_DATE
</TD><TD><P>Use the format set in keylock setup mode.
</TD></TR><TR VALIGN=TOP><TD><P>01h MMDDYY
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>02h DDMMYY
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>03h YYMMDD
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>04h JJJYY
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>05h YYJJJ
</TD><TD><P>
</TD></TR></TABLE>
<P>
<H3><A NAME="Header_195" HREF="#PToC_195">RtcGetTime</A></H3>
<P>
This function returns the binary value of the hour, minute, and
second in the specified format.
<P>
<H4><A NAME="Header_196" HREF="#PToC_196">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT RtcGetTime(format, hour, min, sec, am_or_pm
default_format)
UCHAR format // Time format
UCHAR FAR *hour // Pointer to returned hour
UCHAR FAR *min // Pointer to returned minute
UCHAR FAR *sec // Pointer to returned seconds
UCHAR FAR *am_or_pm // Pointer to returned AM or PM
UCHAR FAR *default_format // Pointer to returned format
Returns: E_OK // If no error occurred
E_PARAM // If format was invalid
E_DEVICE // If clock was busy
</PRE>
<P>
<H4><A NAME="Header_197" HREF="#PToC_197">Comments</A></H4>
<P>Defined values for the time format are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h DEFAULT_TIME
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h HHMMSS_12
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>02h HHMMSS_24
</TD><TD><P>
</TD></TR></TABLE>
<P>Defined values for am_or_pm are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h AM
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h PM
</TD><TD><P>
</TD></TR></TABLE>
<HR>
<H2><A NAME="HDRSIP" HREF="#PToC_198">Reference - Sensor Input Ports</A></H2>
<P>
<H3><A NAME="Header_199" HREF="#PToC_199">SenActLed</A></H3>
<P>
This function lights the sensor port LEDs for the duration
specified.
<P>
<H4><A NAME="Header_200" HREF="#PToC_200">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT SenActLed(lednumber, duration)
UCHAR lednumber // LED select
UCHAR duration // Duration to light LED
// 1 = 20 msec
Returns: E_OK // If no error occurred
E_PARAM // If input parameters invalid
</PRE>
<P>
<H4><A NAME="Header_201" HREF="#PToC_201">Comments</A></H4>
<P>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The LEDs are simulated on the terminal display using an icon.
The 7524 terminals do not have digital output points on their sensor
port; thus the MAG_PORTx_LEDy uses are not operational.
The LED is lit for the duration times 20 milliseconds
and then extinguished.
If duration is set to 0, the LED is turned on for an indefinite time.
Use a non-zero duration to turn it off again.
<P>
LEDs are not supported for terminals that are running the DCConnect Client.
</td></tr></table>
<P>
The defined values for lednumber are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h PANEL_LED
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h MAG_PORT1_LED1
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>02h MAG_PORT1_LED2
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>03h MAG_PORT1_LED3
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>04h MAG_PORT2_LED1
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>05h MAG_PORT2_LED2
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>06h MAG_PORT2_LED3
</TD><TD><P>
</TD></TR></TABLE>
<P>
<P>
<H3><A NAME="Header_202" HREF="#PToC_202">SenPower</A></H3>
<P>
This function turns power to the sensor port (scanner) on or off
<P>
<H4><A NAME="Header_203" HREF="#PToC_203">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT SenPower(int fTurnPowerOn)
USHORT fTurnPowerOn // TRUE - means turn power on
// FALSE - means turn power off
Returns: E_OK // If no error occurred
// (only value returned)
</PRE>
<P>
<H4><A NAME="Header_204" HREF="#PToC_204">Comments</A></H4>
This API call which was introduced in version 2.10e of the DCConnect Client,
allows the CFR to control when scanner input is valid. Prior to this, scanner
input was valid for all CFR API calls for the entire duration of the CFR call,
even for calls that were not reading any scanner input.
<P>
The first time SenPower is called by the CFR, the Client will
set a flag telling it to no longer turn on the scanner for all
CFR calls. Therefore, the CFR should call SenPower(FALSE) in
both case 0 and case 2 of the CFR so that the scanner is turned
off before any transaction programs are started.
<P>
Even when this API is being used by the CFR, the Client will
still turn the scanner off after all API calls - in case the
CFR turned it on and forgot to turn it off.
<P>
Note: Whether the scanner is actually powered off is dependent
on the device on which the DCConnect Client is running. For
Windows CE devices, the CFR .DLL, ETSHW.DLL, controls whether
or not the scanner is actually turned off.
<P>
In some cases, the scanner may be left on but its input might
be ignored. For example, the ETSHW.DLL for the Intermec 7xx
running Windows Mobile 2003 simply disables the Wedge input.
The scanner is left on, but a different beep is given by the
scanner if someone attempts to scan while the Wedge input is
disabled.
<P>
<H3><A NAME="Header_205" HREF="#PToC_205">SenQueryData</A></H3>
<P>
This function returns the number of sensor data records available.
<P>
<H4><A NAME="Header_206" HREF="#PToC_206">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT SenQueryData(numrecords)
USHORT *numrecords // Pointer to returned number
// of data records
Returns: E_OK // If no error occurred
// (only value returned)
</PRE>
<P>
<H4><A NAME="Header_207" HREF="#PToC_207">Comments</A></H4>
At this time, no more than one sensor record is buffered in the terminal.
<P>
<H3><A NAME="Header_208" HREF="#PToC_208">SenRead</A></H3>
<P>
This function returns the next sensor data record available.
<P>
<H4><A NAME="Header_209" HREF="#PToC_209">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT SenRead(answerbuffer, maxlist)
UCHAR *answerbuffer // Pointer to returned next
// sensor data record.
USHORT maxlist // Size of answerbuffer
Returns: E_OK // If no error occurred
E_NO_DATA // If no data records available
</PRE>
<P>
<H4><A NAME="Header_210" HREF="#PToC_210">Comments</A></H4>
<P>
The answerbuffer record format is:
<DL>
<DD><P>First byte is result bar-code type. For certain terminal models, this
value is always set to a blank. Otherwise it is a value from CFRAPI24.H
(e.g. I_25_CODE, CODE_39, EAN_8, ...).
<DD><P>Second byte is port number. This is always 0.
<DD><P>Third byte is number of data bytes following.
<DD><P>Remainder of buffer is ASCII data from sensor.
</DL>
<P>
See "cfrapi24.h" file for supported bar-code types.
<P><B>Note: </B>There is no default buffer size for this function.
Whatever buffer is provided by the user is used.
You can determine if the buffer is too small by checking the
third byte of the returned data, which specifies how many data bytes
follow.
If that is longer than the size of the buffer provided, the data will be
truncated to the size of the buffer.
Sensor data can never be longer than 100 characters, plus the three
prefix characters returned in the buffer.
This means that the buffer never needs to be longer than 103 bytes.
<HR>
<H2><A NAME="HDRTRANS" HREF="#PToC_211">Reference - Beeper</A></H2>
<P>
<H3><A NAME="Header_212" HREF="#PToC_212">SpkBeep</A></H3>
<P>
This function sounds the transducer.
<P>
<H4><A NAME="Header_213" HREF="#PToC_213">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT SpkBeep(frequency, volume, duration)
UCHAR frequency // Transducer frequency
UCHAR volume // Transducer volume
USHORT duration // Transducer duration in
// increments of 0.1
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
E_DEVICE // If transducer is busy
</PRE>
<P>
<H4><A NAME="Header_214" HREF="#PToC_214">Comments</A></H4>
<P>Defined values for frequency are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h FREQ_700
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h FREQ_2000
</TD><TD><P>
</TD></TR></TABLE>
<P>Defined values for volume are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h DEFAULT_VOLUME
</TD><TD><P>Uses value from setup keylock mode
</TD></TR><TR VALIGN=TOP><TD><P>01h VOLUME_OFF
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>02h VOLUME_LOW
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>03h VOLUME_HIGH
</TD><TD><P>
</TD></TR></TABLE>
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
On some terminal types, the frequency and/or volume are ignored; in these
cases the beep is always the same tone, duration and volume regardless of
what parameters are passed.
</td></tr></table>
<P>
<P>
<H3><A NAME="Header_215" HREF="#PToC_215">SpkQuery</A></H3>
<P>
This function returns the transducer status (on or off) and the
POST completion code for the transducer.
<P>
<H4><A NAME="Header_216" HREF="#PToC_216">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT SpkQuery(status, post)
UCHAR FAR *status // Pointer to transducer status
USHORT FAR *post // Pointer to POST completion code
Returns: E_OK // If no error occurred
// (only value returned)
</PRE>
<HR>
<H2><A NAME="HDRLCDD" HREF="#PToC_217">Reference - LCD Displays</A></H2>
<P>
<H3><A NAME="Header_218" HREF="#PToC_218">VioClear</A></H3>
<P>
This function clears the video display and sets the cursor position to
the upper left-hand corner of the display.
<P>
<H4><A NAME="Header_219" HREF="#PToC_219">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioClear()
Returns: E_OK // If no error occurred
// (only value returned)
</PRE>
<P>
<H3><A NAME="Header_220" HREF="#PToC_220">VioGetCurPos</A></H3>
<P>
This function returns the current row and column position of the
cursor.
<P>
<H4><A NAME="Header_221" HREF="#PToC_221">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioGetCurPos(Row, Col)
UCHAR *Row // Pointer to returned row
UCHAR *Col // Pointer to returned column
Returns: E_OK // If no error occurred
// (only value returned)
</PRE>
<P>
<H4><A NAME="Header_222" HREF="#PToC_222">Comments</A></H4>
<P>
The upper left corner of the screen is represented by row-column
coordinates of 0,0.
<P>
<H3><A NAME="Header_223" HREF="#PToC_223">VioQuery</A></H3>
<P>
This function returns the number of rows and columns and the current
display configuration, cursor type, video mode, character set, touch
screen state, and POST completion information.
<P>
<H4><A NAME="Header_224" HREF="#PToC_224">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioQuery(Row, Col, CurType, Mode, CharSet,
Touch, Post)
UCHAR *Row // Pointer to number of rows
UCHAR *Col // Pointer to number of columns
UCHAR *CurType // Pointer to cursor type
UCHAR *Mode // Pointer to video mode
UCHAR *CharSet // Pointer to character set
UCHAR *Touch // Pointer to touch screen state
USHORT *Post // Pointer to POST completion code
Returns: E_OK // If no error occurred
// (only value returned)
</PRE>
<P>
<H4><A NAME="Header_225" HREF="#PToC_225">Comments</A></H4>
<P>
Defined values for CurType are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h
</TD><TD><P>CURSOR_OFF
</TD></TR><TR VALIGN=TOP><TD><P>01h
</TD><TD><P>CURSOR_UNDERBAR
</TD></TR><TR VALIGN=TOP><TD><P>02h
</TD><TD><P>CURSOR_BLINK_UNDERBAR
</TD></TR><TR VALIGN=TOP><TD><P>03h
</TD><TD><P>CURSOR_BLOCK
</TD></TR><TR VALIGN=TOP><TD><P>04h
</TD><TD><P>CURSOR_BLINK_BLOCK
</TD></TR></TABLE>
<P>
Defined values for video Mode are given below.
ETS always returns the value <B><I>highlighted</I></B>.
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h TWO_LINE_DISPLAY
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P><B><I>01h GRAPHICS_NORMAL</I></B>
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>02h GRAPHICS_REVERSE
</TD><TD><P>
</TD></TR></TABLE>
<P>
Defined values for CharSet are given below.
ETS always returns the value <B><I>highlighted</I></B>.
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B><I>00h</I></B>
</TD><TD><P><B><I>STANDARD 20x40</I></B>
</TD></TR><TR VALIGN=TOP><TD><P>01h
</TD><TD><P>STANDARD 14x32
</TD></TR><TR VALIGN=TOP><TD><P>02h
</TD><TD><P>DOWNLOAD 20x40
</TD></TR><TR VALIGN=TOP><TD><P>03h
</TD><TD><P>DOWNLOAD 14x32
</TD></TR></TABLE>
<P>
Defined values for Touch screen are given below.
ETS always returns the value <B><I>highlighted</I></B>.
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>00h</B>
</TD><TD><P><B><I>TOUCH_NOT_INSTALLED</I></B>
</TD></TR></TABLE>
<P>
<P>
<H3><A NAME="Header_226" HREF="#PToC_226">VioReadCell</A></H3>
<P>
This function returns the character/attribute pair at a specified
cursor location.
<P>
<H4><A NAME="Header_227" HREF="#PToC_227">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioReadCell(Row, Col, Cell, CurMove)
UCHAR Row // Row position of cell to read
UCHAR Col // Column position of cell to read
VIO_CELL *Cell // Pointer to returned cell where
// data is returned
UCHAR CurMove // Cursor movement flag
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
E_END_OF_SCREEN // If attempt to move past
// end of screen.
</PRE>
<P>
<H4><A NAME="Header_228" HREF="#PToC_228">Comments</A></H4>
<P>
The upper left corner of the screen is represented by row-column
coordinates of 0,0.
<P>
If the user wants a cell read at the current row and/or column
position, 0xFF should be
sent for the row and/or column position value.
<P>
Defined values for CurMove are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h NO_CURSOR_MOVE
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h CURSOR_MOVE
</TD><TD><P>
</TD></TR></TABLE>
<P>
<P>
<H3><A NAME="Header_229" HREF="#PToC_229">VioReadCellStr</A></H3>
<P>
This function reads a character/attribute pair string from a specified
row and column position.
<P>
<H4><A NAME="Header_230" HREF="#PToC_230">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioReadCellStr(StrPntr, Length, Row, Col,
XfrCnt, CurMove)
VIO_CELL *StrPntr // Pointer to cell data area
// where data is returned
USHORT Length // Length of cell string to read
UCHAR Row // Row position of cell string
UCHAR Col // Column position of cell string
USHORT *XferCnt // Actual length of data
UCHAR CurMove // Cursor movement flag
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
E_END_OF_SCREEN // If attempt to move past
// end of screen.
</PRE>
<P>
<H4><A NAME="Header_231" HREF="#PToC_231">Comments</A></H4>
<P>
The upper left corner of the screen is represented by row-column
coordinates of 0,0.
<P>
If the user wants a cell string read at the current row and/or column
position, 0xFF should be sent for the row and/or column position value.
<P>
Defined values for CurMove are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h NO_CURSOR_MOVE
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h CURSOR_MOVE
</TD><TD><P>
</TD></TR></TABLE>
<P>
<P>
<H3><A NAME="Header_232" HREF="#PToC_232">VioReadChar</A></H3>
<P>
This function reads a character from a specified row and column
position.
<P>
<H4><A NAME="Header_233" HREF="#PToC_233">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioReadChar(Row, Col, Char, CurMove)
UCHAR Row // Row position of character
UCHAR Col // Column position of character
UCHAR *Char // Pointer to character read
UCHAR CurMove // Cursor movement flag
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
E_END_OF_SCREEN // If attempt to move past
// end of screen.
</PRE>
<P>
<H4><A NAME="Header_234" HREF="#PToC_234">Comments</A></H4>
<P>
The upper left corner of the screen is represented by row-column
coordinates of 0,0.
<P>
If the user wants a character read at the current row and/or
column position, 0xFF should be sent for the row and/or column
position value.
<P>
<P>
Defined values for CurMove are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h NO_CURSOR_MOVE
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h CURSOR_MOVE
</TD><TD><P>
</TD></TR></TABLE>
<P>
<P>
<H3><A NAME="Header_235" HREF="#PToC_235">VioReadCharStr</A></H3>
<P>
This function reads a character string from a specified row and column
position.
<P>
<H4><A NAME="Header_236" HREF="#PToC_236">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioReadCharStr(StrPntr, Length, Row, Col,
XfrCnt, CurMove)
UCHAR *StrPntr // Pointer to string data area
USHORT Length // Length of character string
UCHAR Row // Row position of string
UCHAR Col // Column position of string
USHORT *XfrCnt // Number of characters read
UCHAR CurMove // Cursor movement flag
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
E_END_OF_SCREEN // If attempt to move past
// end of screen.
</PRE>
<P>
<H4><A NAME="Header_237" HREF="#PToC_237">Comments</A></H4>
<P>
The upper left corner of the screen is represented by row-column
coordinates of 0,0.
<P>
If the user wants a character string read at the current row
and/or column
position, 0xFF should be sent for the row and/or column position value.
<P>
Defined values for CurMove are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h NO_CURSOR_MOVE
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h CURSOR_MOVE
</TD><TD><P>
</TD></TR></TABLE>
<P>
<P>
<H3><A NAME="Header_238" HREF="#PToC_238">VioSetCurPos</A></H3>
<P>
This function sets the current cursor position with the specified row
and column positions (zero-based row and column).
<P>
<H4><A NAME="Header_239" HREF="#PToC_239">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioSetCurPos(Row, Col)
UCHAR Row // Row position
UCHAR Col // Column position
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
</PRE>
<P>
<H4><A NAME="Header_240" HREF="#PToC_240">Comments</A></H4>
<P>
The upper left corner of the screen is represented by row-column
coordinates of 0,0.
<P>
<H3><A NAME="Header_241" HREF="#PToC_241">VioSetCurType</A></H3>
<P>
This function sets the current cursor type.
<P>
<H4><A NAME="Header_242" HREF="#PToC_242">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioSetCurType(Type)
UCHAR Type // Cursor type
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
</PRE>
<P>
<H4><A NAME="Header_243" HREF="#PToC_243">Comments</A></H4>
<P>
Defined values for Type are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h CURSOR_OFF
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h CURSOR_UNDERBAR
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>03h CURSOR_BLOCK
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>04h CURSOR_BLINK_BLOCK
</TD><TD><P>
</TD></TR></TABLE>
<P>
<P>
<H3><A NAME="Header_244" HREF="#PToC_244">VioWrtCellString</A></H3>
<P>
This function writes a string of character attribute pairs to a
specified cursor position.
<P>
<H4><A NAME="Header_245" HREF="#PToC_245">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioWrtCellStr(StrPntr, Length, Row, Col,
XfrCnt, CurMove)
VIO_CELL *StrPntr // Pointer to cell string
USHORT Length // Length of string to write
UCHAR Row // Row position of string
UCHAR Col // Column position of string
USHORT *XfrCnt // Pointer to number of cells
UCHAR CurMove // Cursor movement flag
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
E_END_OF_SCREEN // If attempt to move past
// end of screen.
</PRE>
<P>
<H4><A NAME="Header_246" HREF="#PToC_246">Comments</A></H4>
<P>
The upper left corner of the screen is represented by row-column
coordinates of 0,0.
<P>
If the user wants a string written at the current row
and/or column position,
0xFF should be sent for the row and/or column position value.
<P>
Defined values for CurMove are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h NO_CURSOR_MOVE
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h CURSOR_MOVE
</TD><TD><P>
</TD></TR></TABLE>
<P>
<H3><A NAME="Header_247" HREF="#PToC_247">VioWrtCharStr</A></H3>
<P>
This function writes a character-only string to a specified cursor
position, without attributes. The current attribute for the
cell is used.
<P>
<H4><A NAME="Header_248" HREF="#PToC_248">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioWrtCharStr(StrPntr, Length, Row, Col,
XfrCnt, CurMove)
UCHAR *StrPntr // Pointer to character string
USHORT Length // Length of string to write
UCHAR Row // Row position of string
UCHAR Col // Column position of string
USHORT *XfrCnt // Pointer to number of characters
UCHAR CurMove // Cursor movement flag
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
E_END_OF_SCREEN // If attempt to move past
// end of screen.
</PRE>
<P>
<H4><A NAME="Header_249" HREF="#PToC_249">Comments</A></H4>
<P>
The upper left corner of the screen is represented by row-column
coordinates of 0,0.
<P>
If the user wants a string written at the current row
and/or column position,
0xFF should be sent for the row and/or column position value.
<P>
Defined values for CurMove are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h NO_CURSOR_MOVE
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h CURSOR_MOVE
</TD><TD><P>
</TD></TR></TABLE>
<P>
<P>
<H3><A NAME="Header_250" HREF="#PToC_250">VioWrtCharStrAtt</A></H3>
<P>
This function writes a character string with a common attribute value
at a specified cursor position.
<P>
<H4><A NAME="Header_251" HREF="#PToC_251">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioWrtCharStrAtt(StrPntr, Length, Row, Col, Attr, XfrCnt, CurMove)
UCHAR *StrPntr // Pointer to string
USHORT Length // Length of string to write
UCHAR Row // Row position of string
UCHAR Col // Column position of string
UCHAR Attr // Attribute of string
USHORT *XfrCnt // Pointer to number of characters
UCHAR CurMove // Cursor movement flag
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
E_END_OF_SCREEN // If attempt to move past
// end of screen.
</PRE>
<P>
<H4><A NAME="Header_252" HREF="#PToC_252">Comments</A></H4>
<P>
The upper left corner of the screen is represented by row-column
coordinates of 0,0.
<P>
If the user wants a string written at the current row
and/or column position,
0xFF should be sent for the row and/or column position value.
<P>
Defined values for Attr are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD>00h NORMAL_VIDEO
</TD><TD>
</TD></TR><TR VALIGN=TOP><TD>01h REVERSE_VIDEO
</TD><TD>
</TD></TR><TR VALIGN=TOP><TD>02h UNDERBAR
</TD><TD>
</TD></TR><TR VALIGN=TOP><TD>04h BLINK
</TD><TD>
</TD></TR><TR VALIGN=TOP><TD>08h ALT_FONT
</TD><TD>
</TD></TR><TR VALIGN=TOP><TD>0Fh ATTR_MASK
</TD><TD>
</TD></TR></TABLE>
<P>Defined values for CurMove are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD>00h NO_CURSOR_MOVE
</TD><TD>
</TD></TR><TR VALIGN=TOP><TD>01h CURSOR_MOVE
</TD><TD>
</TD></TR></TABLE>
<P>
<P>
<H3><A NAME="Header_253" HREF="#PToC_253">VioWrtNCell</A></H3>
<P>
This function writes a character/attribute pair a specified number of
times at a specified cursor position.
<P>
<H4><A NAME="Header_254" HREF="#PToC_254">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioWrtNCell(Row, Col, Cell, RepCount,
XfrCnt, CurMove)
UCHAR Row // Row position of attribute
UCHAR Col // Column position of attribute
VIO_CELL Cell // Cell to be written
USHORT RepCount // Number of times to repeat
USHORT *XfrCnt // Pointer to number of attributes
UCHAR CurMove // Cursor movement flag
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
E_END_OF_SCREEN // If attempt to move past
// end of screen.
</PRE>
<P>
<H4><A NAME="Header_255" HREF="#PToC_255">Comments</A></H4>
<P>
If the user wants a cell written at the current row
and/or column position,
0xFF should be sent for the row and/or column position value.
<P>
Defined values for CurMove are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h NO_CURSOR_MOVE
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h CURSOR_MOVE
</TD><TD><P>
</TD></TR></TABLE>
<P>
<H3><A NAME="Header_256" HREF="#PToC_256">VioWrtNChar</A></H3>
<P>
This function writes a character a specified number of times at a
specified cursor position.
<P>
<H4><A NAME="Header_257" HREF="#PToC_257">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT VioWrtNChar(Row, Col, Char, RepCount, XfrCnt, CurMove)
UCHAR Row // Row position of character
UCHAR Col // Column position of character
UCHAR Cell // Character to be written
USHORT RepCount // Number of times to repeat
USHORT *XfrCnt // Pointer to number of characters
UCHAR CurMove // Cursor movement flag
Returns: E_OK // If no error occurred
E_PARAM // If parameter values invalid
E_END_OF_SCREEN // If attempt to move past
// end of screen.
</PRE>
<P>
<H4><A NAME="Header_258" HREF="#PToC_258">Comments</A></H4>
<P>
The upper left corner of the screen is represented by row-column
coordinates of 0,0.
<P>
If the user wants a character written at the current row
and/or column position,
0xFF should be sent for the row and/or column position value.
<P>
Defined values of CurMove are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h NO_CURSOR_MOVE
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h CURSOR_MOVE
</TD><TD><P>
</TD></TR></TABLE>
<HR>
<H2><A NAME="HDRGSPT" HREF="#PToC_259">Reference - General Support</A></H2>
<P>
<H3><A NAME="Header_260" HREF="#PToC_260">HitWatchdog</A></H3>
<P>
This function is provided only for compatibility with 7527 program.
It is defined in cfrapi24.h as:
<PRE>
#define HitWatchDog()
</PRE>
<P>so that the compiler will eliminate the call from the program.
<HR>
<H2><A NAME="HDRCPREF" HREF="#PToC_261">Reference - Communications Port</A></H2>
<P>
<H3><A NAME="Header_262" HREF="#PToC_262">ComGetParms</A></H3>
<P>
This function returns the communication parameters for the
RS-232C serial ports.
<P>
<H4><A NAME="Header_263" HREF="#PToC_263">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT ComGetParms(PortNum, ParmCom)
UCHAR PortNum // Port number
UCHAR *ParmCom // Returned comm parameters
Returns: E_OK // If no error occurred
E_PARAM // If invalid PortNum
</PRE>
<P>
<H4><A NAME="Header_264" HREF="#PToC_264">Comments</A></H4>
<P>
Defined values for PortNum are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h RS232
</TD><TD><P>
</TD></TR></TABLE>
<P>For defined values corresponding to the ParmCom return value,
(See<A HREF="#HDRCSETP">ComSetParms</A>) .
<P>
<H3><A NAME="Header_265" HREF="#PToC_265">ComGetProtocol</A></H3>
<P>
This function returns the values of the following options:
<DL COMPACT>
<DD>XON/XOFF support
<DD>Receive line turnaround character
<DD>Send line turnaround character
<DD>Receive data filter table.
</DL>
<P>
<H4><A NAME="Header_266" HREF="#PToC_266">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT ComGetProtocol(PortNum, ParmTbl)
UCHAR PortNum // Port number
proto_cfg **ParmTbl // Pointer to pointer with comm
// parameter table
Returns: E_OK // If no error occurred
E_PARAM // If invalid PortNum
</PRE>
<P>
<H4><A NAME="Header_267" HREF="#PToC_267">Comments</A></H4>
<P>The receive data filter table is the only valid table parameter
on the network port.
<P>Defined values for PortNum are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h RS232
</TD><TD><P>
</TD></TR></TABLE>
<P>The proto_cfg structure (declared in "cfrapi24.h")
defines the ParmTbl format.
<P>
<H3><A NAME="Header_268" HREF="#PToC_268">ComQuery</A></H3>
<P>
This function returns the POST completion code of the
communication subsystem in the output parameter.
<P>
<H4><A NAME="Header_269" HREF="#PToC_269">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT ComQuery(PostStatus)
UCHAR *PostStatus // Returned subsystem POST status
Returns: E_OK // If no error occurred (only
// value returned)
</PRE>
<P>
<H3><A NAME="Header_270" HREF="#PToC_270">ComQueryData</A></H3>
<P>This function returns the number of characters available to
be read from the serial port.
<P>
<H4><A NAME="Header_271" HREF="#PToC_271">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT ComQueryData(PortNum, IoDir, Space)
UCHAR PortNum // Port number
UCHAR IoDir // Transmit or receive buffer
USHORT *Space // Pointer to returned values
// Receive Count/Space used
// Transmit Count/Space free
Returns: E_OK // If no error occurred
E_PARAM // If invalid PortNum or IoDir
</PRE>
<P>
<H4><A NAME="Header_272" HREF="#PToC_272">Comments</A></H4>
<P>
Defined values for PortNum are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h RS232
</TD><TD><P>
</TD></TR></TABLE>
<P>
Defined values for IoDir are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h RECEIVE
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>01h TRANSMIT
</TD><TD><P>
</TD></TR></TABLE>
<P>
<H3><A NAME="Header_273" HREF="#PToC_273">ComRead</A></H3>
<P>
This function reads a block of data from the specified port
from the buffer initialized by <B>ComSetBuffer</B> (done by ETS) into
the user buffer area.
If the transfer count is less than or equal to 0, E_NO_DATA is returned.
<P>
<H4><A NAME="Header_274" HREF="#PToC_274">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT ComRead(PortNum, buflen, bufptr, xfercnt)
UCHAR PortNum // Port number
USHORT buflen // Receive buffer size
UCHAR *bufptr // Address of receive buffer
USHORT *xfercnt // Returned, number of bytes
// transferred
Returns: E_OK // If no error occurred
E_PARAM // If invalid PortNum
E_NO_DATA // If no data currently buffered
</PRE>
<P>
<H4><A NAME="Header_275" HREF="#PToC_275">Comments</A></H4>
<P>
Defined values for PortNum are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h RS232
</TD><TD><P>
</TD></TR></TABLE>
<P>
<H3><A NAME="Header_276" HREF="#PToC_276">ComSetMdmCtl</A></H3>
<P>
This function sets the data terminal ready (DTR) and ready to send
(RTS) modem control lines on the RS-232 port.
<P>
<H4><A NAME="Header_277" HREF="#PToC_277">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT ComSetMdmCtl(PortNum, MdmOut)
UCHAR PortNum // Port number
UCHAR MdmOut // DTR and RTS outputs to modem
Returns: E_OK // If no error occurred
E_PARAM // If PortNum not equal RS232
</PRE>
<P>
<H4><A NAME="Header_278" HREF="#PToC_278">Comments</A></H4>
<P>
Defined values for PortNum are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h RS232
</TD><TD><P>
</TD></TR></TABLE>
Defined values for MdmOut are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>80h MDM_DTR_LOW
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>02h MDM_RTS_LOW
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>82h Turn on both lines
</TD><TD><P>
</TD></TR><TR VALIGN=TOP><TD><P>00h Turn off both lines
</TD><TD><P>
</TD></TR></TABLE>
<P>
<H3><A NAME="HDRCSETP" HREF="#PToC_279">ComSetParms</A></H3>
<P>
This function sets the communication parameters for the
serial port.
With this function you can change
the baud rate, parity, stop bits and data bits.
<P>
<H4><A NAME="Header_280" HREF="#PToC_280">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT ComSetParms(PortNum, ParmCom)
UCHAR PortNum // Port number
UCHAR ParmCom // Parameter settings
Returns: E_OK // If no error occurred
E_PARAM // If invalid PortNum
</PRE>
<P>
<H4><A NAME="Header_281" HREF="#PToC_281">Comments</A></H4>
<P>
Defined values for PortNum are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD>00h
</TD><TD>RS232
</TD></TR></TABLE>
Defined values for ParmCom are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD>0E0h
</TD><TD>MSK_BAUD
</TD></TR><TR VALIGN=TOP><TD>00h
</TD><TD>BAUD_110
</TD></TR><TR VALIGN=TOP><TD>20h
</TD><TD>BAUD_150
</TD></TR><TR VALIGN=TOP><TD>40h
</TD><TD>BAUD_300
</TD></TR><TR VALIGN=TOP><TD>60h
</TD><TD>BAUD_1200,
</TD></TR><TR VALIGN=TOP><TD>0A0h
</TD><TD>BAUD_4800
</TD></TR><TR VALIGN=TOP><TD>0C0h
</TD><TD>BAUD_9600
</TD></TR><TR VALIGN=TOP><TD>0E0h
</TD><TD>BAUD_19200
</TD></TR><TR VALIGN=TOP><TD>18h
</TD><TD>MSK_PARITY
</TD></TR><TR VALIGN=TOP><TD>00h
</TD><TD>PARITY_NONE
</TD></TR><TR VALIGN=TOP><TD>08h
</TD><TD>PARITY_ODD
</TD></TR><TR VALIGN=TOP><TD>18h
</TD><TD>PARITY_EVEN.
</TD></TR><TR VALIGN=TOP><TD>04h
</TD><TD>MSK_STOPBITS
</TD></TR><TR VALIGN=TOP><TD>00h
</TD><TD>STOPBITS_1
</TD></TR><TR VALIGN=TOP><TD>04h
</TD><TD>STOPBITS_2
</TD></TR><TR VALIGN=TOP><TD>03h
</TD><TD>MSK_DATABITS
</TD></TR><TR VALIGN=TOP><TD>01h
</TD><TD>DATABITS_6
</TD></TR><TR VALIGN=TOP><TD>02h
</TD><TD>DATABITS_7
</TD></TR><TR VALIGN=TOP><TD>03h
</TD><TD>DATABITS_8
</TD></TR></TABLE>
These parameters may be bit-wise OR'ed together to form the complete
set of parameters:
<PRE>
rc = ComSetParms(RS232, BAUD_9600|PARITY_EVEN|DATABITS_7);
</PRE>
<P>
<H3><A NAME="Header_282" HREF="#PToC_282">ComWrite</A></H3>
<P>
This function sends data to the serial port.
If the driver does not have buffer space for all of the data,
none is transferred, and E_NO_DATA is returned, and the transfer count
is loaded with 0 or an error indicator.
<P>
<H4><A NAME="Header_283" HREF="#PToC_283">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT ComWrite(PortNum, buflen, bufptr, xfercnt)
UCHAR PortNum // Port number
USHORT buflen // Length of data in buffer
UCHAR *bufptr // Pointer to data buffer
USHORT *xfercnt // Pointer to returned number of
// bytes transferred.
Returns: E_OK // If no error occurred
E_PARAM // If invalid PortNum
E_NO_DATA // If no data transferred
</PRE>
<P>
<H4><A NAME="Header_284" HREF="#PToC_284">Comments</A></H4>
<P>
Defined values for PortNum are:
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P>00h RS232
</TD><TD><P>
</TD></TR></TABLE>
<HR>
<H2><A NAME="HDRTMRSPT" HREF="#PToC_285">Reference - Timer functions</A></H2>
<P>
<H3><A NAME="Header_286" HREF="#PToC_286">TimerSetAlarm</A></H3>
<P>
This function sets a user specified number of alarms to trigger at a
selected time. Triggering can consist of either simulating the start
of a function key transaction program or a CFR function. This function
will only initiate during terminal idle times.
<P>
<H4><A NAME="Header_287" HREF="#PToC_287">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT TimerSetAlarm(timerptr, count)
struct timer_alarms * timerptr // Pointer to alarm structures
USHORT count // Number of alarms in structure
Returns: E_OK // If no error occurred
E_PARAM // If parameters are incorrect
</PRE>
<P>
<H4><A NAME="Header_288" HREF="#PToC_288">Comments</A></H4>
<P>
When setting a timer alarm, an array of memory must be created using the
structure below. No field sizes or locations can be changed or skipped.
This structure is defined in CFRAPI24.H.
<P>
All timer alarms desired MUST be declared in the call to TimerSetAlarm.
To do this, put a subscript on the timer structure definition. For example, use
<PRE>
struct timer_alarms timers[5];
</PRE>
<P>
to create five copies of the timer_alarms structure. This memory must be
global so that is it not de-allocated when the CFR processing completes.
<P>
All times are in 24 hour format.
<P>
If 'keydef' is 0, then the CFR is called using the 'function' and 'parmstring'
defined in the structure. Otherwise 'keydef' should be in the range 1-121 for
one of the transaction programs to be called.
<P>
If used, the length of the 'parmstring' must be in the first two bytes of
the string. The length should not include those first 2 bytes (e.g. "02ZA").
<PRE>
struct timer_alarms
{
USHORT function;
UCHAR *parmstring;
UCHAR keydef;
UCHAR day;
USHORT hour;
USHORT minute;
USHORT second;
UCHAR reserved[6];
};
</PRE>
<P>Defined values for 'day' are:
<UL>
<P><LI>00h SUNDAY
<P><LI>01h MONDAY
<P><LI>02h TUESDAY
<P><LI>03h WEDNESDAY
<P><LI>04h THURSDAY
<P><LI>05h FRIDAY
<P><LI>06h SATURDAY
<P><LI>07h EVERYDAY
<P><LI>08h WEEKDAY
</UL>
<P>
<H4><A NAME="Header_289" HREF="#PToC_289">Example</A></H4>
<PRE>
#include "cfrapi24.h"
struct timer_alarms timers[1];
int far cdecl main(int funct, char far *params)
{
.
.
.
// Set up the timer structure to trigger CFR function
// 4 with the parameter string of 032093 on Monday through
// Friday at noon
timers[0].keydef = 0;
timers[0].function = 4;
timers[0].parmstring = "06032093";
timers[0].day = WEEKDAY;
timers[0].hour = 12;
timers[0].minute = 0;
timers[0].second = 0;
if (TimerSetAlarm(timers, 1) == E_OK)
{
// Alarm initialized and active
}
else
{
// Handle error
}
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_290" HREF="#PToC_290">TimerClearAlarm</A></H3>
<P>
This function clears all of the defined timer alarms set by the TimerSetAlarm
function.
<P>
<H4><A NAME="Header_291" HREF="#PToC_291">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT TimerClearAlarm()
Returns: E_OK // If no error occurred
// (only value returned)
</PRE>
<P>
<H3><A NAME="Header_292" HREF="#PToC_292">TimerSetInterval</A></H3>
<P>
This function sets a user specified number of alarms to trigger at selected
repeating intervals. Triggering can consist of either simulating the start
of a function key transaction program or a CFR function. This function
will only initiate during terminal idle times.
<P>
<H4><A NAME="Header_293" HREF="#PToC_293">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT TimerSetInterval(timerptr, count)
struct timer_intervals * timerptr // Pointer to alarm structures
USHORT count // Number of intervals in structure
Returns: E_OK // If no error occurred
E_PARAM // If parameters are incorrect
</PRE>
<P>
<H4><A NAME="Header_294" HREF="#PToC_294">Comments</A></H4>
<P>
When setting a timer alarm, an array of memory must be created using the
structure below. No field sizes or locations can be changed or skipped.
This structure is defined in CFRAPI24.H.
<P>
All timer intervals desired MUST be declared in the call to TimerSetInterval.
To do this, put a subscript on the timer structure definition. For example, use
<PRE>
struct timer_intervals timers[5];
</PRE>
<P>
to create five copies of the timer_intervals structure. This memory must be
global so that is it not de-allocated when the CFR processing completes.
<P>
The 'interval' is in 20ms increments (1/50th of a second). For example, to
set up an interval that is 5 minutes long use the value 300 seconds * 50 per
second = 15000. The maximum interval length is 65535 intervals / 50 per
second = 1310.7 seconds which is about 21 minutes and 50 seconds.
<P>
If 'keydef' is 0, then the CFR is called using the 'function' and 'parmstring'
defined in the structure. Otherwise 'keydef' should be in the range 1-121 for
one of the transaction programs to be called.
<P>
If used, the length of the 'parmstring' must be in the first two bytes of
the string. The length should not include those first 2 bytes (e.g. "02ZA").
<PRE>
struct timer_interval
{
USHORT function;
UCHAR *parmstring;
USHORT interval;
UCHAR keydef;
UCHAR reserved[3];
};
</PRE>
<P>
<H4><A NAME="Header_295" HREF="#PToC_295">Example</A></H4>
<PRE>
#include "cfrapi24.h"
struct timer_ timers[1];
int far cdecl main(int funct, char far *params)
{
.
.
.
// Set up the timer structure to trigger CFR function
// 4 with the parameter string of 032093 every minute
timers[0].keydef = 0;
timers[0].function = 4;
timers[0].parmstring = "06032093";
timers[0].interval = 60 * 50; // seconds * intervals per second
if (TimerSetInterval(timers, 1) == E_OK)
{
// Interval initialized and active
}
else
{
// Handle error
}
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_296" HREF="#PToC_296">TimerClearInterval</A></H3>
<P>
This function clears all of the defined timer intervals set by the
TimerSetInterval function.
<P>
<H4><A NAME="Header_297" HREF="#PToC_297">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT TimerClearInterval()
Returns: E_OK // If no error occurred
// (only value returned)
</PRE>
<HR>
<H1><A NAME="HDRAPICFR" HREF="#PToC_298">Application-level CFR APIs</A></H1>
This part contains a information on the application-level CFR API
(application program interfaces) that are available for
the <I>Extended Terminal Services</I> (ETS) program which can
be used from your Custom Function Routines (CFRs).
First, the functions are summarized in a compact form, and then detailed
reference material is presented.
<HR>
<H2><A NAME="Header_299" HREF="#PToC_299">Summary of Application-level CFR APIs</A></H2>
ETS supports the following APIs for interfacing with the
transaction programs and other files downloaded from the server:
<DL>
<DD><P>AliasTransID -- Changes the transaction identifier bytes on the
transaction currently being built. This allows compatibility with
an existing DCConnect export application when you want to have the
operator be able to start a transaction from a key or other event
other than what the export application expects.
<DD><P>CallKeyDef -- Transfers control to ETS, which then runs the desired
transaction program.
At the end of the transaction program, control returns to the CFR.
The transaction program cannot do a CFR call as part of its
procedure.
<DD><P>ClearUserVariable -- Clears the specified user variable or the
transaction buffer.
<DD><P>DataFile -- Returns a pointer to a named validation file,
and returns the file size
<DD><P>GetPowerState -- Used only in 7524 terminals to find out the
state of the battery.
<DD><P>GetTerminalAddress -- Obtains the address that the terminal is
using to communicate with the terminal server. This may be one of: a serial
address (A-Y, 0-6), RF network address (0-126) or and TCP/IP network IP
address and port number.
<DD><P>GetTerminalSettings -- Given a pointer to the TERM_SETTINGS structure,
returns it filled in with information about the terminal settings, including
the number of rows and columns for which the terminal is configured.
<DD><P>IdleManager -- Provided to maintain compatibility with 7526 and 7527
CFRs, which used this API to allow other system tasks to run.
Can be used as a convenient method to delay for a time period.
<DD><P>MaxMemory -- Returns the maximum memory available in the terminal
<DD><P>PntrFile0 -- Returns a pointer to ETS file 0
<DD><P>QueryTransactionCnt -- Returns number of buffered transactions
and amount of space available.
<DD><P>ReadUserVariable -- Copies the contents of a user variable
to a buffer used in the CFR.
<DD><P>SendTransaction -- Send the contents of the transaction
buffer to the terminal server.
<DD><P>TransactionMsg -- Turns the "Good Transaction" message on/off
<DD><P>Validation -- Validation with local or remote files
<DD><P>WaitEvent -- Allows the microprocessors to "sleep" in a low-power
state while the the terminal waits for operator input or a host command.
<DD><P>WriteToTrans -- Appends data to a transaction
<DD><P>WriteUserVariable -- Appends data to a user variable.
</DL>
<P>
ETS <I>does not</I> support the following CFR APIs which
are used on the 7526 or 7527:
<DL>
<DD><P>ProcBufferedHostCmds
<DD><P>ResizeFile
<DD><P>ShowClock
</DL>
<P>
Refer to <A HREF="#TBLCFRFAPI">Table 14</A> for a quick-reference table comparing
CFR functions and APIs available for ETS and IBM's 7526 and 7527 terminals.
<HR>
<H2><A NAME="Header_300" HREF="#PToC_300">Summary of Return Codes</A></H2>
<P>The following is a summary of the return codes
used by the Application-level CFR API functions:
<PRE>
<B>0 OK</B>
* Function call was successful.
<B>2 ABORT</B>
* Abort code returned by "IdleManager" and "CallKeyDef".
<B>3 RANGE_ERROR</B>
* Parameter out of range.
<B>4 FILE_NOT_FOUND</B>
* File name not downloaded.
<B>5 LENGTH_ERROR</B>
* String length + user variable length too long.
<B>6 CFR_TYPE_ERROR</B>
* CFR Type not allowed to make call.
<B>7 TRANS_IN_PROGRESS</B>
* Cannot call key definition if CFR called in a key definition.
<B>8 TERMINAL_OFFLINE</B>
* Terminal offline (out of service) status returned by "IdleManager" and "CallKeyDef".
<B>16 REMOTE_VAL_FAILED</B>
* Remote Validation failed.
<B>17 MEMORY_ERROR</B>
* Not enough memory in terminal to resize file to specified size.
</PRE>
<HR>
<H2><A NAME="Header_301" HREF="#PToC_301">Application-level CFR API Reference</A></H2>
<P>
<H3><A NAME="HDRATID" HREF="#PToC_302">AliasTransID</A></H3>
AliasTransID
<P>
<H4><A NAME="Header_303" HREF="#PToC_303">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // for defined values
int AliasTransID(NewId)
unsigned char NewId // New transaction ID (1-255)
</PRE>
<P>
<H4><A NAME="Header_304" HREF="#PToC_304">Description</A></H4>
<P>
This function sets the transaction ID for the current transaction
record. This may be used to give a transaction an alternative ID (or
alias) to allow it to be handled by applications that usually look
for specific transaction IDs.
<P>
<H4><A NAME="Header_305" HREF="#PToC_305">Parameters</A></H4>
<P>
NewID is the new transaction ID for the current transaction. Any
value from 1 to 255 is acceptable. 0 is not allowed.
<P>
<H4><A NAME="Header_306" HREF="#PToC_306">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>Command executed properly
</TD></TR><TR VALIGN=TOP><TD><P><TT>3 RANGE_ERROR
</TT></TD><TD><P>NewID is invalid
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_307" HREF="#PToC_307">Example</A></H4>
<PRE>
#include "cfrapi24.h"
int far cdecl main(int funct, char far *params)
{
unsigned char newid; // New transaction ID
.
.
.
// Change the current transaction ID to 24
newid = 24;
AliasTransID(newid);
.
.
.
}
</PRE>
<P>
<H3><A NAME="HDRCKD" HREF="#PToC_308">CallKeyDef</A></H3>
<P>
<H4><A NAME="Header_309" HREF="#PToC_309">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
int CallKeyDef( KeyDef )
int KeyDef // Port number
</PRE>
<P>
<H4><A NAME="Header_310" HREF="#PToC_310">Description</A></H4>
Executes key definition (transaction program assigned to an event, such
as a press of a key during idle mode).
The terminal must be in service and not have any other transaction program
already in progress.
<P>
This API does not automatically clear the DCT screen.
Situations that can clear the DCT screen are:
<UL COMPACT>
<LI>Error transaction
<LI>Buffer full message
<LI>Good transaction message
<LI>Waiting for host response message
</UL>
<P>CallKeyDef allows a <I>mode 2 CFR</I> to call a transaction program.
As a consequence, any "buffered" host commands are not executed.
They include commands that write to the terminal
display and the file initialization commands (most notably, "NB -
Initialize Specified Validation File").
<P>
<H4><A NAME="Header_311" HREF="#PToC_311">Parameters</A></H4>
<B>KeyDef</B> specifies the Key Definition program to execute (1-121).
<P>
<H4><A NAME="Header_312" HREF="#PToC_312">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>2 ABORT
</TT></TD><TD><P>Caused by operator timeout waiting for input, operator
hitting the CANCEL key, or transaction program having a syntax error.
The ABORT return code supersedes the OK or TERMINAL_OFFLINE
return codes.
</TD></TR><TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>If transaction program executed properly.
</TD></TR><TR VALIGN=TOP><TD><P><TT>3 RANGE_ERROR
</TT></TD><TD><P>If an invalid transaction program number is specified.
</TD></TR><TR VALIGN=TOP><TD><P><TT>7 TRANS_IN_PROGRESS
</TT></TD><TD><P>If a transaction program is already in progress and thus
could not execute another transaction program.
</TD></TR><TR VALIGN=TOP><TD><P><TT>8 TERMINAL_OFFLINE
</TT></TD><TD><P>If terminal offline (out of service), so the program could not be executed
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_313" HREF="#PToC_313">Example</A></H4>
<PRE>
#include "cfrapi24.h"
int far cdecl main(int Funct, char far *params)
{
int Key = 2; /* Key definition to execute */
int rc; /* CFR return code */
.
.
.
/*************************************************/
/* Executes transaction program defined for F2=B */
/*************************************************/
rc = CallKeyDef(Key);
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_314" HREF="#PToC_314">ClearUserVariable</A></H3>
<P>
<H4><A NAME="Header_315" HREF="#PToC_315">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
int ClearUserVariable ( UserVar )
int UserVar
</PRE>
<P>
<H4><A NAME="Header_316" HREF="#PToC_316">Description</A></H4>
Clears the requested user variable.
<P>
<H4><A NAME="Header_317" HREF="#PToC_317">Parameters</A></H4>
<B>UserVar</B> is the number of the user variable to clear.
Valid values are 1 through 99. You may also specify TRANS_BUFFER to
indicate that the transaction buffer is to be cleared instead. TRANS_BUFFER
is defined as -1 in CFRAPI24.H.
<P>
<H4><A NAME="Header_318" HREF="#PToC_318">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><TT>0 OK
</TT></TD><TD>Command operated properly
</TD></TR><TR VALIGN=TOP><TD><TT>3 RANGE_ERROR
</TT></TD><TD>If an invalid user variable is specified.
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_319" HREF="#PToC_319">Example</A></H4>
<PRE>
#include "cfrapi24.h"
int far cdecl main(int Funct, char far *params)
{
int UserVar = 2; /* user variable to append to */
int rc; /* CFR return code */
.
.
.
/****************************************/
/* Clears user variable 2 */
/****************************************/
rc = ClearUserVariable(UserVar);
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_320" HREF="#PToC_320">DataFile</A></H3>
<P>
<H4><A NAME="Header_321" HREF="#PToC_321">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
int DataFile( name, ptr, size )
char far * name
char far ** ptr
long far * size
</PRE>
<P>
<H4><A NAME="Header_322" HREF="#PToC_322">Description</A></H4>
Returns a pointer to a named validation file and the file's
size.
<P>
This function allows the CFR
to access any of the ETS validation data
files. The files are stored in contiguous blocks.
<P>
With this API, the CFR can treat the validation file as any type of file
it desires. For example, the "validation file" may not have validation
records in it at all, but rather it has tabular data for doing
price look-ups, list items in a bill of materials, or plain text delimited
with carriage return characters (which the CFR displays and scrolls around).
The data in the file may also represent a program which the terminal (via the
CFR) downloads to a bar code printer.
<P>
To access the file on the terminal, file 'e' must have a reference to
the name, or else ETS does not know about it.
For DCC/2 users, this means that you must have a dummy validation transaction
program in your .CFG. file.
<P>
<H4><A NAME="Header_323" HREF="#PToC_323">Parameters</A></H4>
<B>name</B> is the name of file (null-terminated string)
and is case sensitive.
<B>ptr</B> is the pointer to returned pointer to named file.
<B>size</B> is the returned size of named file
and is the allocated size of the file.
<P>
<H4><A NAME="Header_324" HREF="#PToC_324">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>4 FILE_NOT_FOUND
</TT></TD><TD><P>If no such file is loaded on the terminal
</TD></TR><TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>If command executed properly
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_325" HREF="#PToC_325">Example</A></H4>
<PRE>
#include "cfrapi24.h"
char * ValFilename = "AGES.VAL"; /* name of validation file */
int far cdecl main(int Funct, char far *params)
{
long filesize; /* returned size of named file */
char * fileptr; /* returned pointer to named file */
int rc; /* CFR return code */
unsigned int numWritten; /* pointer to number of characters */
.
.
.
/**************************************************/
/* Returns a pointer to AGES.VAL and the filesize */
/**************************************************/
rc = DataFile(ValFilename,&fileptr,&filesize);
/****************************************************/
/* Displays all records in AGES.VAL on the terminal */
/* starting at row 1 column 1 */
/****************************************************/
VioWrtCharStr(fileptr,filesize,0,0,&numWritten,0);
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_326" HREF="#PToC_326">GetPowerState</A></H3>
<P>
<H4><A NAME="Header_327" HREF="#PToC_327">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT GetPowerState (buffer)
PUCHAR buffer
</PRE>
<P>
<H4><A NAME="Header_328" HREF="#PToC_328">Description</A></H4>
This API is useful only on 7524 terminals; for all terminals running the
DCConnect Client, the first character of the buffer will always be set to a
null character.
<P>
For 7524 terminals, the first character of the buffer will be set to one
of the following values depending on the current state of the battery:
<UL>
<P><LI>80h POWER_LOWBATT
<P><LI>40h POWER_CHARGE
<P><LI>20h POWER_ERROR
<P><LI>10h POWER_LOW_WARN_1
<P><LI>08h POWER_LOW_WARN_2
<P><LI>04h POWER_LOW_WARN_3
<P><LI>02h POWER_BAD_TEMP
<P><LI>01h POWER_FULL_CHARGE
<P><LI>00h POWER_NORMAL
</UL>
<P>
<H4><A NAME="Header_329" HREF="#PToC_329">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>This is always returned
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_330" HREF="#PToC_330">Example</A></H4>
<PRE>
#include "cfrapi24.h"
#define UV_FOR_FOR_POWER_STATE 11
int far cdecl main(int Funct, char far *params)
{
char powerState;
char * powerStateString;
.
.
.
GetPowerState(&powerState);
switch (powerState)
{
case POWER_LOWBATT: powerStateString = "Low Battery"; break;
case POWER_CHARGE: powerStateString = "Charging"; break;
case POWER_FULL_CHARGE: powerStateString = "Fully Charged"; break;
.
.
.
default: powerStateString = "Unknown"; break;
}
ClearUserVariable(UV_FOR_POWER_STATE);
WriteUserVariable(UV_FOR_POWER_STATE, powerStateString);
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_331" HREF="#PToC_331">GetTerminalAddress</A></H3>
<P>
<H4><A NAME="Header_332" HREF="#PToC_332">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT GetTerminalAddress (buffer)
PUCHAR buffer
</PRE>
<P>
<H4><A NAME="Header_333" HREF="#PToC_333">Description</A></H4>
This API returns, in the buffer provided, the address of the terminal. This
works similar to the 7526 CFR API of the same name. The address that is put
into the buffer is a null-terminated string:
<UL>
<P><LI>For 7524 RF terminals, the string is one of "0" through "126"
<P><LI>For batch terminals, the string is one of "A" - "Y" or "0" - "6"
<P><LI>For terminals on a TCP/IP network the string is the form "1.2.3.4,7500"
where "1.2.3.4" is the IP address and ",7500" is the port number.
<P>
For terminal types using TCP stream sockets, the port number is not included.
<P>
Make sure the buffer provided is long enough to hold the longest possible
address (111.222.333.444,7500) which is 21 bytes including the trailing null.
</UL>
<P>
<H4><A NAME="Header_334" HREF="#PToC_334">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>This is always returned
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_335" HREF="#PToC_335">Example</A></H4>
<PRE>
#include "cfrapi24.h"
#define UV_FOR_ADDRESS 12
int far cdecl main(int Funct, char far *params)
{
char address[21];
.
.
.
GetTerminalAddress(address);
ClearUserVariable(UV_FOR_ADDRESS);
WriteUserVariable(UV_FOR_ADDRESS, address);
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_336" HREF="#PToC_336">GetTerminalSettings</A></H3>
<P>
<H4><A NAME="Header_337" HREF="#PToC_337">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
USHORT GetTerminalSettings(settings, which)
TERM_SETTINGS * settings
ULONG which
</PRE>
<P>
<H4><A NAME="Header_338" HREF="#PToC_338">Description</A></H4>
This API returns, in the structure provided, the settings of the terminal.
The parameter, <B>which</B>, determines which settings are filled in in
the structure.
<P>
This API is only available in versions 1.40Y and later.
<P>
One or more of the following values may be passed for the parameter,
<B>which</B>:
<UL>
<P><LI>SETTING_NUMROWS
<P><LI>SETTING_NUMCOLS
<P><LI>SETTING_ALL
</UL>
<P>
If more than one setting is needed, all values should be logically or'd
together (see the example below). To have all values filled in the
structure, just use SETTING_ALL. The use of the parameter, which, allows
new settings to be added to the structure without breaking existing code that
does not know about the new settings.
<P>
<H4><A NAME="Header_339" HREF="#PToC_339">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>This is always returned
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_340" HREF="#PToC_340">Example</A></H4>
<PRE>
#include "cfrapi24.h"
/*
* Global screen dimensions
*/
UCHAR numRows;
UCHAR numCols;
int far cdecl main(int Funct, char far *params)
{
TERM_SETTINGS termSettings;
.
.
.
GetTerminalSettings(&termSettings,
SETTING_NUMROWS | SETTING_NUMCOLS);
numRows = termSettings.numRows;
numCols = termSettings.numCols;
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_341" HREF="#PToC_341">IdleManager</A></H3>
<P>
<H4><A NAME="Header_342" HREF="#PToC_342">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
ushort IdleManager (Delay_time )
long Delay_time
</PRE>
<P>
<H4><A NAME="Header_343" HREF="#PToC_343">Description</A></H4>
Provided for compatibility with CFRs developed originally for the
7526 or 7527 DCT.
CFRs developed for the 7527 must have a numeric parameter added
to each call to meet the function prototype used with ETS.
<P>
IdleManager will delay for the time interval specified in the
single numeric parameter. The time period is specified as a number
of 5 millisecond periods. For example, to delay for 1 second,
specify a count of 1/.005 = 200.
<P><B>Note: </B>The time period is specified in a granularity of 5 milliseconds,
but the actual delay time is rounded to the nearest unit of 55 milliseconds.
Specifying a delay of 1 through 11 time periods will all yield a delay
of 55 milliseconds. A count of 12 will yield a delay of 110 milliseconds.
<P>
It is the explicit responsibility of the CFR to return control to ETS (end
the CFR) when the <B>IdleManager</B> returns ABORT or
TERMINAL_OFFLINE, as shown in the following code:
<PRE>
.
.
.
rc = IdleManager (1);
if ((rc == ABORT) || (rc == TERMINAL_OFFLINE))
return (ABORT);
</PRE>
<P>
<H4><A NAME="Header_344" HREF="#PToC_344">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>2 ABORT
</TT></TD><TD><P>Terminal operation aborted (error in terminal server command and so forth)
<P>If above occurs, the ABORT return code supersedes the OK or
TERMINAL_OFFLINE codes.
<P>This allows the CFR to test whether the terminal is in service without having
to use <B>CallKeyDef</B>.
</TD></TR><TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>Terminal is in service
</TD></TR><TR VALIGN=TOP><TD><P><TT>8 TERMINAL_OFFLINE
</TT></TD><TD><P>Terminal is offline (out of service)
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_345" HREF="#PToC_345">Example</A></H4>
<PRE>
#include "cfrapi24.h"
int far cdecl main(int Funct, char far *params)
{
long delayCount;
int rc;
delayCount = 200; // 1 second
.
.
.
/***********************************************/
/* Delay for 1 second */
/***********************************************/
rc = IdleManager (delayCount);
if ((rc == ABORT) || (rc == TERMINAL_OFFLINE))
return(ABORT);
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_346" HREF="#PToC_346">MaxMemory</A></H3>
<P>
<H4><A NAME="Header_347" HREF="#PToC_347">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
int MaxMemory ( size )
long far * size
</PRE>
<P>
<H4><A NAME="Header_348" HREF="#PToC_348">Description</A></H4>
Returns the amount of unassigned memory available in
the terminal.
<P>
This function allows the CFR
to determine the amount of memory remaining in the terminal.
<P>
<H4><A NAME="Header_349" HREF="#PToC_349">Parameter</A></H4>
<B>size</B> is the returned amount of memory in bytes.
<P>
<H4><A NAME="Header_350" HREF="#PToC_350">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>If command executed properly
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_351" HREF="#PToC_351">Example</A></H4>
<PRE>
#include "cfrapi24.h"
int far cdecl main(int Funct, char far *params)
{
long MemLeft; /* returned amount of memory */
int rc; /* CFR return code */
.
.
.
/*****************************************************************/
/* Returns amount of unassigned memory available in the terminal */
/*****************************************************************/
rc = MaxMemory(&MemLeft);
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_352" HREF="#PToC_352">PntrFile0</A></H3>
<P>
<H4><A NAME="Header_353" HREF="#PToC_353">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
char far * PntrFile0( void );
</PRE>
<P>
<H4><A NAME="Header_354" HREF="#PToC_354">Description</A></H4>
Returns pointer to ETS file 0.
<P>
File 0 contains various configuration parameters and all of the transaction
program operation codes.
For details of the file 0 format,
(See<A HREF="#HDRFIL0DSC">File 0--Terminal Operating Parameters/Program Storage</A>) .
<P>
This function provides a method for a CFR (in
Mode 1 or 2) to look up setup parameters in ETS file 0.
It returns a pointer to the start of the contiguous file, the writer
must use this pointer along with an appropriate
offset to access the parameters.
<P><B>Note: </B>Any
writes to file 0 record 0 data areas will not
necessarily take effect immediately.
ETS only checks these parameters at certain times. Writing to
this file should be handled with great care.
Most of the parameters in this record take effect only when ETS
is put out of service and then back in service.
<P>
<H4><A NAME="Header_355" HREF="#PToC_355">Return Value</A></H4>
Pointer to file 0, or NULL if file 0 not downloaded
<P>
<H4><A NAME="Header_356" HREF="#PToC_356">Example</A></H4>
<PRE>
#include "cfrapi24.h"
int far cdecl main(int Funct, char far *params)
{
char * File0; /* pointer to file 0 */
.
.
.
/*******************************/
/* Returns a pointer to file 0 */
/*******************************/
File0 = PntrFile0();
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_357" HREF="#PToC_357">QueryTransactionCnt</A></H3>
<P>
<H4><A NAME="Header_358" HREF="#PToC_358">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // for defined values
void QueryTransactionCnt(NumTxtns, NumFree)
unsigned short * NumTxtns // Ptr to return number buffered
unsigned short * NumFree // Ptr to return space free
</PRE>
<P>
<H4><A NAME="Header_359" HREF="#PToC_359">Description</A></H4>
<P>
This function returns to the caller the total number of transactions
that are currently in the transaction buffer as well as the number of
transactions that can still be added to the buffer before it is filled
up.
<P>
<H4><A NAME="Header_360" HREF="#PToC_360">Parameters</A></H4>
<P>
NumTxtns is a pointer to a variable in which will be returned the number
of currently buffered transactions.
<P>
NumFree is a pointer to a variable in which will be returned the number
of transactions that can still be added to the buffer before it fills up.
<P>
<H4><A NAME="Header_361" HREF="#PToC_361">Return Codes</A></H4>
<P>None
<P>
<H4><A NAME="Header_362" HREF="#PToC_362">Example</A></H4>
<PRE>
#include "cfrapi24.h"
int far cdecl main(int funct, char far *params)
{
unsigned short numtxtns;
unsigned short numfree;
.
.
.
// Ask for the current transaction counts
QueryTransactionCnt(&numtxtns, &numfree);
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_363" HREF="#PToC_363">ReadUserVariable</A></H3>
<P>
<H4><A NAME="Header_364" HREF="#PToC_364">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
int ReadUserVariable ( UserVar, buffer )
int UserVar
char far * buffer
</PRE>
<P>
<H4><A NAME="Header_365" HREF="#PToC_365">Description</A></H4>
Returns the contents of a specified user variable in
a buffer supplied by the caller. The returned data is null-terminated.
<P>
<H4><A NAME="Header_366" HREF="#PToC_366">Parameters</A></H4>
<B>UserVar</B> is the number of the user variable to copy
(Valid values are 0 through 99).
<P><B>buffer</B> is the buffer to copy contents of user
variable into. This buffer must be at least 129
bytes long to accommodate the maximum length of a user
variable plus the trailing null character.
<P>
<H4><A NAME="Header_367" HREF="#PToC_367">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>Command executed properly
</TD></TR><TR VALIGN=TOP><TD><P><TT>3 RANGE_ERROR
</TT></TD><TD><P>If invalid user variable number specified
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_368" HREF="#PToC_368">Example</A></H4>
<PRE>
#include "cfrapi24.h"
int far cdecl main(int Funct, char far *params)
{
int UserVar = 2; /* user var to copy contents of */
char UserVarData [129]; /* buffer to copy contents into */
int rc; /* CFR return code */
.
.
.
/********************************************************/
/* Returns contents of user variable 2 into UserVarData */
/********************************************************/
rc = ReadUserVariable(UserVar,UserVarData);
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_369" HREF="#PToC_369">ResizeFile</A></H3>
<P>
<H4><A NAME="Header_370" HREF="#PToC_370">Command</A></H4>
<PRE>
ResizeFile ( name, size )
</PRE>
This 7527 command is not supported by ETS.
<P>
<H3><A NAME="Header_371" HREF="#PToC_371">SendTransaction</A></H3>
<P>
<H4><A NAME="Header_372" HREF="#PToC_372">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // for defined values
int SendTransaction(void)
</PRE>
<P>
<H4><A NAME="Header_373" HREF="#PToC_373">Description</A></H4>
<P>
This function sends a transaction to the terminal server from a
CFR. The transaction consists of the data in the
transaction buffer, prefixed by the transaction header and
followed by the date/time stamp and sequence number.
<P>
In the buffered mode, this function returns when the transaction
has been written to file 9.
<P>
In the interactive mode, this function returns when the host
responds with CMD B or C.
<P>
In the interactive/buffered mode, this function returns when the
host responds with CMD B or C. If the host does not respond before the
host timeout occurs, the transaction is written to file 9.
<P>
If the CFR was entered with function 0 or 2, then AliasTransID must be
called to set a key ID for the generated transaction before calling
SendTransaction.
<P>
<H4><A NAME="Header_374" HREF="#PToC_374">Parameters</A></H4>
<P>None
<P>
<H4><A NAME="Header_375" HREF="#PToC_375">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>Command executed properly
</TD></TR><TR VALIGN=TOP><TD><P><TT>6 E_SPACE
</TT></TD><TD><P>Transaction buffer is full
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_376" HREF="#PToC_376">Example</A></H4>
<PRE>
#include "cfrapi24.h"
int far cdecl main(int funct, char far *params)
{
.
.
.
// Send the current transaction to the host
if (SendTransaction() == OK)
// Transaction sent
.
.
.
else
// Handle error
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_377" HREF="#PToC_377">TransactionMsg</A></H3>
<P>
<H4><A NAME="Header_378" HREF="#PToC_378">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
int TransactionMsg ( show )
int show
</PRE>
<P>
<H4><A NAME="Header_379" HREF="#PToC_379">Description</A></H4>
Enables/disables the "Good Transaction" message that
normally occurs after each transaction is submitted to the terminal server queue.
<P>
In some applications, eliminating the time required to display the
"Successful Transaction" message is desirable. This API will allow that
message to be selectively turned on and off.
<P>
This is a global flag and it lasts past the execution of the CFR or transaction
program.
<P>
<H4><A NAME="Header_380" HREF="#PToC_380">Parameter</A></H4>
Set show = 1 (TRANS_MSG) to enable the "Good Transaction" message.
Set show = 0 (NO_TRANS_MSG) to disable the "Good Transaction" message.
<P>
<H4><A NAME="Header_381" HREF="#PToC_381">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>Command executed properly
</TD></TR><TR VALIGN=TOP><TD><P><TT>3 RANGE_ERROR
</TT></TD><TD><P>If the show parameter is incorrect.
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_382" HREF="#PToC_382">Example</A></H4>
<PRE>
#include "cfrapi24.h"
int far cdecl main(int Funct, char far *params)
{
int rc; /* CFR return code */
.
.
.
/**************************************/
/* Disables "Good Transaction message */
/**************************************/
rc = TransactionMsg(NO_TRANS_MSG);
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_383" HREF="#PToC_383">Validation</A></H3>
<P>
<H4><A NAME="Header_384" HREF="#PToC_384">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
int Validation ( filename, type, data )
char far * filename
char type
char far * data
</PRE>
<P>
<H4><A NAME="Header_385" HREF="#PToC_385">Description</A></H4>
Performs validation of a data string against a validation file. If the
validation file is not resident on the temrinal, then ETS will send a
remote validation request to the terminal server.
<P>
This function provides a convenient way
to perform validation
against local or remote validation files. It
must be provided with the file name (a null-terminated string),
the type of
validation to be performed,
and a pointer to the data string to be validated.
Validation may be either "exclusive" or "inclusive". In
"exclusive"
validation, the test is considered to pass if the string did not match
any string in the validation file. For "inclusive" validation, the test
passes if the string matched an entry in the validation file.
<P>
Validation types '2' (exclusive) and
'3' (inclusive) always return to the calling
CFR but return the codes SKIP (on validation
fail) or NO_SKIP (on validation pass). SKIP
and NO_SKIP are defined in the CFR include file
"cfrapi24.h", as are validation type parameters.
<P>
If the file is located on the terminal, in order to access the file,
file 'e' must have a reference to the name, or else ETS does not
know about it.
For DCC/2 users, this means you must have a dummy validation transaction
program in your .CFG. file.
<P>
<H4><A NAME="Header_386" HREF="#PToC_386">Parameters</A></H4>
<B>filename</B> is the filename to perform validation of data
against (null terminated and case sensitive).
<P>
<B>type</B> is the type of validation to perform:
<UL>
<P><LI>EXCL_SKIP_IF_FAIL -- Exclusive
validation, skip if fail.
The function will always return.
The function will return SKIP if the
validation failed or NO_SKIP if the validation passed.
<P><LI>INCL_SKIP_IF_FAIL -- Inclusive
validation, skip if fail.
The function will always return. The function will
return SKIP if the validation failed or NO_SKIP if
the validation passed.
</UL>
<B>data</B> is the null-terminated string of data to
perform validation on.
<P>
<H4><A NAME="Header_387" HREF="#PToC_387">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>0 NO_SKIP (also defined as VAL_PASSED)
</TT></TD><TD><P>If the validation passed.
</TD></TR><TR VALIGN=TOP><TD><P><TT>3 RANGE_ERROR
</TT></TD><TD><P>If 'type' was not set to EXCL_SKIP_IF_FAIL
or INCL_SKIP_IF_FAIL
</TD></TR><TR VALIGN=TOP><TD><P><TT>4 FILE_NOT_FOUND
</TT></TD><TD><P>If the validation file was not found on the terminal,
the files
were loaded with the
<I>Extended Terminal Services</I>
method and the filename was not found in file 'e'
(extended validation support).
</TD></TR><TR VALIGN=TOP><TD><P><TT>16 REMOTE_VAL_FAILED
</TT></TD><TD><P>If the terminal server did not respond with a positive or
negative response within the timeout period.
</TD></TR><TR VALIGN=TOP><TD><P><TT>1 SKIP (also defined as VAL_FAILED)
</TT></TD><TD><P>If the validation failed.
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_388" HREF="#PToC_388">Example</A></H4>
<PRE>
#include "cfrapi24.h"
char * Data = "1234"; /* data to perform validation on */
char * ValFilename = "AGES.VAL"; /* name of validation file */
int far cdecl main(int Funct, char far *params)
{
.
.
.
/****************************************************/
/* Validates whether "1234" is included in AGES.VAL */
/****************************************************/
rc = Validation(ValFilename,INCL_SKIP_IF_FAIL,Data);
.
.
.
}
</PRE>
<P>
<H3><A NAME="HDRWTEVNT" HREF="#PToC_389">WaitEvent</A></H3>
<P>
<H4><A NAME="Header_390" HREF="#PToC_390">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
void WaitEvent ( time )
unsigned long time // Timeout value in milliseconds to
// wait for an event; use 0 to wait forever.
</PRE>
<P>
<H4><A NAME="Header_391" HREF="#PToC_391">Description</A></H4>
Places the terminal's processors in a low-power "sleep" state while awaiting
an input event. The input event may be from the operator pressing
a key or scanning a bar code, or an incoming command from the host computer.
<P>
WaitEvent is a blocking call which will return control to your
CFR after any of the following events occur:
<UL COMPACT>
<LI>The operator presses a key
<LI>The operator scans a bar code symbol
<LI>An ETS host command was received
(e.g. a Command I came in, setting a user variable for which you
have been waiting).
<LI>A character came in on the RS-232 aux. port
<LI>The time limit expired with no event received.
</UL>
<P>
When WaitEvent returns, you must use a CFR API to determine if the
event was indeed the event you were interested in. If you want to
wait further for another event or for the event of interest, then
you can call WaitEvent in a loop.
<P>The time specified will be rounded up to the nearest multiple
of 55 milliseconds, which is the granularity of the terminal clock tick
in most cases.
<P>
It is the explicit responsibility of the CFR to return control to ETS (end
the CFR) when the <B>WaitEvent</B> returns ABORT or
TERMINAL_OFFLINE, as shown in the following code:
<PRE>
.
.
.
rc = WaitEvent(30000);
if ((rc == ABORT) || (rc == TERMINAL_OFFLINE))
return (ABORT);
</PRE>
<P>
<H4><A NAME="Header_392" HREF="#PToC_392">Return Codes</A></H4>
<P>
<H4><A NAME="Header_393" HREF="#PToC_393">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>Terminal is in service
</TD></TR><TR VALIGN=TOP><TD><P><TT>8 TERMINAL_OFFLINE
</TT></TD><TD><P>Terminal is offline (out of service)
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_394" HREF="#PToC_394">Example</A></H4>
<PRE>
#include "cfrapi24.h"
int far cdecl main(int Funct, char far *params)
{
int rc;
long start_time, elapsed_time;
.
.
.
/************************************************/
/* Get operator input from board or scanner */
/* while being a good, power-conserving citizen */
/************************************************/
// Get current number of seconds since 1900
// (get_seconds() from CFRUTL24.LIB samples library)
start_time = get_seconds();
elapsed_time = 0L;
do
{
/* Wait for an input event for up to 30 secs */
/* Take into account elapsed time from previous*/
/* times through the loop */
rc = WaitEvent(30000L - (elapsed_time * 1000L));
if ((rc == ABORT) || (rc == TERMINAL_OFFLINE))
return (ABORT);
/* Some kind of input event occurred */
/* Determine if it was the event we were */
/* waiting for. */
/* If it was the keyboard, handle the key*/
if ( KbdReadAscii(&code) == E_OK )
{
my_kbd_handler();
return( CONTINUE);
}
/* If it was the scanner, handle the data*/
if ( SenRead(SenBuff, 100) == E_OK )
{
scanner_handler();
return( CONTINUE);
}
/* The event must have been a host command */
/* which we are not interested in. Keep */
/* looking for operator input */
}
while ( (elapsed_time = (get_seconds() - start_time)) < 30 );
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_395" HREF="#PToC_395">WriteToTrans</A></H3>
<P>
<H4><A NAME="Header_396" HREF="#PToC_396">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
int WriteToTrans ( data )
char far * data // Null-terminated string to send to
// the transaction buffer
</PRE>
<P>
<H4><A NAME="Header_397" HREF="#PToC_397">Description</A></H4>
Appends data to the current transaction.
<P>
For mode 1 CFRs The buffer will be sent to the terminal server at the normal
end point of the transaction program (only if automatic transaction building
is set on).
<P>
The CFR API SendTransaction() can also be used to send the transaction for
mode 1 or mode 2 CFRs.
<P>
<H4><A NAME="Header_398" HREF="#PToC_398">Parameter</A></H4>
<B>data</B> is the pointer to a null-terminated string of
data to be appended to the current transaction.
<P>
<H4><A NAME="Header_399" HREF="#PToC_399">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><TT>0 OK
</TT></TD><TD><P>Command executed properly
</TD></TR><TR VALIGN=TOP><TD><P><TT>5 LENGTH_ERROR
</TT></TD><TD><P>The data written would exceed the maximum allowed transaction size.
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_400" HREF="#PToC_400">Example</A></H4>
<PRE>
#include "cfrapi24.h"
char * Data = "testing"; /* Data to append to transaction */
int far cdecl main(int Funct, char far *params)
{
int rc; /* CFR return code */
.
.
.
/********************************************/
/* Appends "testing" to current transaction */
/********************************************/
rc = WriteToTrans(Data);
.
.
.
}
</PRE>
<P>
<H3><A NAME="Header_401" HREF="#PToC_401">WriteUserVariable</A></H3>
<P>
<H4><A NAME="Header_402" HREF="#PToC_402">C Format</A></H4>
<PRE>
#include "cfrapi24.h" // For defined values
int WriteUserVariable ( UserVar, data )
int UserVar
char far * data
</PRE>
<P>
<H4><A NAME="Header_403" HREF="#PToC_403">Description</A></H4>
Appends a null-terminated string to the requested user variable.
<P>
If the current length of the user variable plus the length
of the string to append will exceed 128 bytes, the function will not
be performed, and an error code will be returned.
<P>
This function appends to a user variable.
If desired, the variable may be cleared first using the CFR API
ClearUserVariable().
<P>
<H4><A NAME="Header_404" HREF="#PToC_404">Parameters</A></H4>
<B>UserVar</B> is the number of the user variable to which to
append the data. Valid values are 1 through 99.
<B>data</B> is the pointer to a null-terminated string to append to
the user variable.
<P>
<H4><A NAME="Header_405" HREF="#PToC_405">Return Codes</A></H4>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><TT>5 LENGTH_ERROR
</TT></TD><TD>If the append was not done because the result would
exceed 128 bytes.
</TD></TR><TR VALIGN=TOP><TD><TT>0 OK
</TT></TD><TD>Command operated properly
</TD></TR><TR VALIGN=TOP><TD><TT>3 RANGE_ERROR
</TT></TD><TD>If an invalid user variable is specified.
</TD></TR></TABLE>
<P>
<H4><A NAME="Header_406" HREF="#PToC_406">Example</A></H4>
<PRE>
#include "cfrapi24.h"
char * Data = "testing"; /* data to append to user variable */
int far cdecl main(int Funct, char far *params)
{
int UserVar = 2; /* user variable to append to */
int rc; /* CFR return code */
.
.
.
/****************************************/
/* Appends "testing" to user variable 2 */
/****************************************/
rc = WriteUserVariable(UserVar,Data);
.
.
.
}
</PRE>
<HR>
<H1><A NAME="HDRKEYALLW" HREF="#PToC_407">Command and Special Key Relationships</A></H1>
<P>This appendix contains information pertaining to
the relationships between various commands and special keys.
<P><A HREF="#TBLMEAN">Table 11</A> shows key commands, whether input
data is displayed on the DCT,
and the meanings of certain special keys when the indicated key
command is in effect.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
The key commands
listed in this table are described in <A HREF="#TBLKEYCMDS">Table 6</A>.
</td></tr></table>
<P>The columns within <A HREF="#TBLMEAN">Table 11</A> have the following
meanings:
<UL>
<P><LI><B>Key Command</B>
<P>Lists and briefly describes the indicated key command.
<P><LI><B>Input Data Displayed</B>
<P>Indicates whether the input in response to the command
is displayed on the terminal screen. Note that the table may indicate
<B>yes</B> for the display of input, even if the input is from a
magnetic device,
and the first byte is the <I>secure header</I> (a hex A). In this
case, the input will be shown as a series of asterisks (*) equal
to the length of the data.
<P><LI><B>Fill Key</B>
<P>Indicates the effect, if any, of pressing the Fill key
on the keyboard. <B>No</B> indicates that the key has no
effect. In some
input operations, pressing the Fill key before the completion of the
input will cause the field to be filled with leading zeroes or trailing
blanks out to the length specified.
<P><LI><B>Autofill</B>
<P>If the Enter key is pressed before
the full amount of input has been entered
in certain keyboard input operations,
the field will automatically
be filled to its maximum length.
The <B>Autofill</B>
column shows for which commands this action takes place.
<P><LI><B>Enter Key</B>
<P>Tells which input operations require the Enter key to
indicate that input is complete. The Enter key
is required for all
keyboard input operations and for sensor input using the
<B>;1</B> and <B>:4</B> commands
(which display input to the screen).
</UL>
<BR>
<P><B><A NAME="TBLMEAN">Table 11. Command and Special Key Relationships</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>Key Command
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=1%>Input Data
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>Fill Key
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>Autofill
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>Enter Key
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>:1</B> = Fixed badge
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>No
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>No
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>No
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>Not used
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>:2</B> = Fixed numeric keypad
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Yes
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>No
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>Leading zeroes
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>Required
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>:3</B> = Alphanumeric keypad (fixed)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Yes
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>Trailing blanks
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>Trailing blanks
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>Required
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>:4</B> = Fixed badge or alphanumeric keypad
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>
<P>Keypad--yes
<P>Sensor--yes
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<P>Keypad--trailing blanks
<P>Sensor--no
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<P>Keypad--no
<P>Sensor--no
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<P>Keypad--required
<P>Sensor--required
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>;1</B> = Variable badge
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>Optional; depends on command format
(see <B>d</B> parameter in key command <B>;1 lld0</B>
in <A HREF="#TBLKEYCMDS">Table 6</A>)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>No
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>Trailing blanks
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>Optional; depends on command format
(see <B>d</B> parameter in key command <B>;1 lld0</B>
in <A HREF="#TBLKEYCMDS">Table 6</A>)
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>:R</B> = General purpose read
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=1%>
<P>Echo = on
<DL COMPACT>
<DD>KA--yes
<DD>KN--yes
<DD>Sensor--yes
<DD>RS232--no
</DL>
<P>Echo = off
<DL COMPACT>
<DD>KA--no
<DD>KN--no
<DD>Sensor--no
<DD>RS232--no
</DL>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<P>Variable--no
<P>Fixed
<DL>
<DD><P>KA--trailing blanks
<DD><P>KN--leading zeroes
<DD><P>Sensor--no
<DD><P>RS232--no
</DL>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<P>Variable--no
<P>Fixed
<DL>
<DD><P>KA¹--trailing blanks
<DD><P>KN¹--leading zeroes
<DD><P>Sensor--no
<DD><P>RS232--no
</DL>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<P>KA--required
<P>KN--required
<P>Sensor--not used
<P>RS232--not used
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP COLSPAN=5><B>Note: </B>
KA = Alphabetic keypad, PF key, or touch screen region
KN = Numeric keypad, PF key, or touch screen region
¹ = No need to press the Fill key before pressing Enter
</TD></TR></TABLE>
<HR>
<H1><A NAME="HDRCRLC" HREF="#PToC_408">Comparison of ETS, 7526, 7527 Command Capabilities</A></H1>
The following tables compare the transaction programming command, host
command, and CFR function and API capabilities of the ETS (both 7524 ETS flash
and DCConnect Client), 7526, and 7527.
<BR>
<P><B><A NAME="TBLKEYDEF">Table 12. Key definitions</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>Commands
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>ETS
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>7526
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>7527
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>Original 7494-ELF Commands</B>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:0 Display message
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:1 Read badge
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:2 Keyboard input, numeric
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:3 Keyboard input, alpha-num
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:4 Keyboard or badge input
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:8 Link
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:9 Key not used (NOP)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>;0 Hot key
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>;1 Variable badge/stripe read
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>;2 Latching function
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>String commands</B>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:F Append
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:H Clear
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:J Format
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>;7 Append string to user variable
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>Display commands</B>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:E Write
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:T Clear
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:U Set cursor
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:6 Write to display in CMD D
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>DIDO commands</B>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:M DI read
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:N DI wait
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:P DO write
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>General Purpose I/O</B>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:R Read
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:W Write
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>Flow Control</B>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:D Delay
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:G GoTo
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:GS GoSub
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:Z On key goto
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:ZS On key gosub
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>;R Return from subroutine
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:L Label for branching to
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:Q Quit transaction send current data
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>;M Execute CFR
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B>Miscellaneous commands</B>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:5 Comment
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:A Auto transaction state
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:I Transaction buffer mode
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:K Validate
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:S Set UV character shift offset
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>:X,:Y Screen editing markers
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>;A Alias transaction ID
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>;C Set LED
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>;N Test user variable (UV)
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>;O Save/restore cursor to/from UV
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR></TABLE>
<BR>
<P><B><A NAME="TBLHOSTCOM">Table 13. Host Commands</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>Commands
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>ETS
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>7526
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>7527
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>0 Reset terminal
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>1 Transmit terminal status
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>2 Write to terminal display
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>3 Transmit BIOS version
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>4 Set terminal TOD
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>5 Audible tone
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>6 Transmit terminal features
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>7 Transmit TOD to host
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>8 Specify polled buffer
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>9A Send file status
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>9B Initialize text file
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>9C Load text file
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>9F Transmit file contents
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>9G Erase files
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>A On/Off line
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>AnX Terminal allowed/not allowed to send transactions
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>B Positive host acknowledge
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>C Negative host acknowledge
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>D Download transaction
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>F Storage query
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>G Test event handler
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>I Set user variable
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>IM Set multiple user variables
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>K Transaction release
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>L Loopback test
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>MA Send CFR status
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>MB Allocate CFR file
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>MC Load CFR file
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>MD Start CFR
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>NA Send validation file status
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>NB Initialize validation file
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>NC Load validation file
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ND Signal validation file load complete
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>O Write to terminal display with attributes
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>Q Read User Variable
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>V Remote validation response
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR></TABLE>
<BR>
<P><B><A NAME="TBLCFRFAPI">Table 14. CFR Functions/APIs</A></B><BR>
<TABLE BORDER>
<TR>
<TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>Function/API
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>ETS
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>7526
</TH><TH ALIGN=LEFT VALIGN=TOP WIDTH=25%>7527
</TH></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B><I>CFR Functions</I></B>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComGetAppVector
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComGetIntVector
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComGetMdmCtl
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComGetNetPort
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComGetParms
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComGetProtocol
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComQuery
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComQueryData
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComRead
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComReqDownload
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComSetAppVector
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComSetBuffer
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComSetIntVector
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComSetMdmCtl
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComSetNetPort
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComSetParms
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComSetProtocol
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComTapRdy
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComTapRead
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComTapWrite
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ComWrite
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>DidoQuery
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>DidoRead
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>DidoSet
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>DidoWrite
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdGetShift
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdHandleArrowKeys
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdQueryData
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdQueryPost
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdReadAscii
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdReadAsciiRec
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdReadMakeBreak
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdReadMakeBreakRec
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdReadScan
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdReadScanRec
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdSetBuffer
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdSetEcho
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdSetKeyTables
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdSetShift
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdWaitAsciiRec
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdWaitMakeBreakRec
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdWaitScanRec
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>KbdSetMode
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>MemAlloc
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>MemFree
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>MemQuery
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PrtChar
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PrtInit
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PrtQuery
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PrtQueryData
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PrtSetBuffer
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PrtSetStatus
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PrtStr
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>RtcGetAsciiDate
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>RtcGetAsciiTime
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>RtcGetDate
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>RtcGetFormat
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>RtcGetTime
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>RtcSetDate
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>RtcSetFormat
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>RtcSetTime
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SenActLed
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SenQuery
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SenQueryData
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SenRead
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SenSet
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SenSetBuffer
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SenSetDiscrimGroup
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SenSetGlobalParams
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SenSetVector
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SpkBeep
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SpkQuery
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TchQuery
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TchQueryData
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TchRead
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TchSet
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TmrClearAlarm
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TmrClearAlarmAsynch
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TmrClearInterval
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TmrCountRead
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TmrCountWrite
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TmrGetInt
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TmrRead
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TmrSetAlarm
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TmrSetAlarmAsynch
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TmrSetInt
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TmrSetInterval
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioClear
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioGetCurPos
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioQuery
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioReadCell
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioReadCellStr
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioReadChar
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioReadCharStr
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioRestoreCurPos
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioRestoreCurType
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioSaveCurPos
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioSaveCurType
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioSelCharSet
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioSelMode
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioSetFont
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioSetCurPos
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioSetCurType
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioWrtCellStr
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioWrtCharStr
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioWrtCharStrAtt
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioWrtNatt
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioWrtNCell
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioWrtNChar
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>VioWrtPixel
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>LockQuery
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>LockSet
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>NmiCritSectEnter
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>NmiCritSectExit
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>NmiGetAppVect
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>NmiSetAppVect
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PftReset
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PftQueryReset
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PftQueryPost
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PftSetAppRestartEntry
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PftSetExcHandler
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PftStatus
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>HitWatchdog
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><B><I>CFR APIs</I></B>
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>AliasTransID
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>CallKeyDef
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ClearUserVariable
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>DataFile
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>GetPowerState
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>GetTermAddress
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>IdleManager
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<B> Note:</B> ETS and 7526 require time delay parameter.
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%><BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>MaxMemory
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>PntrFile0
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ProcBufferedHostCmds
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>QueryTransactionCnt
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ReadUserVariable
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ResizeFile
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>SendTransaction
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>ShowClock
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>TransactionMsg
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>Validation
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>WaitEvent
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>WriteToTrans
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>WriteUserVariable
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>X
</TD></TR><TR>
<TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=25%>
<BR></TD></TR></TABLE>
<HR>
<H1><A NAME="HDRGLO" HREF="#PToC_409">Terms and Abbreviations</A></H1>
<TABLE CELLPADDING=3>
<TR VALIGN=TOP><TD><P><B>ACK
</B></TD><TD><P>positive acknowledgement
</TD></TR><TR VALIGN=TOP><TD><P><B>ACS
</B></TD><TD><P>application control structure
</TD></TR><TR VALIGN=TOP><TD><P><B>ADDR
</B></TD><TD><P>address
</TD></TR><TR VALIGN=TOP><TD><P><B>APA
</B></TD><TD><P>all points addressable
</TD></TR><TR VALIGN=TOP><TD><P><B>API
</B></TD><TD><P>application program interface
</TD></TR><TR VALIGN=TOP><TD><P><B>ASCII
</B></TD><TD><P>American Standard Code for Information Interchange
</TD></TR><TR VALIGN=TOP><TD><P><B>bps
</B></TD><TD><P>bits per second
</TD></TR><TR VALIGN=TOP><TD><P><B>CCF
</B></TD><TD><P>cold cathode fluorescent
</TD></TR><TR VALIGN=TOP><TD><P><B>CD
</B></TD><TD><P>customer diagnostics
</TD></TR><TR VALIGN=TOP><TD><P><B>CFR
</B></TD><TD><P>custom function routine
</TD></TR><TR VALIGN=TOP><TD><P><B>CMD
</B></TD><TD><P>command
</TD></TR><TR VALIGN=TOP><TD><P><B>comm
</B></TD><TD><P>communication
</TD></TR><TR VALIGN=TOP><TD><P><B>Co-Proc
</B></TD><TD><P>Co-Processor
</TD></TR><TR VALIGN=TOP><TD><P><B>CRC
</B></TD><TD><P>cyclical redundancy check
</TD></TR><TR VALIGN=TOP><TD><P><B>CS1
</B></TD><TD><P>check sum sequence, first byte
</TD></TR><TR VALIGN=TOP><TD><P><B>CS2
</B></TD><TD><P>check sum sequence, second byte
</TD></TR><TR VALIGN=TOP><TD><P><B>CTS
</B></TD><TD><P>clear to send; an RS-232-C control line
</TD></TR><TR VALIGN=TOP><TD><P><B>CRU
</B></TD><TD><P>customer-replaceable unit
</TD></TR><TR VALIGN=TOP><TD><P><B>DC1
</B></TD><TD><P>data download request
</TD></TR><TR VALIGN=TOP><TD><P><B>DC2
</B></TD><TD><P>full download request / terminal is alive
</TD></TR><TR VALIGN=TOP><TD><P><B>DC3
</B></TD><TD><P>Terminal has no transactions and doesn't need a download
</TD></TR><TR VALIGN=TOP><TD><P><B>DCD
</B></TD><TD><P>data carrier detect; an RS-232-C control line
</TD></TR><TR VALIGN=TOP><TD><P><B>DCT
</B></TD><TD><P>Data Collection Terminal
</TD></TR><TR VALIGN=TOP><TD><P><B>DI-DO
</B></TD><TD><P>digital input/digital output
</TD></TR><TR VALIGN=TOP><TD><P><B>DMA
</B></TD><TD><P>direct memory access
</TD></TR><TR VALIGN=TOP><TD><P><B>DSR
</B></TD><TD><P>data set ready; an RS-232-C control line
</TD></TR><TR VALIGN=TOP><TD><P><B>DTR
</B></TD><TD><P>data terminal ready; an RS-232-C control line
</TD></TR><TR VALIGN=TOP><TD><P><B>DMAU
</B></TD><TD><P>direct memory access unit
</TD></TR><TR VALIGN=TOP><TD><P><B>EAN
</B></TD><TD><P>European article numbering
</TD></TR><TR VALIGN=TOP><TD><P><B>EGA
</B></TD><TD><P>enhanced graphics adapter
</TD></TR><TR VALIGN=TOP><TD><P><B>EBCDIC
</B></TD><TD><P>Extended Binary Coded Decimal Interchange Code
</TD></TR><TR VALIGN=TOP><TD><P><B>ELF
</B></TD><TD><P>entry level function
</TD></TR><TR VALIGN=TOP><TD><P><B>ESC
</B></TD><TD><P>ASCII escape character
</TD></TR><TR VALIGN=TOP><TD><P><B>ETX
</B></TD><TD><P>ASCII end-of-text character
</TD></TR><TR VALIGN=TOP><TD><P><B>EZNL
</B></TD><TD><P>4-byte PSP identifier
</TD></TR><TR VALIGN=TOP><TD><P><B>FDX
</B></TD><TD><P>duplex flow
</TD></TR><TR VALIGN=TOP><TD><P><B>FRU
</B></TD><TD><P>field-replaceable unit
</TD></TR><TR VALIGN=TOP><TD><P><B>FSM
</B></TD><TD><P>finite state machine
</TD></TR><TR VALIGN=TOP><TD><P><B>h
</B></TD><TD><P>Hexadecimal notation
</TD></TR><TR VALIGN=TOP><TD><P><B>HDX
</B></TD><TD><P>half-duplex
</TD></TR><TR VALIGN=TOP><TD><P><B>HI
</B></TD><TD><P>host interface application
</TD></TR><TR VALIGN=TOP><TD><P><B>Hz
</B></TD><TD><P>Hertz
</TD></TR><TR VALIGN=TOP><TD><P><B>ICU
</B></TD><TD><P>interrupt control unit
</TD></TR><TR VALIGN=TOP><TD><P><B>INT
</B></TD><TD><P>interrupt
</TD></TR><TR VALIGN=TOP><TD><P><B>I/O
</B></TD><TD><P>input/output
</TD></TR><TR VALIGN=TOP><TD><P><B>IPL
</B></TD><TD><P>initial program loading
</TD></TR><TR VALIGN=TOP><TD><P><B>ISR
</B></TD><TD><P>interrupt service routine
</TD></TR><TR VALIGN=TOP><TD><P><B>IRET
</B></TD><TD><P>return from interrupt routine
</TD></TR><TR VALIGN=TOP><TD><P><B>IRQ
</B></TD><TD><P>interrupt request
</TD></TR><TR VALIGN=TOP><TD><P><B>ISR
</B></TD><TD><P>interrupt service routine
</TD></TR><TR VALIGN=TOP><TD><P><B>kb
</B></TD><TD><P>times 1000 bytes
</TD></TR><TR VALIGN=TOP><TD><P><B>KB
</B></TD><TD><P>times 1024 bytes
</TD></TR><TR VALIGN=TOP><TD><P><B>KB
</B></TD><TD><P>times 1024 bytes
</TD></TR><TR VALIGN=TOP><TD><P><B>Kbd
</B></TD><TD><P>keyboard
</TD></TR><TR VALIGN=TOP><TD><P><B>Kbps
</B></TD><TD><P>thousand bits per second
</TD></TR><TR VALIGN=TOP><TD><P><B>LCD
</B></TD><TD><P>liquid crystal display
</TD></TR><TR VALIGN=TOP><TD><P><B>LED
</B></TD><TD><P>light emitting diode
</TD></TR><TR VALIGN=TOP><TD><P><B>LTS
</B></TD><TD><P>line turnaround sequence
</TD></TR><TR VALIGN=TOP><TD><P><B>load module
</B></TD><TD><P>Data Collection Terminal software loadable from a host
system
</TD></TR><TR VALIGN=TOP><TD><P><B>mA
</B></TD><TD><P>milliampere(s)
</TD></TR><TR VALIGN=TOP><TD><P><B>mem
</B></TD><TD><P>memory
</TD></TR><TR VALIGN=TOP><TD><P><B>misc
</B></TD><TD><P>miscellaneous
</TD></TR><TR VALIGN=TOP><TD><P><B>mod
</B></TD><TD><P>modulo
</TD></TR><TR VALIGN=TOP><TD><P><B>msec
</B></TD><TD><P>millisecond(s)
</TD></TR><TR VALIGN=TOP><TD><P><B>mV
</B></TD><TD><P>millivolt(s)
</TD></TR><TR VALIGN=TOP><TD><P><B>NAK
</B></TD><TD><P>negative acknowledgement
</TD></TR><TR VALIGN=TOP><TD><P><B>N/A
</B></TD><TD><P>not applicable
</TD></TR><TR VALIGN=TOP><TD><P><B>NMI
</B></TD><TD><P>non-maskable interrupt
</TD></TR><TR VALIGN=TOP><TD><P><B>OS
</B></TD><TD><P>operating system
</TD></TR><TR VALIGN=TOP><TD><P><B>pixel
</B></TD><TD><P>picture element
</TD></TR><TR VALIGN=TOP><TD><P><B>POST
</B></TD><TD><P>power-on self test
</TD></TR><TR VALIGN=TOP><TD><P><B>prt
</B></TD><TD><P>printer
</TD></TR><TR VALIGN=TOP><TD><P><B>PSP
</B></TD><TD><P>program segment prefix
</TD></TR><TR VALIGN=TOP><TD><P><B>RAM
</B></TD><TD><P>random access memory
</TD></TR><TR VALIGN=TOP><TD><P><B>RET
</B></TD><TD><P>return from routine
</TD></TR><TR VALIGN=TOP><TD><P><B>ROM
</B></TD><TD><P>read-only memory
</TD></TR><TR VALIGN=TOP><TD><P><B>RS
</B></TD><TD><P>record separator
</TD></TR><TR VALIGN=TOP><TD><P><B>RSP
</B></TD><TD><P>response
</TD></TR><TR VALIGN=TOP><TD><P><B>RTC
</B></TD><TD><P>real-time clock
</TD></TR><TR VALIGN=TOP><TD><P><B>RTS
</B></TD><TD><P>ready to send; an RS-232-C control line
</TD></TR><TR VALIGN=TOP><TD><P><B>SCC
</B></TD><TD><P>serial communications controller
</TD></TR><TR VALIGN=TOP><TD><P><B>SCU
</B></TD><TD><P>serial control unit
</TD></TR><TR VALIGN=TOP><TD><P><B>sen
</B></TD><TD><P>sensor
</TD></TR><TR VALIGN=TOP><TD><P><B>spk
</B></TD><TD><P>speaker
</TD></TR><TR VALIGN=TOP><TD><P><B>STX
</B></TD><TD><P>ASCII start-of-text character
</TD></TR><TR VALIGN=TOP><TD><P><B>S/W
</B></TD><TD><P>software
</TD></TR><TR VALIGN=TOP><TD><P><B>TAP
</B></TD><TD><P>terminal application program
</TD></TR><TR VALIGN=TOP><TD><P><B>tch
</B></TD><TD><P>touch screen
</TD></TR><TR VALIGN=TOP><TD><P><B>TCU
</B></TD><TD><P>time control unit
</TD></TR><TR VALIGN=TOP><TD><P><B>tmr
</B></TD><TD><P>timer
</TD></TR><TR VALIGN=TOP><TD><P><B>TOD
</B></TD><TD><P>time-of-day
</TD></TR><TR VALIGN=TOP><TD><P><B>TTL
</B></TD><TD><P>transistor-transistor logic
</TD></TR><TR VALIGN=TOP><TD><P><B>UPC
</B></TD><TD><P>Universal Product Code
</TD></TR><TR VALIGN=TOP><TD><P><B>USD
</B></TD><TD><P>Uniform Symbol Description
</TD></TR><TR VALIGN=TOP><TD><P><B>Vio
</B></TD><TD><P>video
</TD></TR></TABLE>
<A NAME="SPTGLOSREF"><I>(Ref #5.)</I></A>
<P>This glossary contains definitions for special terms as they are
used in the context of this document.
<DL>
<P><DT><FONT SIZE=+2><STRONG>B
</STRONG></FONT><P><P><DT>bar code reader
<DD>A data entry device which reads data encoded on bar code labels.
The reader may be either a slot reader or wand (scanner-type)
reader, and operates by scanning the label with either a visible
light source or an infrared light source.
<P><DT>buffered mode
<DD>One of three modes in which the system may be operated. Specifies how
the terminal server interacts with the data collection terminals.
In this mode, transactions can be temporarily stored in the
data collection terminal until they are sent to terminal server.
This operational mode allows data to be entered into the system quickly,
with minimum interaction between the terminal
server and the data collection terminals. (See also <B>interactive
mode</B>, <B>interactive/buffered mode</B>,
and <B>multi-transaction buffer.</B>)
<P><DT><FONT SIZE=+2><STRONG>C
</STRONG></FONT><P><P><DT>communications adapter
<DD>An RS-422/485 communications card installed in the terminal
server which provides one method for connecting the data collection
terminals to the terminal server.
<P><DT><FONT SIZE=+2><STRONG>D
</STRONG></FONT><P><P><DT>data collection system
<DD>A system used to collect, store and process data and, optionally,
to transmit the collected data to a host computer system for additional
processing. The IBM DCConnect software base, with its required hardware
components, form one such system.
<P><DT>data collection terminal (DCT)
<DD>A specialized data-entry terminal that allows the entry of data via
its keyboard or bar code reader. For example, the 7524 terminal contains
a radio frequency data transceiver to link it to RF base stations.
This terminal includes a keyboard, microprocessor, random-access memory
(RAM), Liquid Crystal Display (LCD),
and input ports for additional data entry devices.
The data-entry terminal is controlled by a program which runs on its
microprocessor.
Several DCTs are available to users; however, only the 7524 DCT
may be used with the <I>7524 ETS flash</I> program.
<P><DT>Data Collector
<DD>The original DOS Data Collection Edition control program which runs on an IBM personal
or industrial
computer serving as the terminal server for the data collection system.
This program performs data collection activities and provides the
menus used for system management and control.
<P><DT>data entry method
<DD>The data entry method, normal or fast-clocking, affects how users
interact with data collection terminals. With the normal data entry
method, users must press a key on the data collection terminal or
place a badge in a badge reader
to initiate an entry.
With the fast-clocking method, the terminal is always ready for
multiple data entries.
<P><DT>data entry sequence
<DD>A specific set of steps that must be followed to enter data into a
data collection terminal. Used with normal data entry or fast-clocking
data entry.
A typical data entry sequence consists of a series of prompts and related
actions displayed at a data collection terminal. The prompts guide the
user through the actions required to complete a transaction. A data
entry sequence can be defined through the IBM Data Collection Connection program menus
and may be applied to all the data collection terminals, a specific
group of terminals, or a single terminal.
(See also <B>fast-clocking data entry</B>
and <B>normal data entry</B>.)
<P><DT>data retention
<DD>The capability of data collection terminals to maintain
the contents of the terminal's memory (RAM), including both data
and operating instructions during a power outage.
The memory on each data collection terminal has either a capacitive or
battery backup circuit. The number of hours of backup capability
is 48 hours for IBM 7525 Data Collection Terminals (capacitive backup)
and up to 75,000 hours for IBM 7527 Data Collection Terminals
(battery backup). (See also <B>data collection terminal.</B>)
<P><DT>data validation files
<DD>User-created files that provide information specific to the user's
organization. These files contain, for example, employee badge numbers,
the names of all current employees, and employee IDs. Data validation
information is defined and entered into the system at the terminal
server through the IBM Data Collection Connection program menus.
<P><DT>download
<DD>The process by which operating information or software in the form of
files installed (loaded) on the terminal server, is sent to the data
collection terminals and stored in memory (RAM) on the data collection
terminals. When using the Data Collection Connection program, operating information
can be loaded into RAM on individual
data collection terminals,
or on an entire group (cluster/function group) of terminals in this way.
<P><DT><FONT SIZE=+2><STRONG>E
</STRONG></FONT><P><P><DT>Extended Terminal Services (ETS)
<DD>Generic term for the 7524 ETS flash or the DCConnect Client program,
both of which run in the DCT to enable the DCT to communicate with a
terminal server such as DCConnect.
<P><DT><FONT SIZE=+2><STRONG>F
</STRONG></FONT><P><P><DT>fast-clocking data entry
<DD>One of two data entry methods that determine how users interact with
data collection terminals. With this method, transactions can be
entered without pressing a function key. This method is well-suited for
time and attendance applications where many entries must be made quickly.
Fast-clocking works only with buffered mode of operation.
(See also <B>buffered mode</B> and <B>data entry methods.</B>)
<P><DT>function keys
<DD>Each data collection terminal has a keyboard with programmable
function/alphabetic keys and a numeric keypad. The number of keys
and their layout depend upon the model of the data collection terminal.
The function keys can be programmed at the terminal server with the use
of the IBM <I>Data Collection Connection</I>'s menus to display certain prompts or
to initiate a particular action.
The alphabetic keys are used for data entries that require
alphabetic input.
They are used after a function key is pressed to initiate an action or
function. (See also <B>data collection terminal.</B>)
<P><DT><FONT SIZE=+2><STRONG>H
</STRONG></FONT><P><P><DT>host application interface
<DD>Software installed on a host computer system which receives
data transactions passed to the host computer from the terminal
server.
<P><DT>host applications
<DD>Software installed on a host computer system providing
comprehensive analysis, inquiry and report capabilities using the
data sent to the host computer from your data collection system.
<P><DT>host computer
<DD>The computer system to which transactions are sent after they are
collected by the terminal server. Typically, transactions are sent
to a host computer for additional processing by production monitoring
and control applications.
<P><DT>host communications support
<DD>A software product installed on the terminal server which
allows communication with a host computer system, allowing data
transactions to be sent to the host computer. To operate, this
software may also require the installation of an appropriate
adapter card in the terminal server. An emulation program
may also be required in some applications.
<P><DT><FONT SIZE=+2><STRONG>I
</STRONG></FONT><P><P><DT>ID
<DD>An identifier; that is, a unique representation of a
particular entity. In this document, an ID identifies the entity
to ETS. In turn, ETS recognizes the ID and performs the processing
required for the entity that the ID represents.
Examples of IDs are: function ID, reference ID, file ID.
<P><DT>idle mode
<DD>See <B>idle state</B>.
<P><DT>idle state
<DD>A terminal state in which the
terminal is operating but not active; that is, the terminal
may be receiving commands and sending replies, but is waiting for
the operator to initiate a transaction program.
<P><DT>in service
<DD>A terminal operating condition under which the
terminal will accept data from the operator and the terminal server.
<P>
The term 'online' has been used in the past to mean 'in service'.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
If the Data Collector is installed, <I>online</I>
means the terminal is being polled by the Data Collector,
and <I>enabled</I> means the terminal will accept data
from the operator and the terminal server.
See the <I>&dcguide.</I> for additional information.
</td></tr></table>
<P><DT>industrial computer
<DD>Refers to any of the following IBM
computer models used as the terminal server:
IBM Industrial Computer Models 7531, 7532, 7541, 7542, 7552, 7561, 7562,
or IBM GEARBOX Model 800.
(See also <B>terminal server</B> and
<B>personal computer</B>.)
<P><DT>interactive mode
<DD>One of three system operational modes that determine how the terminal
server interacts with the data collection terminals. In the
interactive mode, transactions are processed by the terminal server
as they are entered at a data collection terminal. After a transaction
has been entered into a data collection terminal, that terminal cannot
accept another transaction until the stored transaction is processed by
the terminal server. (See also <B>operational modes</B> and
<B>single-transaction buffer.</B>)
<P><DT>interactive/buffered mode
<DD>The interactive/buffered mode
allows the terminal to build a transaction
and lock out any further activity until the transaction is acted on by
the host, or until a programmable timeout (Timer <B>A</B>) function occurs.
If timeout occurs, the waiting transaction will be stored in a buffer,
and the terminal can accept new transactions.
The system will then operate in buffered mode until the host
starts to poll the terminal again. (See also <B>buffered
mode</B>, <B>interactive mode</B>,
and <B>multi-transaction buffer.</B>)
<P><DT><FONT SIZE=+2><STRONG>L
</STRONG></FONT><P><P><DT>last read variable
<DD>The last input data string accepted by a transaction. Also known
as <I>user variable 0</I>.
<P><DT><FONT SIZE=+2><STRONG>M
</STRONG></FONT><P><P><DT>magnetic stripe reader
<DD>A data entry device which reads data encoded on a magnetic
stripe affixed to a card or badge. The reader may be either a slot
reader or wand (scanner-type) reader, and operates by scanning
the magnetic stripe electronically.
<P><DT>multi-transaction buffer
<DD>A buffer within each data collection terminal, in which many
transactions can be temporarily retained. Used with the buffered mode of
system operation, the terminal can store transactions until they are
sent to the terminal server. When this buffer is used,
a data collection terminal can accept transactions one after another
without waiting to be polled by the terminal server.
(See also <B>buffered mode</B> and <B>fast-clocking
data entry.</B>)
<P><DT><FONT SIZE=+2><STRONG>N
</STRONG></FONT><P><P><DT>normal data entry
<DD>One of two data entry methods in which data collection terminals can
be used. With this method, users must press a function key prior
to making an entry and then enter data as prompted by the
data collection terminal. This method may be used
with either the buffered or interactive operational modes.
(See also <B>data entry sequence.</B>)
<P><DT><FONT SIZE=+2><STRONG>O
</STRONG></FONT><P><P><DT>operational modes
<DD>The operational modes, interactive, buffered, and
interactive/buffered, affect how the
terminal server and data collection terminals interact. In the
interactive mode, the terminal server processes a transaction when it
is entered at a data collection terminal. In the buffered mode,
transactions are entered and then temporarily retained in the
data collection terminal until they are collected and processed by the
terminal server.
The interactive/buffered mode
allows the terminal to build a transaction
and lock out any further activity until the transaction is acted on by
the terminal server, or until a programmable timeout
(Timer <B>A</B>) function occurs.
An operational mode is specified in the operating instructions
that are downloaded to the data collection terminals.
<P><DT>out of service
<DD>A terminal operating condition under which
operator interaction with the terminal is not permitted, but
the terminal can still communicate with the terminal server.
<P>
The term 'offline' has been used in the past to mean 'out of service'.
<TABLE><TR><TD ALIGN=LEFT VALIGN=TOP><B>Note:</B></TD><TD ALIGN=LEFT VALIGN=TOP>
If the IBM DOS Data Collector is installed, <I>offline</I>
means the terminal is not being polled by the Data Collector,
and <I>disabled</I> means that no
operator interaction with the terminal is permitted, but
the terminal can still communicate with the terminal server.
See the <I>&dcguide.</I> for additional information.
</td></tr></table>
<P><DT><FONT SIZE=+2><STRONG>P
</STRONG></FONT><P><P><DT>personal computer
<DD>Refers to any of the following IBM computer models used as the
terminal server:
IBM PS/2 Models 30/286, 50, 50Z, 55SX, 60, 70, 80 or IBM PC AT.
(See also <B>terminal server</B> and
<B>industrial computer</B>.)
<P><DT><FONT SIZE=+2><STRONG>S
</STRONG></FONT><P><P><DT>single-transaction buffer
<DD>A buffer within each data collection terminal, in which only a single
transaction can be temporarily retained. Used with the interactive mode
of system operation, this buffer retains a transaction in the data
collection terminal's memory until the terminal is polled by the terminal
server. While a transaction is held in this buffer, the data
collection terminal cannot accept additional transactions.
(See also <B>interactive mode</B> and <B>operational modes.</B>)
<P><DT><FONT SIZE=+2><STRONG>T
</STRONG></FONT><P><P><DT>terminal application program
<DD>A generic term for the operating software which controls individual
data collection terminals in a data collection
system and which resides in the data collection terminal's memory.
The IBM 7525 Data Collection Terminal has a terminal
application program that is factory-installed, ROM-resident firmware.
The IBM 7524 Radio Frequency Data Collection Terminal has a terminal
application program that is factory-installed in FLASH ROM firmware.
The IBM 7527 Data Collection Terminal requires a downloadable terminal
application program which is RAM-resident on the 7527; this is offered
as an optional component of the Data Collection Edition (<I>7527 Extended Terminal Services
</I>) or,
may be supplied by the customer.
<P><DT>terminal server
<DD>An IBM personal computer or industrial computer that collects the data
entered into data collection terminals, controls the operation of data
collection terminals and stores the data. The IBM <I>Data Collection Edition</I>
software can be
installed on the terminal server to support data collection
activities and system control/configuration functions.
<P><DT>transaction
<DD>Any complete data entry that occurs at a data collection terminal.
May be entered by the user via the terminal's keyboard or any of its
data entry devices and can consist of a single entry or multiple entries.
<P><DT>transaction in progress
<DD>A terminal operating condition under which data is
being collected and transmitted between the terminal and the
terminal server.
<P><DT><FONT SIZE=+2><STRONG>U
</STRONG></FONT><P><P><DT>user variable 0
<DD>See <B>last read variable</B>.
</DL>
<HR><B> Footnotes:</B>
<P><A NAME="FNGPDEF" >(1)</A>
Throughout this document, <I>GP</I> communications refers to
<B>general purpose</B> (that is, RS-232) communications.
<P><A NAME="FNCMDEXPL" >(2)</A>
Throughout this document, <B>CMD</B> represents
<B>command.</B> For example, CMD A means Command A.
For the meanings of CMD 8 and all other communications commands,
(See<A HREF="#HDRPFTCCC">DCT Communications Control Commands</A>) .
<P><A NAME="FNDUP" >(3)</A>
The duplication is done for debugging purposes only and is
not critical to the operation of the protocol.
<P><A NAME="FNROMDEF" >(4)</A>
ROM = Read-Only Memory
<P><A NAME="FNTODDEF" >(5)</A>
TOD = Time of Day
<P><A NAME="FNNOOP" >(6)</A>
This command is provided for compatibility with 7527
terminal communications.
A dummy response compatible with what the host is
expecting is returned.
Both the 7524 ETS flash and DCConnect Client do not handle
the reloading of themselves into the terminal.
<P><A NAME="FNRAMDEF" >(7)</A>
RAM = Random-Access Memory
<P><A NAME="FNDIDODEF" >(8)</A>
DIDO = digital input/digital output
<P><A NAME="FNIDNOTE" >(9)</A>
Throughout this document, the acronym
<B>ID</B> shall be used to indicate an
identifier, which is a unique representation of a
particular entity.
An ID identifies the entity to ETS.
In turn, ETS recognizes the ID and performs the processing
required for the entity that the ID represents.
Examples of IDs are: function ID, reference ID, file ID.
<P><A NAME="FNNOPDEF" >(10)</A>
NOP = no operation
<A NAME=Bot_Of_Page></A>
</BODY></HTML>
]]>