<doc>
  <legacy_id>1375</legacy_id>
  <name>serialControlString</name>
  <type>property</type>
  <syntax>
    <example>set the serialControlString to <i>settingsList</i></example>
  </syntax>
  <library></library>
  <objects>
    <global/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Networks &amp; Communication</category>
  </classification>
  <references>
    <keyword tag="modem:">modem: Keyword</keyword>
    <keyword tag="COMn:">COMn: Keyword</keyword>
    <command tag="close file">close file Command</command>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
    <changed version="2.0"></changed>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <web/>
  </classes>
  <security>
    <disk access="???"/>
  </security>
  <summary>The <b>serialControlString</b> specifies the settings of a serial <glossary tag="port">port</glossary>.</summary>
  <examples>
    <example>set the serialControlString to storedSerial</example>
  </examples>
  <description>
    <p>Use the <b>serialControlString</b> <glossary tag="property">property</glossary> to set a serial <glossary tag="port">port</glossary> before use.</p>
<p>&nbsp;</p>
<p><b>Value:</b></p>
<p>The <b>serialControlString</b> consists of one or more settings, separated by spaces. Each setting consists of the setting name, an equals <glossary tag="sign">sign</glossary> (=), and the value.</p>
<p>&nbsp;</p>
<p>The possible settings are as follows:</p>
<p>* <code>BAUD=<i>number</i></code>: the port's baud rate</p>
<p>* <code>PARITY=N</code>,<code> O</code>,<code> </code>or<code> E</code>: no parity, odd parity, or even parity</p>
<p>* <code>DATA=<i>numberOfDataBits</i></code></p>
<p>* <code>STOP=<i>numberOfStopBits</i></code></p>
<p>* <code>to=on </code>or<code> off</code>: use timeouts</p>
<p>* <code>xon=on </code>or<code> off</code>: software handshaking</p>
<p>* <code>odsr=on </code>or<code> off</code>: (output) data set ready</p>
<p>* <code>octs=on </code>or<code> off</code>: (output) clear to send</p>
<p>* <code>dtr=on </code>or<code> off</code>: data terminal ready</p>
<p>* <code>rts=on </code>or<code> off</code>: ready to sent</p>
<p>* <code>isdr=on </code>or<code> off</code>: (input) data set ready</p>
<p>&nbsp;</p>
<p>By default, the <b>serialControlString</b> is set to<code> BAUD=9600 PARITY=N DATA=8 STOP=1</code>.</p>
<p>&nbsp;</p>
<p><b>Comments:</b></p>
<p>To set a serial port's settings, first set the <b>serialControlString</b> to the desired settings. Then open the serial <glossary tag="port">port</glossary> using the <command tag="open file">open file</command> <glossary tag="command">command</glossary> or the <command tag="open driver">open driver</command> <glossary tag="command">command</glossary>.</p>
<p>&nbsp;</p>
<p>On Mac OS systems, the <b>serialControlString</b> <glossary tag="property">property</glossary> can be used to set the printer or modem <glossary tag="port">ports</glossary>. On <glossary tag="Windows">Windows systems</glossary>, the <b>serialControlString</b> can be used to set the COM <glossary tag="port">ports</glossary>. On <glossary tag="OS X">OS X systems</glossary>, the <b>serialControlString</b> can be used to set a serial <glossary tag="peripheral device">device</glossary> returned by the <function tag="driverNames">driverNames</function> <href tag="">function</href>.</p>
<p>&nbsp;</p>
<p>The format of the <b>serialControlString</b> is compatible with the extended MS-DOS "mode" command.</p>
<p>&nbsp;</p>
<p><b>Changes:</b></p>
<p>Support for OS X and Unix serial devices was added in version 2.0.</p>
  </description>
</doc>