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

302 lines
8.4 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>CommServerConfigV01</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="commserv.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="../Documentation/devcomm.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>CommServerConfig 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>NewCommServerConfig
- Constructor</strong></a></li>
<li><a href="#DeleteCommServ"><strong>DeleteCommServerConfig
- Destructor</strong></a></li>
</ul>
</li>
<li><a href="#Methods provided"><strong>Methods provided</strong></a><ul>
<li><a href="#BufFlags"><strong>CommServerConfigBufFlags</strong></a></li>
<li><a href="#BufFlags"><strong>CommServerConfigBufSize</strong></a></li>
<li><a href="#BufFlags"><strong>CommServerConfigSetBufFlags</strong></a></li>
<li><a href="#BufFlags"><strong>CommServerConfigSetBufSize</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="comm.htm#Config"><code>CommConfig</code></a></p>
<hr>
<h2><a name="Construction">Construction / destruction</a></h2>
<hr size="1">
<h3><a name="NewCommServ">NewCommServerConfig - Constructor</a></h3>
<h5>Usage</h5>
<p><code>this&amp; = NewCommServerConfig&amp;:</code></p>
<h5>Description</h5>
<p>Creates a comms server configuration 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 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; = NewCommServerConfig&amp;:</strong>
DeleteCommServerConfig:(this&amp;) </pre>
<hr size="1">
<h3><a name="DeleteCommServ">DeleteCommServerConfig - Destructor</a></h3>
<h5>Usage</h5>
<p><code>DeleteCommServerConfig:(BYREF this&amp;)</code></p>
<h5>Description</h5>
<p>Destroys the comms server configuration object.</p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>BYREF this&amp;</code></td>
<td>A handle to a comms server configuration object</td>
</tr>
</table>
<h5>Example</h5>
<pre> LOCAL this&amp;
this&amp; = NewCommServerConfig&amp;:
<strong>DeleteCommServerConfig:(this&amp;)</strong> </pre>
<hr>
<h2><a name="Methods provided">Methods provided</a></h2>
<hr size="1">
<h3>CommServerConfig<a name="BufFlags">BufFlags</a></h3>
<h5>Usage</h5>
<p><code>flags&amp; = CommServerConfigBufFlags&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p>Either <font size="4"><tt>KCommBufferFull</tt></font> or <font
size="4"><tt>KCommBufferPartial</tt></font>.</p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a comms server configuration object</td>
</tr>
</table>
<h5>Returns</h5>
<table border="1">
<tr>
<td><code>flags&amp;</code></td>
<td>The <a href="../Documentation/buffer.htm">buffer
flags</a></td>
</tr>
</table>
<hr size="1">
<h3>CommServerConfig<a name="BufSize">BufSize</a></h3>
<h5>Usage</h5>
<p><code>size&amp; = CommServerConfigBufSize&amp;:(this&amp;)</code></p>
<h5>Description</h5>
<p>Size of server buffer if partial buffering is being used</p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a comms server configuration object</td>
</tr>
</table>
<h5>Returns</h5>
<table border="1">
<tr>
<td><code>size&amp;</code></td>
<td>Size of server buffer if partial buffering is being
used</td>
</tr>
</table>
<hr size="1">
<h3>CommServerConfig<a name="SetBufFlags">SetBufFlags</a></h3>
<h5>Usage</h5>
<p><code>CommServerConfigSetBufFlags:(this&amp;,flags&amp;)</code></p>
<h5>Description</h5>
<p>Either <font size="4"><tt>KCommBufferFull</tt></font> or <font
size="4"><tt>KCommBufferPartial</tt></font>r.</p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a comms server configuration object</td>
</tr>
<tr>
<td><code>flags&amp;</code></td>
<td>The <a href="../Documentation/buffer.htm">buffer
flags</a></td>
</tr>
</table>
<hr size="1">
<h3>CommServerConfig<a name="BufSize">SetBufSize</a></h3>
<h5>Usage</h5>
<p><code>CommServerConfigSetBufSize:(this&amp;,size&amp;)</code></p>
<h5>Description</h5>
<p>Sets the size of server buffer if partial buffering is being
used</p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>this&amp;</code></td>
<td>A handle to a comms server configuration object</td>
</tr>
<tr>
<td><code>size&amp;</code></td>
<td>Size of server buffer if partial buffering is being
used</td>
</tr>
</table>
<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="commserv.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="../Documentation/devcomm.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