ccoms-html/remoteli.htm

679 lines
17 KiB
HTML
Raw Normal View History

2024-09-26 19:21:23 +00:00
<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
<title>RemoteLink 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="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>RemoteLink 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>NewRemoteLink -
Constructor</strong></a></li>
<li><a href="#DeleteCommServ"><strong>DeleteRemoteLink
- Destructor</strong></a></li>
</ul>
</li>
<li><a href="#Methods provided"><strong>Methods provided</strong></a><ul>
<li><a href="#Description"><strong>RemoteLinkCancelAll</strong></a></li>
<li><a href="#CancelLoadRemoteServer"><strong>RemoteLinkCancelRemoteServer</strong></a></li>
<li><a href="#CancelNotifyStatusChange"><strong>RemoteLinkCancelNotifyStatusChng</strong></a></li>
<li><a href="#Close"><strong>RemoteLinkeClose</strong></a></li>
<li><a href="#Config"><strong>RemoteLinkConfig</strong></a></li>
<li><a href="#Disable"><strong>RemoteLinkDisable</strong></a></li>
<li><a href="#Enable"><strong>RemoteLinkEnable</strong></a></li>
<li><a href="#EnableFileAccess"><strong>RemoteLinkEnableFileAccess</strong></a></li>
<li><a href="#LoadLocalServer"><strong>RemoteLinkLoadLocalServer</strong></a></li>
<li><a href="#LoadRemoteServerA"><strong>RemoteLinkLoadRemoteServerA</strong></a></li>
<li><a href="#NotifyStatusChange"><strong>RemoteLinkNotifyStatusChange</strong></a></li>
<li><a href="#Open"><strong>RemoteLinkOpen</strong></a></li>
<li><a href="#Status"><strong>RemoteLinkStatus</strong></a></li>
<li><a href="#UnloadLocalServer"><strong>RemoteLinkUnloadLocalServer</strong></a></li>
<li><a href="#Version"><strong>RemoteLinkVersion</strong></a></li>
<li><a href="#WaitForConnect"><strong>RemoteLinkWaitForConnect</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>
<hr>
<h2><a name="Construction">Construction / destruction</a></h2>
<hr size="1">
<h3><a name="NewCommServ">NewRemoteLink - Constructor</a></h3>
<h5>Usage</h5>
<p><code>this&amp; = NewRemoteLink&amp;:</code></p>
<h5>Description</h5>
<p>Creates a remote linkobject 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; = NewRemoteLink&amp;:</strong>
DeleteRemoteLink:(this&amp;) </pre>
<hr size="1">
<h3><a name="DeleteCommServ">DeleteRemoteLink - Destructor</a></h3>
<h5>Usage</h5>
<p><code>DeleteSerialInfo:(BYREF this&amp;)</code></p>
<h5>Description</h5>
<p>Destroys the remote link object.</p>
<h5>Arguments</h5>
<table border="1">
<tr>
<td><code>BYREF this&amp;</code></td>
<td>A handle to a remote link object</td>
</tr>
</table>
<h5>Example</h5>
<pre> LOCAL this&amp;
this&amp; = NewRemoteLink&amp;:
<strong>DeleteRemoteLink:(this&amp;)</strong> </pre>
<hr>
<h2><a name="Methods provided">Methods provided</a></h2>
<hr size="1">
<h3><a name="CancelAll">RemoteLinkCancelAll</a></h3>
<h5>Usage</h5>
<p><code>RemoteLinkCancelAll:(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 remote link object</td>
</tr>
</table>
<hr size="1">
<h3><a name="CancelLoadRemoteServer">RemoteLinkCancelLoadRemoteServer</a></h3>
<h5>Usage</h5>
<p><code>RemoteLinkCancelLoadRemoteServer:(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 remote link object</td>
</tr>
</table>
<hr size="1">
<h3><a name="CancelNotifyStatusChange">RemoteLinkCancelNotifyStatusChng</a></h3>
<h5>Usage</h5>
<p><code>RemoteLinkCancelNotifyStatusChng:(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 remote link object</td>
</tr>
</table>
<hr size="1">
<h3><a name="Close">RemoteLinkClose</a></h3>
<h5>Usage</h5>
<p><code>RemoteLinkClose:(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 remote link object</td>
</tr>
</table>
<hr size="1">
<h3><a name="Config">RemoteLinkConfig</a></h3>
<h5>Usage</h5>
<p><code>result% = RemoteLinkConfig%:(this&amp;,BYREF port&amp;,
BYREF module&amp;, BYREF lowPowerMode%)</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 remote link object</td>
</tr>
<tr>
<td><code>BYREF port&amp;</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
<tr>
<td><code>BYREF module&amp;</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
<tr>
<td><code>BYREF lowPowerMode%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<h5>Return Value</h5>
<table border="1">
<tr>
<td><code>result%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<hr size="1">
<h3><a name="Disable">RemoteLinkDisable</a></h3>
<h5>Usage</h5>
<p><code>result% = RemoteLinkDisable%:(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 remote link object</td>
</tr>
</table>
<h5>Return Value</h5>
<table border="1">
<tr>
<td><code>result%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<hr size="1">
<h3><a name="Enable">RemoteLinkEnable</a></h3>
<h5>Usage</h5>
<p><code>result% = RemoteLinkEnable%:(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 remote link object</td>
</tr>
</table>
<h5>Return Value</h5>
<table border="1">
<tr>
<td><code>result%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<hr size="1">
<h3><a name="EnableFileAccess">RemoteLinkEnableFileAccess</a></h3>
<h5>Usage</h5>
<p><code>result% = RemoteLinkEnableFileAccess%:(this&amp;,enable%)</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 remote link object</td>
</tr>
<tr>
<td><code>enable%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<h5>Return Value</h5>
<table border="1">
<tr>
<td><code>result%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<hr size="1">
<h3><a name="LoadLocalServer">RemoteLinkLoadLocalServer</a></h3>
<h5>Usage</h5>
<p><code>result% = RemoteLinkLoadLocalServer%:(this&amp;,result&amp;,filename$,args$)</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 remote link object</td>
</tr>
<tr>
<td><code>result&amp;</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
<tr>
<td><code>filename$</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
<tr>
<td><code>args$</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<h5>Return Value</h5>
<table border="1">
<tr>
<td><code>result%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<hr size="1">
<h3><a name="LoadRemoteServerA">RemoteLinkLoadRemoteServerA</a></h3>
<h5>Usage</h5>
<p><code>RemoteLinkLoadRemoteServerA:(this&amp;,result&amp;,filename$,args$,BYREF
status&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 remote link object</td>
</tr>
<tr>
<td><code>result&amp;</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
<tr>
<td><code>filename$</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
<tr>
<td><code>args$</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
<tr>
<td><code>BYREF status&amp;</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<hr size="1">
<h3><a name="NotifyStatusChange">RemoteLinkNotifyStatusChange</a></h3>
<h5>Usage</h5>
<p><code>RemoteLinkNotifyStatusChange:(this&amp;,BYREF status&amp;,state&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 remote link object</td>
</tr>
<tr>
<td><code>BYREF status&amp;</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
<tr>
<td><code>state&amp;</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<hr size="1">
<h3><a name="Open">RemoteLinkOpen</a></h3>
<h5>Usage</h5>
<p><code>result% = RemoteLinkOpen%:(this&amp;,interface%)</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 remote link object</td>
</tr>
<tr>
<td><code>interface%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<h5>Return Value</h5>
<table border="1">
<tr>
<td><code>result%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<hr size="1">
<h3><a name="Status">RemoteLinkStatus</a></h3>
<h5>Usage</h5>
<p><code>result% = RemoteLinkStatus%:(this&amp;,status&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 remote link object</td>
</tr>
<tr>
<td><code>status&amp;</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<h5>Return Value</h5>
<table border="1">
<tr>
<td><code>result%</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<hr size="1">
<h3><a name="UnloadLocalServer">RemoteLinkUnloadLocalServer</a></h3>
<h5>Usage</h5>
<p><code>RemoteLinkStatus%:(this&amp;,name$)</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 remote link object</td>
</tr>
<tr>
<td><code>name$</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<hr size="1">
<h3><a name="Version">RemoteLinkVersion</a></h3>
<h5>Usage</h5>
<p><code>version&amp; = RemoteLinkStatus&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 remote link object</td>
</tr>
</table>
<h5>Return Value</h5>
<table border="1">
<tr>
<td><code>version&amp;</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
</table>
<hr size="1">
<h3><a name="WaitForConnect">RemoteLinkWaitForConnect</a></h3>
<h5>Usage</h5>
<p><code>RemoteLinkWaitForConnect:(this&amp;,BYREF status&amp;,state&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 remote link object</td>
</tr>
<tr>
<td><code>BYREF status&amp;</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></td>
</tr>
<tr>
<td><code>state&amp;</code></td>
<td><font color="#FF0000">&lt;TBS&gt;</font></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="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>