psionrevo
/
ccoms-html
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ccoms-html/commcfg1.htm

1256 lines
32 KiB
HTML
Raw Blame History

<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
<title>CommConfigV01 Class</title>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="400" height="40">&nbsp;</td>
<td width="30" height="40"><a
href="../../../epoc32/doc/group/sdk.html"><img
src="../../../epoc32/doc/group/library.gif"
alt="SDK Home" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/glossary/glossary.html"><img
src="../../../epoc32/doc/group/glossary.gif"
alt="Glossary" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/index/id-toc.html"><img
src="../../../epoc32/doc/group/index.gif" alt="Index"
align="top" border="0" width="30" height="30"></a></td>
<td width="30" height="40"><a href="commcaps.htm"><b><img
src="../../../epoc32/doc/group/stoneleft.gif" alt="Left"
align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="commserv.htm"><b><img
src="../../../epoc32/doc/group/stoneright.gif"
alt="Right" align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="programm.htm"><b><img
src="../../../epoc32/doc/group/stoneup.gif" alt="Up"
align="top" border="0" width="30" height="30"></b></a></td>
</tr>
</table>
<hr>
<h1>CommConfig Class</h1>
<hr>
<p><em>Section contents</em></p>
<ul>
<li><a href="#Overview"><strong>Overview</strong></a></li>
<li><a href="#Construction"><strong>Construction /
destruction</strong></a><ul>
<li><a href="#NewServ"><strong>NewCommConfig -
Constructor</strong></a></li>
<li><a href="#DeleteComm"><strong>DeleteCommConfig -
Destructor</strong></a></li>
</ul>
</li>
<li><a href="#Methods provided"><strong>Methods provided</strong></a><ul>
<li><a href="#DataBits"><strong>CommConfigDataBits -
get number of data bits</strong></a></li>
<li><a href="#FIFOStatus"><strong>CommConfigFIFO -
get FIFO status</strong></a></li>
<li><a href="#Handshaking"><strong>CommConfigHandshake
- get handshaking control</strong></a></li>
<li><a href="#Parity"><strong>CommConfigParity - get
parity type</strong></a></li>
<li><a href="#ParityError"><strong>CommConfigParityError
- get parity error</strong></a></li>
<li><a href="#ParityErrorChar"><strong>CommConfigParityErrorChar
- get parity error character</strong></a></li>
<li><a href="#Rate"><strong>CommConfigRate - get data
rate</strong></a></li>
<li><a href="#SetDataBits"><strong>CommConfigSetDataBits
- set number of data bits</strong></a></li>
<li><a href="#SetFIFOStatus"><strong>CommConfigSetFIFO
- set FIFO status</strong></a></li>
<li><a href="#SetHandshake"><strong>CommConfigSetHandshake
- set handshaking control</strong></a></li>
<li><a href="#SetParity"><strong>CommConfigSetParity
- set parity</strong></a></li>
<li><a href="#SetParityError"><strong>CommConfigSetParityError
- set parity error</strong></a></li>
<li><a href="#SetParityErrorChar"><strong>CommConfigSetParityErrorChar
- set parity error character</strong></a></li>
<li><a href="#SetRate"><strong>CommConfigSetRate -
set data rate</strong></a></li>
<li><a href="#SetSIREnable"><strong>CommConfigSetSIREnable
- set SIR encoding</strong></a></li>
<li><a href="#SetSIRSettings"><strong>CommConfigSetSIRSettings
- set SIR settings</strong></a></li>
<li><a href="#SetSpecialRate"><strong>CommConfigSetSpecialRate
- set special data rate</strong></a></li>
<li><a href="#SetStopBits"><strong>CommConfigSetStopBits
- set stop bits</strong></a></li>
<li><a href="#SetTerminator"><strong>CommConfigSetTerminatorCharacter
- set terminator character</strong></a></li>
<li><a href="#SetTerminatorCount"><strong>CommConfigSetTerminatorCount
- set number of terminator characters</strong></a></li>
<li><a href="#SetXOFFChar"><strong>CommConfigSetXoffChar
- set XOFF character</strong></a></li>
<li><a href="#SetXONChar"><strong>CommConfigSetXonChar
- set XON character</strong></a></li>
<li><a href="#SIREnable"><strong>CommConfigSIREnable
- get SIR encoding</strong></a></li>
<li><a href="#SIRSettings"><strong>CommConfigSIRSettings
- get SIR settings</strong></a></li>
<li><a href="#SpecialRate"><strong>CommConfigSpecialRate
- get special rate</strong></a></li>
<li><a href="#StopBits"><strong>CommConfigStopBits -
get stop bits</strong></a></li>
<li><a href="#Terminator"><strong>CommConfigTerminator
- get terminator character</strong></a></li>
<li><a href="#TerminatorCount"><strong>CommConfigTerminatorCount
- get number of terminator characters</strong></a></li>
<li><a href="#XoffChar"><strong>CommConfigXoffChar -
get XOFF character</strong></a></li>
<li><a href="#XonChar"><strong>CommConfigXonChar -
get XON character</strong></a></li>
</ul>
</li>
</ul>
<hr>
<h2><a name="Overview">Overview</a></h2>
<h5>Defined in</h5>
<p><code>ccomms.oxh</code></p>
<h5><font color="#000000"><tt>Description</tt></font></h5>
<p><font color="#000000"><tt>CommConfig</tt></font> represents
the confifuration details of a serial port.</p>
<hr>
<h2><a name="Construction">Construction / destruction</a></h2>
<hr size="1">
<h3><a name="NewServ">NewServConfigV01 - Constructor</a></h3>
<h5>Usage</h5>
<p><code>this&amp; = NewCommConfig&amp;:</code></p>
<h5>Description</h5>
<p>Creates a comm object and returns a handle which allows the
object to be manipulated.</p>
<h5>Return Value</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>An value which represents the created CommConfig
object</td>
</tr>
</table>
<h5>Error Handling</h5>
<p>If the object could not be created then an error is generated
which should be trapped by an <font face="Times New Roman"><code>ONERR</code></font>
handler.</p>
<h5>Example</h5>
<pre> LOCAL this&amp;
<strong>this&amp; = NewCommConfig&amp;:</strong>
DeleteCommConfig:(this&amp;) </pre>
<hr size="1">
<h3><a name="DeleteComm">DeleteCommConfig - Destructor</a></h3>
<h5>Usage</h5>
<p><code>DeleteCommConfig:(BYREF this&amp;)</code></p>
<h5>Description</h5>
<p>Destroys the CommConfig object.</p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>BYREF this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Example</h5>
<pre> LOCAL this&amp;
this&amp; = NewCommConfig&amp;:()
<strong>DeleteCommConfig:(this&amp;)</strong> </pre>
<hr>
<h2><a name="Methods provided">Methods provided</a></h2>
<hr size="1">
<h3><a name="DataBits">CommConfigDataBits - Get number of Data
Bits</a></h3>
<h5>Usage</h5>
<p><code>bits% = CommConfigDataBits%:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>bits%</code></td>
<td>The number of <a href="charsize.htm">data bits</a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetDataBits">CommConfigSetDataBits</a></p>
<hr size="1">
<h3><a name="FIFOStatus">CommConfigFIFO - Get FIFO Status</a></h3>
<h5>Usage</h5>
<p><code>status% = CommConfigFIFO%:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>status%</code></td>
<td>The <a href="fifo.htm">FIFO status</a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetFIFOStatus">CommConfigSetFIFO</a></p>
<hr size="1">
<h3><a name="Handshaking">CommConfigHandshake - Get Handshaking
Control</a></h3>
<h5>Usage</h5>
<p><code>handshake&amp; = CommConfigHandshake&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>handshake&amp;</code></td>
<td>The <a href="handshak.htm">handshaking</a> control</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetHandshake">CommConfigSetHandshake</a></p>
<hr size="1">
<h3><a name="Parity">CommConfigParity - Get Parity Type</a></h3>
<h5>Usage</h5>
<p><code>parity% = CommConfigParity%:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>parity%</code></td>
<td>The <a href="paritytype.htm">parity type</a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#Parity">CommConfigParity</a>, <a href="#ParityError">CommConfigParityError</a>,
<a href="#ParityErrorChar">CommConfigParityErrorChar</a>, <a
href="#SetParity">CommConfigSetParity</a></p>
<hr size="1">
<h3><a name="ParityError">CommConfigParityError - Get Parity
Error</a></h3>
<h5>Usage</h5>
<p><code>error&amp; = CommConfigParityError&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>error&amp;</code></td>
<td>The <a href="parityerr.htm">parity error</a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#Parity">CommConfigParity</a>, <a href="#ParityError">CommConfigParityError</a>,
<a href="#ParityErrorChar">CommConfigParityErrorChar</a>, <a
href="#SetParityError">CommConfigSetParityError</a></p>
<hr size="1">
<h3><a name="ParityErrorChar">CommConfigParityErrorChar - Get
Parity Error Character</a></h3>
<h5>Usage</h5>
<p><code>char% = CommConfigParityErrorChar%:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>char%</code></td>
<td>Character used to replace those received with a
parity error with when <font size="4"><tt>iParityError</tt></font>
is set to <a
href="CSAPI-017.html#commapi.constant.KConfigParityErrorReplaceChar"><font
color="#000000" size="4"><tt>KConfigParityErrorReplaceChar</tt></font></a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#Parity">CommConfigParity</a>, <a href="#ParityError">CommConfigParityError</a>,
<a href="#ParityErrorChar">CommConfigParityErrorChar</a>, <a
href="#SetParityErrorChar">CommConfigSetParityErrorChar</a></p>
<hr size="1">
<h3><a name="Rate">CommConfigRate - Get Data Rate</a></h3>
<h5>Usage</h5>
<p><code>rate% = CommConfigRate%:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>rate%</code></td>
<td>The <a href="datarate.htm">data rate</a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetRate">CommConfigSetRate</a></p>
<hr size="1">
<h3><a name="SetDataBits">CommConfigSetDataBits - Set Data Bits</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetDataBits:(this&amp;,bits%)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>bits%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#DataBits">CommConfigDataBits</a></p>
<hr size="1">
<h3><a name="SetFIFOStatus">CommConfigSetFIFO - Set FIFO Status</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetFIFO:(this&amp;,status%)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>status%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#FIFOStatus">CommConfigFIFO</a></p>
<hr size="1">
<h3><a name="SetHandshake">CommConfigSetHandshake - Set
Handshaking Control</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetHandshake:(this&amp;,handshake&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>handshake&amp;</code></td>
<td>A bitmask of the <a href="handshak.htm">handshaking</a>
control</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#Handshaking">CommConfigHandshake</a></p>
<hr size="1">
<h3><a name="SetParity">CommConfigSetParity - Set Parity Type</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetParity:(this&amp;,parity%)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>parity%</code></td>
<td>The <a href="paritytype.htm">parity type</a> to set</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#Parity">CommConfigParity</a>, <a href="#ParityError">CommConfigParityError</a>,
<a href="#ParityErrorChar">CommConfigParityErrorChar</a></p>
<hr size="1">
<h3><a name="SetParityError">CommConfigSetParityError - Set
Parity Error</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetParityError:(this&amp;,error&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>error&amp;</code></td>
<td>The <a href="parityerr.htm">parity error</a> to set</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#Parity">CommConfigParity</a>, <a href="#ParityError">CommConfigParityError</a>,
<a href="#ParityErrorChar">CommConfigParityErrorChar</a></p>
<hr size="1">
<h3><a name="SetParityErrorChar">CommConfigSetParityErrorChar -
Set Parity Error Character</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetParityErrorChar:(this&amp;,char%)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>char%</code></td>
<td>Character used to replace those received with a
parity error with when <font size="4"><tt>iParityError</tt></font>
is set to <a
href="CSAPI-017.html#commapi.constant.KConfigParityErrorReplaceChar"><font
color="#000000" size="4"><tt>KConfigParityErrorReplaceChar</tt></font></a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#Parity">CommConfigParity</a>, <a href="#ParityError">CommConfigParityError</a>,
<a href="#ParityErrorChar">CommConfigParityErrorChar</a></p>
<hr size="1">
<h3><a name="SetRate">CommConfigSetRate - Set Data Rate</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetRate:(this&amp;,rate%)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>rate%</code></td>
<td>The <a href="datarate.htm">data rate</a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#Rate">CommConfigRate</a></p>
<hr size="1">
<h3><a name="SetSIREnable">CommConfigSetSIREnable - Set SIR
Encoding</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetSIREnable:(this&amp;,bool%)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>bool%</code></td>
<td>Switch the <a href="serial.htm">SIR encoding</a>
hardware on and off</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SIREnable">CommConfigSIREnable</a></p>
<hr size="1">
<h3><a name="SetSIRSettings">CommConfigSetSIRSettings - Set SIR
Settings</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetSIRSettings:(this&amp;,setting&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>setting&amp;</code></td>
<td>The <a href="../Documentation/serialset.htm">SIR
settings</a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SIRSettings">CommConfigSIRSettings</a></p>
<hr size="1">
<h3><a name="SetSpecialRate">CommConfigSetSpecialRate - Set
Special rate</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetSpecialRate:(this&amp;,rate&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>rate&amp;</code></td>
<td>Pass though data rate used when <font size="4"><tt>iRate</tt></font>
is set to <font size="4"><tt>EBpsSpecial.</tt></font> The
representation used in driver dependent.</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SpecialRate">CommConfigSpecialRate</a></p>
<hr size="1">
<h3><a name="SetStopBits">CommConfigSetStopBits - Set StopBits</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetStopBits:(this&amp;,bits%)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>bits%</code></td>
<td>The number of <a href="stopbits.htm">stop bits</a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#StopBits">CommConfigStopBits</a></p>
<hr size="1">
<h3><a name="SetTerminator">CommConfigSetTerminator - Set
Terminator Character</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetTerminator:(this&amp;,index%,char%)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>index%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
<tr>
<td><code>char%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetTerminatorCount">CommConfigSetTerminatorCount</a>,
<a href="#Terminator">CommConfigTerminator</a>, <a
href="#TerminatorCount">CommConfigTerminatorCount</a></p>
<hr size="1">
<h3><a name="SetTerminatorCount">CommConfigSetTerminatorCount -
Set number of terminator characters</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetTerminatorCount:(this&amp;,count%)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>count%</code></td>
<td>The number of significant terminators (&lt;= <code>KConfigMaxTerminators%</code>)</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetTerminator">CommConfigSetTerminator</a>, <a
href="#Terminator">CommConfigTerminator</a>, <a
href="#TerminatorCount">CommConfigTerminatorCount</a></p>
<hr size="1">
<h3><a name="SetXOFFChar">CommConfigSetXoffChar - Set XOFF
Character</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetXoffChar:(this&amp;,char%)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>char%</code></td>
<td>Character used to signal the transmitter to suspend
sending when using XON/XOFF handshaking</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#XoffChar">CommConfigXoffChar</a>, <a href="#XonChar">CommConfigXonChar</a>,
<a href="#SetXONChar">CommConfigSetXonChar</a></p>
<hr size="1">
<h3><a name="SetXONChar">CommConfigSetXonChar - Set XON Character</a></h3>
<h5>Usage</h5>
<p><code>CommConfigSetXonChar:(this&amp;,char%)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
<tr>
<td><code>char%</code></td>
<td>Character used to signal the transmitter to resume
sending when using XON/XOFF handshaking</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#XoffChar">CommConfigXoffChar</a>, <a href="#XonChar">CommConfigXonChar</a>,
<a href="#SetXOFFChar">CommConfigSetXoffChar</a></p>
<hr size="1">
<h3><a name="SIREnable">CommConfigSIREnable - Get SIR Encoding</a></h3>
<h5>Usage</h5>
<p><code>bool% = CommConfigSIREnable%:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>bool%</code></td>
<td>Switch the <a href="serial.htm">SIR encoding</a>
hardware on and off</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetSIREnable">CommConfigSetSIREnable</a>, <a
href="#SetSIRSettings">CommConfigSetSIRSettings</a>, <a
href="#SIRSettings">CommConfigSIREnable</a></p>
<hr size="1">
<h3><a name="SIRSettings">CommConfigSIRSettings - Get SIR
Settings</a></h3>
<h5>Usage</h5>
<p><code>settings&amp; = CommConfigSIRSettings&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>settings&amp;</code></td>
<td>The <a href="../Documentation/serialset.htm">SIR
settings</a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetSIREnable">CommConfigSIREnable</a>, <a
href="#SetSIREnable">CommConfigSetSIREnable</a>, <a
href="#SetSIRSettings">CommConfigSetSIRSettings</a></p>
<hr size="1">
<h3><a name="SpecialRate">CommConfigSpecialRate - Get special
rate</a></h3>
<h5>Usage</h5>
<p><code>rate&amp; = CommConfigSpecialRate&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>rate&amp;</code></td>
<td>Pass though data rate used when <font size="4"><tt>iRate</tt></font>
is set to <font size="4"><tt>EBpsSpecial.</tt></font> The
representation used in driver dependent.</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetSpecialRate">CommConfigSetSpecialRate</a></p>
<hr size="1">
<h3><a name="StopBits">CommConfigStopBits - Get number of stop
bits</a></h3>
<h5>Usage</h5>
<p><code>bits% = CommConfigStopBits%:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>bits%</code></td>
<td>The number of <a href="stopbits.htm">stop bits</a></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetStopBits">CommConfigSetStopBits</a></p>
<hr size="1">
<h3><a name="Terminator">CommConfigTerminator - Get terminator
character</a></h3>
<h5>Usage</h5>
<p><code>char% = CommConfigTerminator%:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>char%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetTerminator">CommConfigSetTerminator</a>, <a
href="#SetTerminatorCount">CommConfigSetTermiantorCount</a>, <a
href="#Terminator">CommConfigTerminator</a>, <a
href="#TerminatorCount">CommConfigTerminatorCount</a></p>
<hr size="1">
<h3><a name="TerminatorCount">CommConfigTerminatorCount - Get
number terminator characters</a></h3>
<h5>Usage</h5>
<p><code>count% = CommConfigTerminatorCount%:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>count%</code></td>
<td>The number of significant terminators (&lt;= <code>KConfigMaxTerminators%</code>)</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetTerminator">CommConfigSetTerminator</a>, <a
href="#SetTerminatorCount">CommConfigSetTerminatorCount</a>, <a
href="#Terminator">CommConfigTerminator</a>, <a
href="#TerminatorCount">CommConfigTerminatorCount</a></p>
<hr size="1">
<h3><a name="XoffChar">CommConfigXoffChar - Get XOFF character</a></h3>
<h5>Usage</h5>
<p><code>char% = CommConfigXoffChar%:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>char%</code></td>
<td>Character used to signal the transmitter to suspend
sending when using XON/XOFF handshaking</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetXOFFChar">CommConfigSetXoffChar</a>, <a
href="#SetXONChar">CommConfigSetXonChar</a>, <a href="#XonChar">CommConfigXonChar</a></p>
<hr size="1">
<h3><a name="XonChar">CommConfigXonChar - Get XON character</a></h3>
<h5>Usage</h5>
<p><code>char% = CommConfigXonChar%:(this&amp;)</code></p>
<h5>Description</h5>
<p><font color="#FF0000">&lt;TBS&gt;</font></p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a CommConfig object</td>
</tr>
</table>
<h5>Return value</h5>
<table border="1">
<tr>
<td><code>char%</code></td>
<td>Character used to signal the transmitter to resume
sending when using XON/XOFF handshaking</td>
</tr>
</table>
<h5>See Also</h5>
<p><a href="#SetXOFFChar">CommConfigSetXoffChar</a>, <a
href="#SetXONChar">CommConfigSetXonChar</a>, <a href="#XoffChar">CommConfigXoffChar</a></p>
<hr>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="400" height="40">&nbsp;</td>
<td width="30" height="40"><a
href="../../../epoc32/doc/group/sdk.html"><img
src="../../../epoc32/doc/group/library.gif"
alt="SDK Home" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/glossary/glossary.html"><img
src="../../../epoc32/doc/group/glossary.gif"
alt="Glossary" align="top" border="0" width="30"
height="30"></a></td>
<td width="30" height="40"><a
href="../../../epoc32/doc/index/id-toc.html"><img
src="../../../epoc32/doc/group/index.gif" alt="Index"
align="top" border="0" width="30" height="30"></a></td>
<td width="30" height="40"><a href="commcaps.htm"><b><img
src="../../../epoc32/doc/group/stoneleft.gif" alt="Left"
align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="commserv.htm"><b><img
src="../../../epoc32/doc/group/stoneright.gif"
alt="Right" align="top" border="0" width="30" height="30"></b></a></td>
<td width="30" height="40"><a href="programm.htm"><b><img
src="../../../epoc32/doc/group/stoneup.gif" alt="Up"
align="top" border="0" width="30" height="30"></b></a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink