324 lines
8.8 KiB
HTML
324 lines
8.8 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>SerialInfo</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="devcomm.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="../DOCUME~1/charsize.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="../DOCUME~1/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>SerialInfo 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="#NewCommServ"><strong>NewSerialInfo -
|
||
|
|
Constructor</strong></a></li>
|
||
|
|
<li><a href="#DeleteCommServ"><strong>DeleteSerialInfo
|
||
|
|
- Destructor</strong></a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a href="#Methods provided"><strong>Methods provided</strong></a><ul>
|
||
|
|
<li><a href="#Description"><strong>SerialInfoDescription</strong></a></li>
|
||
|
|
<li><a href="#HighUnit"><strong>SerialInfoHighUnit</strong></a></li>
|
||
|
|
<li><a href="#LowUnit"><strong>SerialInfoLowUnit</strong></a></li>
|
||
|
|
<li><a href="#Name"><strong>SerialInfoName</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><code>See Also</code></h5>
|
||
|
|
|
||
|
|
<p><a href="../DOCUME~1/commserv.htm#GetPortInfo"><code>CommServerGetPortInfo</code></a><code>,
|
||
|
|
</code><a href="../DOCUME~1/commserv.htm#GetPortInfo2"><code>CommServerGetPortInfo2</code></a></p>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<h2><a name="Construction">Construction / destruction</a></h2>
|
||
|
|
|
||
|
|
<hr size="1">
|
||
|
|
|
||
|
|
<h3><a name="NewCommServ">NewSerialInfo - Constructor</a></h3>
|
||
|
|
|
||
|
|
<h5>Usage</h5>
|
||
|
|
|
||
|
|
<p><code>this& = NewSerialInfo&:</code></p>
|
||
|
|
|
||
|
|
<h5>Description</h5>
|
||
|
|
|
||
|
|
<p>Creates a serial information 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 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& = NewSerialInfo&:</strong>
|
||
|
|
DeleteSerialInfo:(this&) </pre>
|
||
|
|
|
||
|
|
<hr size="1">
|
||
|
|
|
||
|
|
<h3><a name="DeleteCommServ">DeleteSerialInfo - Destructor</a></h3>
|
||
|
|
|
||
|
|
<h5>Usage</h5>
|
||
|
|
|
||
|
|
<p><code>DeleteSerialInfo:(BYREF this&)</code></p>
|
||
|
|
|
||
|
|
<h5>Description</h5>
|
||
|
|
|
||
|
|
<p>Destroys the serial information object.</p>
|
||
|
|
|
||
|
|
<h5>Arguments</h5>
|
||
|
|
|
||
|
|
<table border="1">
|
||
|
|
<tr>
|
||
|
|
<td><code>BYREF this&</code></td>
|
||
|
|
<td>A handle to a serial information object</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h5>Example</h5>
|
||
|
|
|
||
|
|
<pre> LOCAL this&
|
||
|
|
|
||
|
|
this& = NewSerialInfo&:
|
||
|
|
<strong>DeleteSerialInfo:(this&)</strong> </pre>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<h2><a name="Methods provided">Methods provided</a></h2>
|
||
|
|
|
||
|
|
<hr size="1">
|
||
|
|
|
||
|
|
<h3><a name="Description">SerialInfoDescription</a></h3>
|
||
|
|
|
||
|
|
<h5>Usage</h5>
|
||
|
|
|
||
|
|
<p><code>desc$ = SerialInfoDescription$:(this&)</code></p>
|
||
|
|
|
||
|
|
<h5>Description</h5>
|
||
|
|
|
||
|
|
<p>Get the port description.</p>
|
||
|
|
|
||
|
|
<h5>Arguments</h5>
|
||
|
|
|
||
|
|
<table border="1">
|
||
|
|
<tr>
|
||
|
|
<td><code>this&</code></td>
|
||
|
|
<td>A handle to a serial information object</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h5>Return Value</h5>
|
||
|
|
|
||
|
|
<table border="1">
|
||
|
|
<tr>
|
||
|
|
<td><code>desc$</code></td>
|
||
|
|
<td>The full name of the port (<code>KMaxPortDescription%</code>
|
||
|
|
in length). This is used only for user interaction </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<hr size="1">
|
||
|
|
|
||
|
|
<h3><a name="HighUnit">SerialInfoHighUnit</a></h3>
|
||
|
|
|
||
|
|
<h5>Usage</h5>
|
||
|
|
|
||
|
|
<p><code>unit& = SerialInfoHighUnit&:(this&)</code></p>
|
||
|
|
|
||
|
|
<h5>Description</h5>
|
||
|
|
|
||
|
|
<p>Get the highest unit number supported by the serial module.</p>
|
||
|
|
|
||
|
|
<h5>Arguments</h5>
|
||
|
|
|
||
|
|
<table border="1">
|
||
|
|
<tr>
|
||
|
|
<td><code>this&</code></td>
|
||
|
|
<td>A handle to a serial information object</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h5>Return Value</h5>
|
||
|
|
|
||
|
|
<table border="1">
|
||
|
|
<tr>
|
||
|
|
<td><code>unit&</code></td>
|
||
|
|
<td>The highest unit number supported by the serial
|
||
|
|
module</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<hr size="1">
|
||
|
|
|
||
|
|
<h3><a name="LowUnit">SerialInfoLowUnit</a></h3>
|
||
|
|
|
||
|
|
<h5>Usage</h5>
|
||
|
|
|
||
|
|
<p><code>unit& = SerialInfoLowUnit&:(this&)</code></p>
|
||
|
|
|
||
|
|
<h5>Description</h5>
|
||
|
|
|
||
|
|
<p>Get the lowest unit number supported by the serial module.</p>
|
||
|
|
|
||
|
|
<h5>Arguments</h5>
|
||
|
|
|
||
|
|
<table border="1">
|
||
|
|
<tr>
|
||
|
|
<td><code>this&</code></td>
|
||
|
|
<td>A handle to a serial information object</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h5>Return Value</h5>
|
||
|
|
|
||
|
|
<table border="1">
|
||
|
|
<tr>
|
||
|
|
<td><code>unit&</code></td>
|
||
|
|
<td>The lowest unit number supported by the serial module</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h5>Note</h5>
|
||
|
|
|
||
|
|
<p>The lowest port need not necessarily be numbered zero. </p>
|
||
|
|
|
||
|
|
<hr size="1">
|
||
|
|
|
||
|
|
<h3><a name="Name">SerialInfoName</a></h3>
|
||
|
|
|
||
|
|
<h5>Usage</h5>
|
||
|
|
|
||
|
|
<p><code>name$ = SerialInfoName$:(this&)</code></p>
|
||
|
|
|
||
|
|
<h5>Description</h5>
|
||
|
|
|
||
|
|
<p>Get the short name of the port.</p>
|
||
|
|
|
||
|
|
<h5>Arguments</h5>
|
||
|
|
|
||
|
|
<table border="1">
|
||
|
|
<tr>
|
||
|
|
<td><code>this&</code></td>
|
||
|
|
<td>A handle to a serial information object</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h5>Return Value</h5>
|
||
|
|
|
||
|
|
<table border="1">
|
||
|
|
<tr>
|
||
|
|
<td><code>name$</code></td>
|
||
|
|
<td>The short name of the port (<code>KMaxPortName%</code>
|
||
|
|
in length). This is used in calls to <a
|
||
|
|
href="../DOCUME~1/comm.htm#Open"><code>CommOpen</code></a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h5>Note</h5>
|
||
|
|
|
||
|
|
<p>The full name of the serial port (used when opening it)
|
||
|
|
consists of the name returned by <code>SerialInfoName</code>,
|
||
|
|
followed by a double colon separator, followed by the unit number
|
||
|
|
as an ASCII number (for instance <font size="4"><tt>COMM::0</tt></font>).
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<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="devcomm.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="../DOCUME~1/charsize.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="../DOCUME~1/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>
|