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: RDriver1 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>RDriver1 Class Reference</h1><!-- doxytag: class="RDriver1" -->
<p><a href="class_r_driver1-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1_1_1_t_caps.html">TCaps</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1_1_1_t_config.html">TConfig</a></td></tr>
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1aa1c078824a79d07da05b1a7fdae816"></a><!-- doxytag: member="RDriver1::TConfigBuf" ref="a1aa1c078824a79d07da05b1a7fdae816" args="" -->
typedef TPckgBuf< <a class="el" href="class_r_driver1_1_1_t_config.html">TConfig</a> > </td><td class="memItemRight" valign="bottom"><b>TConfigBuf</b></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#af30696b673cd91e87f9c7497a72798eb">Open</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#ac728a3fa6f4d51b284bcee48d8cc3f4a">GetConfig</a> (TConfigBuf &aConfig)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#a22e5408e8d1216fe3581ec154c2632a1">SetConfig</a> (const TConfigBuf &aConfig)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#a2b99c6487e8916a54720d8eb3071cd85">SendData</a> (TRequestStatus &aStatus, const TDesC8 &aData)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#a3a9b32b811f9bec9b3317d2b187b8417">SendDataCancel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#a7e192c22f84adc61b6418cd6ffb65526">ReceiveData</a> (TRequestStatus &aStatus, TDes8 &aBuffer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#ac6bee07d661dfd83a14516aa964672bb">ReceiveDataCancel</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const TDesC & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#a7e98e9f7ec04a53a404d646481f589ca">Name</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static TVersion </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#a7d1f08b59801b5890fb77666e14d5e8f">VersionRequired</a> ()</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3dc837125ab7311c8533472f93e390b0"></a><!-- doxytag: member="RDriver1::DDriver1Channel" ref="a3dc837125ab7311c8533472f93e390b0" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#a3dc837125ab7311c8533472f93e390b0">DDriver1Channel</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>User interface for 'Driver1' </p>
<p>Definition at line <a class="el" href="driver1_8h_source.html#l00035">35</a> of file <a class="el" href="driver1_8h_source.html">driver1.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af30696b673cd91e87f9c7497a72798eb"></a><!-- doxytag: member="RDriver1::Open" ref="af30696b673cd91e87f9c7497a72798eb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt RDriver1::Open </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Opens a logical channel to the driver </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the system wide error codes. </dd></dl>
<p>Definition at line <a class="el" href="driver1_8h_source.html#l00129">129</a> of file <a class="el" href="driver1_8h_source.html">driver1.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac728a3fa6f4d51b284bcee48d8cc3f4a"></a><!-- doxytag: member="RDriver1::GetConfig" ref="ac728a3fa6f4d51b284bcee48d8cc3f4a" args="(TConfigBuf &aConfig)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt RDriver1::GetConfig </td>
<td>(</td>
<td class="paramtype">TConfigBuf & </td>
<td class="paramname"> <em>aConfig</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the current configuration settings. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aConfig</em> </td><td>A structure which will be filled with the configuration settings. </td></tr>
</table>
</dd>
</dl>
<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="driver1_8h_source.html#l00139">139</a> of file <a class="el" href="driver1_8h_source.html">driver1.h</a>.</p>
</div>
</div>
<a class="anchor" id="a22e5408e8d1216fe3581ec154c2632a1"></a><!-- doxytag: member="RDriver1::SetConfig" ref="a22e5408e8d1216fe3581ec154c2632a1" args="(const TConfigBuf &aConfig)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt RDriver1::SetConfig </td>
<td>(</td>
<td class="paramtype">const TConfigBuf & </td>
<td class="paramname"> <em>aConfig</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the current configuration settings. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aConfig</em> </td><td>The new configuration settings to be used. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>KErrInUse if there are outstanding data transfer requests. KErrArgument if any configuration values are invalid. KErrNone otherwise </dd></dl>
<p>Definition at line <a class="el" href="driver1_8h_source.html#l00151">151</a> of file <a class="el" href="driver1_8h_source.html">driver1.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2b99c6487e8916a54720d8eb3071cd85"></a><!-- doxytag: member="RDriver1::SendData" ref="a2b99c6487e8916a54720d8eb3071cd85" args="(TRequestStatus &aStatus, const TDesC8 &aData)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RDriver1::SendData </td>
<td>(</td>
<td class="paramtype">TRequestStatus & </td>
<td class="paramname"> <em>aStatus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC8 & </td>
<td class="paramname"> <em>aData</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends data to the device. Only one send request may be pending at any time. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aStatus</em> </td><td>The request to be signalled when the data has been sent. The return value will be set to KErrNone on success; or to one of the system wide error codes when an error occurs. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aData</em> </td><td>A descriptor containing the data to be sent. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="driver1_8h_source.html#l00164">164</a> of file <a class="el" href="driver1_8h_source.html">driver1.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3a9b32b811f9bec9b3317d2b187b8417"></a><!-- doxytag: member="RDriver1::SendDataCancel" ref="a3a9b32b811f9bec9b3317d2b187b8417" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RDriver1::SendDataCancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancels a previous SendData request. </p>
<p>Definition at line <a class="el" href="driver1_8h_source.html#l00172">172</a> of file <a class="el" href="driver1_8h_source.html">driver1.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7e192c22f84adc61b6418cd6ffb65526"></a><!-- doxytag: member="RDriver1::ReceiveData" ref="a7e192c22f84adc61b6418cd6ffb65526" args="(TRequestStatus &aStatus, TDes8 &aBuffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RDriver1::ReceiveData </td>
<td>(</td>
<td class="paramtype">TRequestStatus & </td>
<td class="paramname"> <em>aStatus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDes8 & </td>
<td class="paramname"> <em>aBuffer</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receives data from the device. Only one receive request may be pending at any time. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aStatus</em> </td><td>The request to be signalled when the data has been received. The return value will be set to KErrNone on success; or to one of the system wide error codes when an error occurs. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aBuffer</em> </td><td>A descriptor to which the received data will be written. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="driver1_8h_source.html#l00185">185</a> of file <a class="el" href="driver1_8h_source.html">driver1.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac6bee07d661dfd83a14516aa964672bb"></a><!-- doxytag: member="RDriver1::ReceiveDataCancel" ref="ac6bee07d661dfd83a14516aa964672bb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RDriver1::ReceiveDataCancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancels a previous <a class="el" href="class_r_driver1.html#a7e192c22f84adc61b6418cd6ffb65526">ReceiveData()</a> request. </p>
<p>Definition at line <a class="el" href="driver1_8h_source.html#l00193">193</a> of file <a class="el" href="driver1_8h_source.html">driver1.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7e98e9f7ec04a53a404d646481f589ca"></a><!-- doxytag: member="RDriver1::Name" ref="a7e98e9f7ec04a53a404d646481f589ca" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const TDesC & RDriver1::Name </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the driver's name. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The name of the driver </dd></dl>
<p>Definition at line <a class="el" href="driver1_8h_source.html#l00100">100</a> of file <a class="el" href="driver1_8h_source.html">driver1.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7d1f08b59801b5890fb77666e14d5e8f"></a><!-- doxytag: member="RDriver1::VersionRequired" ref="a7d1f08b59801b5890fb77666e14d5e8f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVersion RDriver1::VersionRequired </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the driver's version. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The version number of the driver </dd></dl>
<p>Definition at line <a class="el" href="driver1_8h_source.html#l00110">110</a> of file <a class="el" href="driver1_8h_source.html">driver1.h</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>