Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_r_process_client.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: RProcessClient Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>RProcessClient Class Reference</h1><!-- doxytag: class="RProcessClient" --><!-- doxytag: inherits="RSessionBase" -->
<p>Inherits RSessionBase.</p>

<p><a href="class_r_process_client-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#a363afab5db2bd5f1bdb94eb2d2604d7d">Connect</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#aa7bd9ded2aeadfd0045bb4d72c2f265e">OpenDriver</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#abd90b378adab67b51920841c9979651c">Send</a> (const TDesC8 &amp;aBuf, TRequestStatus &amp;aStatus)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#a182846342d293c4b3e4e28eb45a350a7">SendCancel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#af16ca75a38a34ce5845d8306be97d5ce">UnloadDeviceDriver</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#a5ba4941db07032faf602c8b0f80ef073">LoadDeviceDriver</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Client interface for process server </p>

<p>Definition at line <a class="el" href="processclient_8h_source.html#l00025">25</a> of file <a class="el" href="processclient_8h_source.html">processclient.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a363afab5db2bd5f1bdb94eb2d2604d7d"></a><!-- doxytag: member="RProcessClient::Connect" ref="a363afab5db2bd5f1bdb94eb2d2604d7d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EXPORT_C TInt RProcessClient::Connect </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Connects to the server, attempting to start it if necessary. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The error value. </dd></dl>

<p>Definition at line <a class="el" href="processclient_8cpp_source.html#l00067">67</a> of file <a class="el" href="processclient_8cpp_source.html">processclient.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aa7bd9ded2aeadfd0045bb4d72c2f265e"></a><!-- doxytag: member="RProcessClient::OpenDriver" ref="aa7bd9ded2aeadfd0045bb4d72c2f265e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EXPORT_C TInt RProcessClient::OpenDriver </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Opens the device driver's logical channel. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the other system wide error codes. </dd></dl>

<p>Definition at line <a class="el" href="processclient_8cpp_source.html#l00105">105</a> of file <a class="el" href="processclient_8cpp_source.html">processclient.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="abd90b378adab67b51920841c9979651c"></a><!-- doxytag: member="RProcessClient::Send" ref="abd90b378adab67b51920841c9979651c" args="(const TDesC8 &amp;aBuf, TRequestStatus &amp;aStatus)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EXPORT_C void RProcessClient::Send </td>
          <td>(</td>
          <td class="paramtype">const TDesC8 &amp;&nbsp;</td>
          <td class="paramname"> <em>aBuf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TRequestStatus &amp;&nbsp;</td>
          <td class="paramname"> <em>aStatus</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sends data to device (asynchronous request). </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aBuf</em>&nbsp;</td><td>A descriptor which contains the data to be sent. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aStatus</em>&nbsp;</td><td>A TRequestStatus reference. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="processclient_8cpp_source.html#l00114">114</a> of file <a class="el" href="processclient_8cpp_source.html">processclient.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a182846342d293c4b3e4e28eb45a350a7"></a><!-- doxytag: member="RProcessClient::SendCancel" ref="a182846342d293c4b3e4e28eb45a350a7" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EXPORT_C void RProcessClient::SendCancel </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Cancels sending request. </p>

<p>Definition at line <a class="el" href="processclient_8cpp_source.html#l00121">121</a> of file <a class="el" href="processclient_8cpp_source.html">processclient.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="af16ca75a38a34ce5845d8306be97d5ce"></a><!-- doxytag: member="RProcessClient::UnloadDeviceDriver" ref="af16ca75a38a34ce5845d8306be97d5ce" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EXPORT_C TInt RProcessClient::UnloadDeviceDriver </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Unloads the device driver. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the other system wide error codes. </dd></dl>

<p>Definition at line <a class="el" href="processclient_8cpp_source.html#l00129">129</a> of file <a class="el" href="processclient_8cpp_source.html">processclient.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a5ba4941db07032faf602c8b0f80ef073"></a><!-- doxytag: member="RProcessClient::LoadDeviceDriver" ref="a5ba4941db07032faf602c8b0f80ef073" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EXPORT_C TInt RProcessClient::LoadDeviceDriver </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Loads the device driver. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the other system wide error codes. </dd></dl>

<p>Definition at line <a class="el" href="processclient_8cpp_source.html#l00137">137</a> of file <a class="el" href="processclient_8cpp_source.html">processclient.cpp</a>.</p>

</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>