1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=windows-1252" />
5<meta http-equiv="Content-Style-Type" content="text/css" />
6<title>WFS_RequestClientRead</title>
7<link rel="stylesheet" href="../../css/nitro.css" type="text/css" />
8</head>
9
10<body>
11
12<h1>WFS_RequestClientRead <img src="../../image/NTR.gif"><img src="../../image/TWL.gif"></h1>
13<h2>Syntax</h2>
14
15<dl>
16  <dd>
17<code>#include &lt;nitro/wfs.h&gt;</code><br />
18  <br />
19  <code>void WFS_RequestClientRead(WFSClientContext *context, void *buffer, u32 offset, u32 length,
20                                   <a href="../WFSRequestClientReadDoneCallback.html">WFSRequestClientReadDoneCallback</a> callback, void *arg);</code><br />
21  <br />
22  </dd>
23</dl>
24
25<h2>Arguments</h2>
26<table border="1" width="100%">
27  <tbody>
28    <tr>
29      <td style="width:13%"><em><strong>context</strong></em></td>
30      <td style="width:87%">Pointer to the <CODE>WFSClientContext</CODE> structure.</td>
31    </tr>
32    <tr>
33      <td style="width:13%"><em><strong>buffer</strong></em></td>
34      <td style="width:87%">Memory buffer for storing the data that is read.</td>
35    </tr>
36    <tr>
37      <td style="width:13%"><em><strong>offset</strong></em></td>
38      <td style="width:87%">Address of the data to read within the device.</td>
39    </tr>
40    <tr>
41      <td style="width:13%"><em><strong>length</strong></em></td>
42      <td style="width:87%">Data size to read.</td>
43    </tr>
44    <tr>
45      <td style="width:13%"><em><strong>callback</strong></em></td>
46      <td style="width:87%">Read completion callback in <a href="../WFSRequestClientReadDoneCallback.html"><CODE>WFSRequestClientReadDoneCallback</CODE></a> format.<br />
47      Specify NULL if not needed.</td>
48    </tr>
49    <tr>
50      <td style="width:13%"><em><strong>arg</strong></em></td>
51      <td style="width:87%">Optional argument passed to the read completion callback.</td>
52    </tr>
53  </tbody>
54</table>
55
56<h2>Return Values</h2>
57<p>None.</p>
58
59<h2>Description</h2>
60<p>Issues a ROM image read request to the parent (server). Block transfer is automatically executed within the library using a subsequent MP communication hook function.<BR>If the request completes or <a href="WFS_EndClient.html"><code>WFS_EndClient</code></a> is called when the request is being processed, notification will be made using a completion callback in <a href="../WFSRequestClientReadDoneCallback.html"><code>WFSRequestClientReadDoneCallback</code></a> format.</p>
61<p>
62This function cannot be used until client preparations are complete and <a href="../WFSEventType.html">WFS_EVENT_CLIENT_READY</a> event notification has been issued. Furthermore, this function cannot be called again until the previous request has been completed.
63</p>
64<p>
65Use <a href="WFS_GetClientReadProgress.html"><code>WFS_GetClientReadProgress</code></a> to check the current status of a request.
66</p>
67<h2>See Also</h2>
68<p>
69<a href="../WFSEventCallback.html">WFSEventCallback</a>, <a href="../WFSEventType.html">WFSEventType</a>, <br /> <a href="WFS_GetClientReadProgress.html">WFS_GetClientReadProgress</a>
70</p>
71
72<h2>Revision History</h2>
73<p>
742007/06/11 Added argument. <br />2007/06/06 Initial version.<BR>
75</p>
76<hr><p>CONFIDENTIAL</p></body>
77</html>
78