Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_r_process_client.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: RProcessClient Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>RProcessClient Class Reference</h1><!-- doxytag: class="RProcessClient" -->
<p>
<a href="class_r_process_client-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#363afab5db2bd5f1bdb94eb2d2604d7d">Connect</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#a7bd9ded2aeadfd0045bb4d72c2f265e">OpenDriver</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#bd90b378adab67b51920841c9979651c">Send</a> (const TDesC8 &aBuf, TRequestStatus &aStatus)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#182846342d293c4b3e4e28eb45a350a7">SendCancel</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#f16ca75a38a34ce5845d8306be97d5ce">UnloadDeviceDriver</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_process_client.html#5ba4941db07032faf602c8b0f80ef073">LoadDeviceDriver</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Client interface for process server
<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" name="363afab5db2bd5f1bdb94eb2d2604d7d"></a><!-- doxytag: member="RProcessClient::Connect" ref="363afab5db2bd5f1bdb94eb2d2604d7d" 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> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connects to the server, attempting to start it if necessary. <dl class="return" compact><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><p>
<a class="anchor" name="a7bd9ded2aeadfd0045bb4d72c2f265e"></a><!-- doxytag: member="RProcessClient::OpenDriver" ref="a7bd9ded2aeadfd0045bb4d72c2f265e" 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> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Opens the device driver's logical channel. <dl class="return" compact><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><p>
<a class="anchor" name="bd90b378adab67b51920841c9979651c"></a><!-- doxytag: member="RProcessClient::Send" ref="bd90b378adab67b51920841c9979651c" args="(const TDesC8 &aBuf, TRequestStatus &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 & </td>
<td class="paramname"> <em>aBuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRequestStatus & </td>
<td class="paramname"> <em>aStatus</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sends data to device (asynchronous request). <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aBuf</em> </td><td>A descriptor which contains the data to be sent. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aStatus</em> </td><td>A TRequestStatus reference. </td></tr>
</table>
</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><p>
<a class="anchor" name="182846342d293c4b3e4e28eb45a350a7"></a><!-- doxytag: member="RProcessClient::SendCancel" ref="182846342d293c4b3e4e28eb45a350a7" 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> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cancels sending request.
<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><p>
<a class="anchor" name="f16ca75a38a34ce5845d8306be97d5ce"></a><!-- doxytag: member="RProcessClient::UnloadDeviceDriver" ref="f16ca75a38a34ce5845d8306be97d5ce" 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> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unloads the device driver. <dl class="return" compact><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><p>
<a class="anchor" name="5ba4941db07032faf602c8b0f80ef073"></a><!-- doxytag: member="RProcessClient::LoadDeviceDriver" ref="5ba4941db07032faf602c8b0f80ef073" 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> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Loads the device driver. <dl class="return" compact><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><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:08 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>