460 lines
12 KiB
HTML
460 lines
12 KiB
HTML
<html>
|
|
|
|
<head>
|
|
<meta http-equiv="Content-Type"
|
|
content="text/html; charset=iso-8859-1">
|
|
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
|
|
<title>CommCapsV01</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr>
|
|
<td width="400" height="40"> </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="comm.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="commcfg1.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>CommCaps 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>NewCommCaps -
|
|
Constructor</strong></a></li>
|
|
<li><a href="#DeleteComm"><strong>DeleteCommCaps -
|
|
Destructor</strong></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#Methods provided"><strong>Methods provided</strong></a><ul>
|
|
<li><a href="#DataBits"><strong>CommCapsDataBits -
|
|
Number of data bits supported</strong></a></li>
|
|
<li><a href="#FIFO"><strong>CommCapsFIFO - FIFO
|
|
capabilities supported</strong></a></li>
|
|
<li><a href="#FIFO"><strong>CommCapsHandshake -
|
|
Handshaking capabilities supported</strong></a></li>
|
|
<li><a href="#FIFO"><strong>CommCapsParity - Parity
|
|
capabilities supported</strong></a></li>
|
|
<li><a href="#FIFO"><strong>CommCapsRate - Data Rate
|
|
capabilities supported</strong></a></li>
|
|
<li><a href="#FIFO"><strong>CommCapsSignals - Signal
|
|
capabilities supported</strong></a></li>
|
|
<li><a href="#FIFO"><strong>CommCapsSIR - SIR
|
|
capabilities supported</strong></a></li>
|
|
<li><a href="#StopBits"><strong>CommCapsStopBits -
|
|
Stop bits supported</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>Description</h5>
|
|
|
|
<p><code>CommCaps</code> represents the configuration
|
|
capabilities of a serial port.</p>
|
|
|
|
<h5>See Also</h5>
|
|
|
|
<p><a href="comm.htm#Caps">CommCaps</a></p>
|
|
|
|
<hr>
|
|
|
|
<h2><a name="Construction">Construction / destruction</a></h2>
|
|
|
|
<hr size="1">
|
|
|
|
<h3><a name="NewServ">NewCommCaps - Constructor</a></h3>
|
|
|
|
<h5>Usage</h5>
|
|
|
|
<p><code>this& = NewCommCaps&:</code></p>
|
|
|
|
<h5>Description</h5>
|
|
|
|
<p>Creates a CommCaps object and returns a handle which allows
|
|
the object to be manipulated.</p>
|
|
|
|
<h5>Return Value</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>this&</code></td>
|
|
<td>An value which represents the created CommCaps 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&
|
|
|
|
<strong>this& = NewCommCaps&:</strong>
|
|
DeleteCommCaps:(this&) </pre>
|
|
|
|
<hr size="1">
|
|
|
|
<h3><a name="DeleteComm">DeleteCommCaps - Destructor</a></h3>
|
|
|
|
<h5>Usage</h5>
|
|
|
|
<p><code>DeleteCommCaps:(BYREF this&)</code></p>
|
|
|
|
<h5>Description</h5>
|
|
|
|
<p>Destroys the CommCaps object.</p>
|
|
|
|
<h5>Arguments</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>BYREF this&</code></td>
|
|
<td>A handle to a CommCaps object</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h5>Example</h5>
|
|
|
|
<pre> LOCAL this&
|
|
|
|
this& = NewCommCaps&:()
|
|
<strong>DeleteCommCaps:(this&)</strong> </pre>
|
|
|
|
<hr>
|
|
|
|
<h2><a name="Methods provided">Methods provided</a></h2>
|
|
|
|
<hr size="1">
|
|
|
|
<h3><a name="DataBits">CommCapsDataBits - Number of Data Bits
|
|
supported</a></h3>
|
|
|
|
<h5>Usage</h5>
|
|
|
|
<p><code>cap& = CommCapsDataBits&:(this&)</code></p>
|
|
|
|
<h5>Description</h5>
|
|
|
|
<p><font color="#FF0000"><TBS></font></p>
|
|
|
|
<h5>Arguments</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>this&</code></td>
|
|
<td>A handle to a CommCaps object</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h5>Return value</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>caps&</code></td>
|
|
<td>The number of <a
|
|
href="file:///P:/Opx/CComms/Documentation/charsizecap.htm">data
|
|
bits</a> supported</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<hr size="1">
|
|
|
|
<h3><a name="FIFO">CommCapsFIFO - FIFO capabilities supported</a></h3>
|
|
|
|
<h5>Usage</h5>
|
|
|
|
<p><code>cap& = CommCapsFIFO&:(this&)</code></p>
|
|
|
|
<h5>Description</h5>
|
|
|
|
<p><font color="#FF0000"><TBS></font></p>
|
|
|
|
<h5>Arguments</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>this&</code></td>
|
|
<td>A handle to a CommCaps object</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h5>Return value</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>caps&</code></td>
|
|
<td>The <a
|
|
href="file:///P:/Opx/CComms/Documentation/fifocap.htm">FIFO
|
|
capabilities</a> supported</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<hr size="1">
|
|
|
|
<h3><a name="Handshake">CommCapsHandshake - Handshaking
|
|
capabilities supported</a></h3>
|
|
|
|
<h5>Usage</h5>
|
|
|
|
<p><code>cap& = CommCapsHandshake&:(this&)</code></p>
|
|
|
|
<h5>Description</h5>
|
|
|
|
<p><font color="#FF0000"><TBS></font></p>
|
|
|
|
<h5>Arguments</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>this&</code></td>
|
|
<td>A handle to a CommCaps object</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h5>Return value</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>caps&</code></td>
|
|
<td>The <a
|
|
href="file:///P:/Opx/CComms/Documentation/handcap.htm">handshaking
|
|
capabilities</a> supported</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<hr size="1">
|
|
|
|
<h3><a name="Parity">CommCapsParity - Parity capabilities
|
|
supported</a></h3>
|
|
|
|
<h5>Usage</h5>
|
|
|
|
<p><code>cap& = CommCapsParity&:(this&)</code></p>
|
|
|
|
<h5>Description</h5>
|
|
|
|
<p><font color="#FF0000"><TBS></font></p>
|
|
|
|
<h5>Arguments</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>this&</code></td>
|
|
<td>A handle to a CommCaps object</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h5>Return value</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>caps&</code></td>
|
|
<td>The <a
|
|
href="file:///P:/Opx/CComms/Documentation/paritycap.htm">parity
|
|
capabilities</a> supported</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<hr size="1">
|
|
|
|
<h3><a name="Rate">CommCapsRate - Data rate capabilities
|
|
supported</a></h3>
|
|
|
|
<h5>Usage</h5>
|
|
|
|
<p><code>cap& = CommCapsRate&:(this&)</code></p>
|
|
|
|
<h5>Description</h5>
|
|
|
|
<p><font color="#FF0000"><TBS></font></p>
|
|
|
|
<h5>Arguments</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>this&</code></td>
|
|
<td>A handle to a CommCaps object</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h5>Return value</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>caps&</code></td>
|
|
<td>The <a href="../Documentation/dataratecap.htm">data
|
|
rate capabilities</a> supported</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<hr size="1">
|
|
|
|
<h3><a name="Signals">CommCapsSignals - Signals capabilities
|
|
supported</a></h3>
|
|
|
|
<h5>Usage</h5>
|
|
|
|
<p><code>cap& = CommCapsSignals&:(this&)</code></p>
|
|
|
|
<h5>Description</h5>
|
|
|
|
<p><font color="#FF0000"><TBS></font></p>
|
|
|
|
<h5>Arguments</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>this&</code></td>
|
|
<td>A handle to a CommCaps object</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h5>Return value</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>caps&</code></td>
|
|
<td>The <a href="../Documentation/signalcap.htm">signal
|
|
line capabilities</a> supported</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<hr size="1">
|
|
|
|
<h3><a name="SIR">CommCapsSIR - SIR capabilities supported</a></h3>
|
|
|
|
<h5>Usage</h5>
|
|
|
|
<p><code>cap& = CommCapsSIR&:(this&)</code></p>
|
|
|
|
<h5>Description</h5>
|
|
|
|
<p><font color="#FF0000"><TBS></font></p>
|
|
|
|
<h5>Arguments</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>this&</code></td>
|
|
<td>A handle to a CommCaps object</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h5>Return value</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>caps&</code></td>
|
|
<td>The <a
|
|
href="file:///P:/Opx/CComms/Documentation/serialcap.htm">SIR
|
|
capabilities</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<hr size="1">
|
|
|
|
<h3><a name="StopBits">CommCapsStopBits - Stop bit capabilities
|
|
supported</a></h3>
|
|
|
|
<h5>Usage</h5>
|
|
|
|
<p><code>cap& = CommCapsStopBits&:(this&)</code></p>
|
|
|
|
<h5>Description</h5>
|
|
|
|
<p><font color="#FF0000"><TBS></font></p>
|
|
|
|
<h5>Arguments</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>this&</code></td>
|
|
<td>A handle to a CommCaps object</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h5>Return value</h5>
|
|
|
|
<table border="1">
|
|
<tr>
|
|
<td><code>caps&</code></td>
|
|
<td>The <a
|
|
href="file:///P:/Opx/CComms/Documentation/stopbitcap.htm">Stop
|
|
bit capabilities</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<hr>
|
|
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr>
|
|
<td width="400" height="40"> </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="comm.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="commcfg1.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>
|