1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
2 <html xmlns="http://www.w3.org/1999/xhtml"> |
3 <title>TB10.1 Example Applications: RDriver1 Class Reference</title> |
3 <head> |
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> |
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
5 <link href="tabs.css" rel="stylesheet" type="text/css"> |
5 <title>TB9.2 Example Applications: RDriver1 Class Reference</title> |
6 </head><body> |
6 <link href="tabs.css" rel="stylesheet" type="text/css"/> |
7 <!-- Generated by Doxygen 1.5.3 --> |
7 <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
8 </head> |
|
9 <body> |
|
10 <!-- Generated by Doxygen 1.6.2 --> |
|
11 <div class="contents"> |
8 <h1>RDriver1 Class Reference</h1><!-- doxytag: class="RDriver1" --> |
12 <h1>RDriver1 Class Reference</h1><!-- doxytag: class="RDriver1" --> |
9 <p> |
13 <p><a href="class_r_driver1-members.html">List of all members.</a></p> |
10 <a href="class_r_driver1-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
14 <table border="0" cellpadding="0" cellspacing="0"> |
11 <tr><td></td></tr> |
15 <tr><td colspan="2"><h2>Classes</h2></td></tr> |
12 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> |
16 <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> |
13 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1aa1c078824a79d07da05b1a7fdae816"></a><!-- doxytag: member="RDriver1::TConfigBuf" ref="1aa1c078824a79d07da05b1a7fdae816" args="" --> |
17 <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> |
14 typedef TPckgBuf<br> |
18 <tr><td colspan="2"><h2>Public Types</h2></td></tr> |
15 < <a class="el" href="class_r_driver1_1_1_t_config.html">TConfig</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#1aa1c078824a79d07da05b1a7fdae816">TConfigBuf</a></td></tr> |
19 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1aa1c078824a79d07da05b1a7fdae816"></a><!-- doxytag: member="RDriver1::TConfigBuf" ref="a1aa1c078824a79d07da05b1a7fdae816" args="" --> |
16 |
20 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> |
17 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
21 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> |
18 <tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#f30696b673cd91e87f9c7497a72798eb">Open</a> ()</td></tr> |
22 <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> |
19 |
23 <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> |
20 <tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#c728a3fa6f4d51b284bcee48d8cc3f4a">GetConfig</a> (<a class="el" href="class_r_driver1.html#1aa1c078824a79d07da05b1a7fdae816">TConfigBuf</a> &aConfig)</td></tr> |
24 <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> |
21 |
25 <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> |
22 <tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#22e5408e8d1216fe3581ec154c2632a1">SetConfig</a> (const <a class="el" href="class_r_driver1.html#1aa1c078824a79d07da05b1a7fdae816">TConfigBuf</a> &aConfig)</td></tr> |
26 <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> |
23 |
27 <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> |
24 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#2b99c6487e8916a54720d8eb3071cd85">SendData</a> (TRequestStatus &aStatus, const TDesC8 &aData)</td></tr> |
28 <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> |
25 |
29 <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> |
26 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#3a9b32b811f9bec9b3317d2b187b8417">SendDataCancel</a> ()</td></tr> |
30 <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> |
27 |
31 <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> |
28 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#7e192c22f84adc61b6418cd6ffb65526">ReceiveData</a> (TRequestStatus &aStatus, TDes8 &aBuffer)</td></tr> |
32 <tr><td colspan="2"><h2>Friends</h2></td></tr> |
29 |
33 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3dc837125ab7311c8533472f93e390b0"></a><!-- doxytag: member="RDriver1::DDriver1Channel" ref="a3dc837125ab7311c8533472f93e390b0" args="" --> |
30 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#c6bee07d661dfd83a14516aa964672bb">ReceiveDataCancel</a> ()</td></tr> |
34 class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#a3dc837125ab7311c8533472f93e390b0">DDriver1Channel</a></td></tr> |
31 |
|
32 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> |
|
33 <tr><td class="memItemLeft" nowrap align="right" valign="top">static const TDesC & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#7e98e9f7ec04a53a404d646481f589ca">Name</a> ()</td></tr> |
|
34 |
|
35 <tr><td class="memItemLeft" nowrap align="right" valign="top">static TVersion </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#7d1f08b59801b5890fb77666e14d5e8f">VersionRequired</a> ()</td></tr> |
|
36 |
|
37 <tr><td colspan="2"><br><h2>Friends</h2></td></tr> |
|
38 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3dc837125ab7311c8533472f93e390b0"></a><!-- doxytag: member="RDriver1::DDriver1Channel" ref="3dc837125ab7311c8533472f93e390b0" args="" --> |
|
39 class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_driver1.html#3dc837125ab7311c8533472f93e390b0">DDriver1Channel</a></td></tr> |
|
40 |
|
41 <tr><td colspan="2"><br><h2>Classes</h2></td></tr> |
|
42 <tr><td class="memItemLeft" nowrap 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> |
|
43 |
|
44 <tr><td class="memItemLeft" nowrap 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> |
|
45 |
|
46 </table> |
35 </table> |
47 <hr><a name="_details"></a><h2>Detailed Description</h2> |
36 <hr/><a name="_details"></a><h2>Detailed Description</h2> |
48 User interface for 'Driver1' |
37 <p>User interface for 'Driver1' </p> |
49 <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> |
38 |
50 <hr><h2>Member Function Documentation</h2> |
39 <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> |
51 <a class="anchor" name="f30696b673cd91e87f9c7497a72798eb"></a><!-- doxytag: member="RDriver1::Open" ref="f30696b673cd91e87f9c7497a72798eb" args="()" --> |
40 <hr/><h2>Member Function Documentation</h2> |
52 <div class="memitem"> |
41 <a class="anchor" id="af30696b673cd91e87f9c7497a72798eb"></a><!-- doxytag: member="RDriver1::Open" ref="af30696b673cd91e87f9c7497a72798eb" args="()" --> |
53 <div class="memproto"> |
42 <div class="memitem"> |
54 <table class="memname"> |
43 <div class="memproto"> |
55 <tr> |
44 <table class="memname"> |
56 <td class="memname">TInt RDriver1::Open </td> |
45 <tr> |
57 <td>(</td> |
46 <td class="memname">TInt RDriver1::Open </td> |
58 <td class="paramname"> </td> |
47 <td>(</td> |
59 <td> ) </td> |
48 <td class="paramname"></td> |
60 <td width="100%"></td> |
49 <td> ) </td> |
61 </tr> |
50 <td></td> |
62 </table> |
51 </tr> |
63 </div> |
52 </table> |
64 <div class="memdoc"> |
53 </div> |
65 |
54 <div class="memdoc"> |
66 <p> |
55 <p>Opens a logical channel to the driver </p> |
67 Opens a logical channel to the driver <dl class="return" compact><dt><b>Returns:</b></dt><dd>One of the system wide error codes. </dd></dl> |
56 <dl class="return"><dt><b>Returns:</b></dt><dd>One of the system wide error codes. </dd></dl> |
68 |
57 |
69 <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> |
58 <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> |
70 |
59 |
71 </div> |
60 </div> |
72 </div><p> |
61 </div> |
73 <a class="anchor" name="c728a3fa6f4d51b284bcee48d8cc3f4a"></a><!-- doxytag: member="RDriver1::GetConfig" ref="c728a3fa6f4d51b284bcee48d8cc3f4a" args="(TConfigBuf &aConfig)" --> |
62 <a class="anchor" id="ac728a3fa6f4d51b284bcee48d8cc3f4a"></a><!-- doxytag: member="RDriver1::GetConfig" ref="ac728a3fa6f4d51b284bcee48d8cc3f4a" args="(TConfigBuf &aConfig)" --> |
74 <div class="memitem"> |
63 <div class="memitem"> |
75 <div class="memproto"> |
64 <div class="memproto"> |
76 <table class="memname"> |
65 <table class="memname"> |
77 <tr> |
66 <tr> |
78 <td class="memname">TInt RDriver1::GetConfig </td> |
67 <td class="memname">TInt RDriver1::GetConfig </td> |
79 <td>(</td> |
68 <td>(</td> |
80 <td class="paramtype"><a class="el" href="class_r_driver1.html#1aa1c078824a79d07da05b1a7fdae816">TConfigBuf</a> & </td> |
69 <td class="paramtype">TConfigBuf & </td> |
81 <td class="paramname"> <em>aConfig</em> </td> |
70 <td class="paramname"> <em>aConfig</em></td> |
82 <td> ) </td> |
71 <td> ) </td> |
83 <td width="100%"></td> |
72 <td></td> |
84 </tr> |
73 </tr> |
85 </table> |
74 </table> |
86 </div> |
75 </div> |
87 <div class="memdoc"> |
76 <div class="memdoc"> |
88 |
77 <p>Gets the current configuration settings. </p> |
89 <p> |
78 <dl><dt><b>Parameters:</b></dt><dd> |
90 Gets the current configuration settings. <dl compact><dt><b>Parameters:</b></dt><dd> |
|
91 <table border="0" cellspacing="2" cellpadding="0"> |
79 <table border="0" cellspacing="2" cellpadding="0"> |
92 <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> |
80 <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> |
93 </table> |
81 </table> |
94 </dl> |
82 </dd> |
95 <dl class="return" compact><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the other system wide error codes. </dd></dl> |
83 </dl> |
96 |
84 <dl class="return"><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the other system wide error codes. </dd></dl> |
97 <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> |
85 |
98 |
86 <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> |
99 </div> |
87 |
100 </div><p> |
88 </div> |
101 <a class="anchor" name="22e5408e8d1216fe3581ec154c2632a1"></a><!-- doxytag: member="RDriver1::SetConfig" ref="22e5408e8d1216fe3581ec154c2632a1" args="(const TConfigBuf &aConfig)" --> |
89 </div> |
102 <div class="memitem"> |
90 <a class="anchor" id="a22e5408e8d1216fe3581ec154c2632a1"></a><!-- doxytag: member="RDriver1::SetConfig" ref="a22e5408e8d1216fe3581ec154c2632a1" args="(const TConfigBuf &aConfig)" --> |
103 <div class="memproto"> |
91 <div class="memitem"> |
104 <table class="memname"> |
92 <div class="memproto"> |
105 <tr> |
93 <table class="memname"> |
106 <td class="memname">TInt RDriver1::SetConfig </td> |
94 <tr> |
107 <td>(</td> |
95 <td class="memname">TInt RDriver1::SetConfig </td> |
108 <td class="paramtype">const <a class="el" href="class_r_driver1.html#1aa1c078824a79d07da05b1a7fdae816">TConfigBuf</a> & </td> |
96 <td>(</td> |
109 <td class="paramname"> <em>aConfig</em> </td> |
97 <td class="paramtype">const TConfigBuf & </td> |
110 <td> ) </td> |
98 <td class="paramname"> <em>aConfig</em></td> |
111 <td width="100%"></td> |
99 <td> ) </td> |
112 </tr> |
100 <td></td> |
113 </table> |
101 </tr> |
114 </div> |
102 </table> |
115 <div class="memdoc"> |
103 </div> |
116 |
104 <div class="memdoc"> |
117 <p> |
105 <p>Sets the current configuration settings. </p> |
118 Sets the current configuration settings. <dl compact><dt><b>Parameters:</b></dt><dd> |
106 <dl><dt><b>Parameters:</b></dt><dd> |
119 <table border="0" cellspacing="2" cellpadding="0"> |
107 <table border="0" cellspacing="2" cellpadding="0"> |
120 <tr><td valign="top"></td><td valign="top"><em>aConfig</em> </td><td>The new configuration settings to be used. </td></tr> |
108 <tr><td valign="top"></td><td valign="top"><em>aConfig</em> </td><td>The new configuration settings to be used. </td></tr> |
121 </table> |
109 </table> |
122 </dl> |
110 </dd> |
123 <dl class="return" compact><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> |
111 </dl> |
124 |
112 <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> |
125 <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> |
113 |
126 |
114 <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> |
127 </div> |
115 |
128 </div><p> |
116 </div> |
129 <a class="anchor" name="2b99c6487e8916a54720d8eb3071cd85"></a><!-- doxytag: member="RDriver1::SendData" ref="2b99c6487e8916a54720d8eb3071cd85" args="(TRequestStatus &aStatus, const TDesC8 &aData)" --> |
117 </div> |
130 <div class="memitem"> |
118 <a class="anchor" id="a2b99c6487e8916a54720d8eb3071cd85"></a><!-- doxytag: member="RDriver1::SendData" ref="a2b99c6487e8916a54720d8eb3071cd85" args="(TRequestStatus &aStatus, const TDesC8 &aData)" --> |
131 <div class="memproto"> |
119 <div class="memitem"> |
132 <table class="memname"> |
120 <div class="memproto"> |
133 <tr> |
121 <table class="memname"> |
134 <td class="memname">void RDriver1::SendData </td> |
122 <tr> |
|
123 <td class="memname">void RDriver1::SendData </td> |
135 <td>(</td> |
124 <td>(</td> |
136 <td class="paramtype">TRequestStatus & </td> |
125 <td class="paramtype">TRequestStatus & </td> |
137 <td class="paramname"> <em>aStatus</em>, </td> |
126 <td class="paramname"> <em>aStatus</em>, </td> |
138 </tr> |
127 </tr> |
139 <tr> |
128 <tr> |
143 <td class="paramname"> <em>aData</em></td><td> </td> |
132 <td class="paramname"> <em>aData</em></td><td> </td> |
144 </tr> |
133 </tr> |
145 <tr> |
134 <tr> |
146 <td></td> |
135 <td></td> |
147 <td>)</td> |
136 <td>)</td> |
148 <td></td><td></td><td width="100%"></td> |
137 <td></td><td></td><td></td> |
149 </tr> |
138 </tr> |
150 </table> |
139 </table> |
151 </div> |
140 </div> |
152 <div class="memdoc"> |
141 <div class="memdoc"> |
153 |
142 <p>Sends data to the device. Only one send request may be pending at any time. </p> |
154 <p> |
143 <dl><dt><b>Parameters:</b></dt><dd> |
155 Sends data to the device. Only one send request may be pending at any time. <dl compact><dt><b>Parameters:</b></dt><dd> |
|
156 <table border="0" cellspacing="2" cellpadding="0"> |
144 <table border="0" cellspacing="2" cellpadding="0"> |
157 <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> |
145 <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> |
158 <tr><td valign="top"></td><td valign="top"><em>aData</em> </td><td>A descriptor containing the data to be sent. </td></tr> |
146 <tr><td valign="top"></td><td valign="top"><em>aData</em> </td><td>A descriptor containing the data to be sent. </td></tr> |
159 </table> |
147 </table> |
160 </dl> |
148 </dd> |
161 |
149 </dl> |
162 <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> |
150 |
163 |
151 <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> |
164 </div> |
152 |
165 </div><p> |
153 </div> |
166 <a class="anchor" name="3a9b32b811f9bec9b3317d2b187b8417"></a><!-- doxytag: member="RDriver1::SendDataCancel" ref="3a9b32b811f9bec9b3317d2b187b8417" args="()" --> |
154 </div> |
167 <div class="memitem"> |
155 <a class="anchor" id="a3a9b32b811f9bec9b3317d2b187b8417"></a><!-- doxytag: member="RDriver1::SendDataCancel" ref="a3a9b32b811f9bec9b3317d2b187b8417" args="()" --> |
168 <div class="memproto"> |
156 <div class="memitem"> |
169 <table class="memname"> |
157 <div class="memproto"> |
170 <tr> |
158 <table class="memname"> |
171 <td class="memname">void RDriver1::SendDataCancel </td> |
159 <tr> |
172 <td>(</td> |
160 <td class="memname">void RDriver1::SendDataCancel </td> |
173 <td class="paramname"> </td> |
161 <td>(</td> |
174 <td> ) </td> |
162 <td class="paramname"></td> |
175 <td width="100%"></td> |
163 <td> ) </td> |
176 </tr> |
164 <td></td> |
177 </table> |
165 </tr> |
178 </div> |
166 </table> |
179 <div class="memdoc"> |
167 </div> |
180 |
168 <div class="memdoc"> |
181 <p> |
169 <p>Cancels a previous SendData request. </p> |
182 Cancels a previous SendData request. |
170 |
183 <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> |
171 <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> |
184 |
172 |
185 </div> |
173 </div> |
186 </div><p> |
174 </div> |
187 <a class="anchor" name="7e192c22f84adc61b6418cd6ffb65526"></a><!-- doxytag: member="RDriver1::ReceiveData" ref="7e192c22f84adc61b6418cd6ffb65526" args="(TRequestStatus &aStatus, TDes8 &aBuffer)" --> |
175 <a class="anchor" id="a7e192c22f84adc61b6418cd6ffb65526"></a><!-- doxytag: member="RDriver1::ReceiveData" ref="a7e192c22f84adc61b6418cd6ffb65526" args="(TRequestStatus &aStatus, TDes8 &aBuffer)" --> |
188 <div class="memitem"> |
176 <div class="memitem"> |
189 <div class="memproto"> |
177 <div class="memproto"> |
190 <table class="memname"> |
178 <table class="memname"> |
191 <tr> |
179 <tr> |
192 <td class="memname">void RDriver1::ReceiveData </td> |
180 <td class="memname">void RDriver1::ReceiveData </td> |
193 <td>(</td> |
181 <td>(</td> |
194 <td class="paramtype">TRequestStatus & </td> |
182 <td class="paramtype">TRequestStatus & </td> |
195 <td class="paramname"> <em>aStatus</em>, </td> |
183 <td class="paramname"> <em>aStatus</em>, </td> |
196 </tr> |
184 </tr> |
197 <tr> |
185 <tr> |
201 <td class="paramname"> <em>aBuffer</em></td><td> </td> |
189 <td class="paramname"> <em>aBuffer</em></td><td> </td> |
202 </tr> |
190 </tr> |
203 <tr> |
191 <tr> |
204 <td></td> |
192 <td></td> |
205 <td>)</td> |
193 <td>)</td> |
206 <td></td><td></td><td width="100%"></td> |
194 <td></td><td></td><td></td> |
207 </tr> |
195 </tr> |
208 </table> |
196 </table> |
209 </div> |
197 </div> |
210 <div class="memdoc"> |
198 <div class="memdoc"> |
211 |
199 <p>Receives data from the device. Only one receive request may be pending at any time. </p> |
212 <p> |
200 <dl><dt><b>Parameters:</b></dt><dd> |
213 Receives data from the device. Only one receive request may be pending at any time. <dl compact><dt><b>Parameters:</b></dt><dd> |
|
214 <table border="0" cellspacing="2" cellpadding="0"> |
201 <table border="0" cellspacing="2" cellpadding="0"> |
215 <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> |
202 <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> |
216 <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> |
203 <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> |
217 </table> |
204 </table> |
218 </dl> |
205 </dd> |
219 |
206 </dl> |
220 <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> |
207 |
221 |
208 <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> |
222 </div> |
209 |
223 </div><p> |
210 </div> |
224 <a class="anchor" name="c6bee07d661dfd83a14516aa964672bb"></a><!-- doxytag: member="RDriver1::ReceiveDataCancel" ref="c6bee07d661dfd83a14516aa964672bb" args="()" --> |
211 </div> |
225 <div class="memitem"> |
212 <a class="anchor" id="ac6bee07d661dfd83a14516aa964672bb"></a><!-- doxytag: member="RDriver1::ReceiveDataCancel" ref="ac6bee07d661dfd83a14516aa964672bb" args="()" --> |
226 <div class="memproto"> |
213 <div class="memitem"> |
227 <table class="memname"> |
214 <div class="memproto"> |
228 <tr> |
215 <table class="memname"> |
229 <td class="memname">void RDriver1::ReceiveDataCancel </td> |
216 <tr> |
230 <td>(</td> |
217 <td class="memname">void RDriver1::ReceiveDataCancel </td> |
231 <td class="paramname"> </td> |
218 <td>(</td> |
232 <td> ) </td> |
219 <td class="paramname"></td> |
233 <td width="100%"></td> |
220 <td> ) </td> |
234 </tr> |
221 <td></td> |
235 </table> |
222 </tr> |
236 </div> |
223 </table> |
237 <div class="memdoc"> |
224 </div> |
238 |
225 <div class="memdoc"> |
239 <p> |
226 <p>Cancels a previous <a class="el" href="class_r_driver1.html#a7e192c22f84adc61b6418cd6ffb65526">ReceiveData()</a> request. </p> |
240 Cancels a previous <a class="el" href="class_r_driver1.html#7e192c22f84adc61b6418cd6ffb65526">ReceiveData()</a> request. |
227 |
241 <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> |
228 <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> |
242 |
229 |
243 </div> |
230 </div> |
244 </div><p> |
231 </div> |
245 <a class="anchor" name="7e98e9f7ec04a53a404d646481f589ca"></a><!-- doxytag: member="RDriver1::Name" ref="7e98e9f7ec04a53a404d646481f589ca" args="()" --> |
232 <a class="anchor" id="a7e98e9f7ec04a53a404d646481f589ca"></a><!-- doxytag: member="RDriver1::Name" ref="a7e98e9f7ec04a53a404d646481f589ca" args="()" --> |
246 <div class="memitem"> |
233 <div class="memitem"> |
247 <div class="memproto"> |
234 <div class="memproto"> |
248 <table class="memname"> |
235 <table class="memname"> |
249 <tr> |
236 <tr> |
250 <td class="memname">const TDesC & RDriver1::Name </td> |
237 <td class="memname">const TDesC & RDriver1::Name </td> |
251 <td>(</td> |
238 <td>(</td> |
252 <td class="paramname"> </td> |
239 <td class="paramname"></td> |
253 <td> ) </td> |
240 <td> ) </td> |
254 <td width="100%"><code> [static]</code></td> |
241 <td><code> [static]</code></td> |
255 </tr> |
242 </tr> |
256 </table> |
243 </table> |
257 </div> |
244 </div> |
258 <div class="memdoc"> |
245 <div class="memdoc"> |
259 |
246 <p>Gets the driver's name. </p> |
260 <p> |
247 <dl class="return"><dt><b>Returns:</b></dt><dd>The name of the driver </dd></dl> |
261 Gets the driver's name. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of the driver </dd></dl> |
248 |
262 |
249 <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> |
263 <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> |
250 |
264 |
251 </div> |
265 </div> |
252 </div> |
266 </div><p> |
253 <a class="anchor" id="a7d1f08b59801b5890fb77666e14d5e8f"></a><!-- doxytag: member="RDriver1::VersionRequired" ref="a7d1f08b59801b5890fb77666e14d5e8f" args="()" --> |
267 <a class="anchor" name="7d1f08b59801b5890fb77666e14d5e8f"></a><!-- doxytag: member="RDriver1::VersionRequired" ref="7d1f08b59801b5890fb77666e14d5e8f" args="()" --> |
254 <div class="memitem"> |
268 <div class="memitem"> |
255 <div class="memproto"> |
269 <div class="memproto"> |
256 <table class="memname"> |
270 <table class="memname"> |
257 <tr> |
271 <tr> |
258 <td class="memname">TVersion RDriver1::VersionRequired </td> |
272 <td class="memname">TVersion RDriver1::VersionRequired </td> |
259 <td>(</td> |
273 <td>(</td> |
260 <td class="paramname"></td> |
274 <td class="paramname"> </td> |
261 <td> ) </td> |
275 <td> ) </td> |
262 <td><code> [static]</code></td> |
276 <td width="100%"><code> [static]</code></td> |
263 </tr> |
277 </tr> |
264 </table> |
278 </table> |
265 </div> |
279 </div> |
266 <div class="memdoc"> |
280 <div class="memdoc"> |
267 <p>Gets the driver's version. </p> |
281 |
268 <dl class="return"><dt><b>Returns:</b></dt><dd>The version number of the driver </dd></dl> |
282 <p> |
269 |
283 Gets the driver's version. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The version number of the driver </dd></dl> |
270 <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> |
284 |
271 |
285 <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> |
272 </div> |
286 |
273 </div> |
287 </div> |
274 </div> |
288 </div><p> |
275 <hr size="1"/><address style="text-align: right;"><small>Generated by |
289 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:08 2010 for TB10.1 Example Applications by |
|
290 <a href="http://www.doxygen.org/index.html"> |
276 <a href="http://www.doxygen.org/index.html"> |
291 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
277 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> |
292 </body> |
278 </body> |
293 </html> |
279 </html> |