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>WFSSegmentBuffer</title>
7<link rel="stylesheet" href="../css/nitro.css" type="text/css" />
8</head>
9
10<body>
11
12<h1>WFSSegmentBuffer</h1>
13<h2>Definition</h2>
14
15<dl>
16  <dd>
17<code>#include &lt;nitro/wfs.h&gt;</code><br />
18  <br />
19<pre>
20typedef struct WFSSegmentBuffer
21{
22    u32     offset;
23    u32     length;
24    void   *buffer;
25}
26WFSSegmentBuffer;
27</pre>
28  <br />
29  </dd>
30</dl>
31
32<h2>Elements</h2>
33<table border="1" width="100%">
34  <tbody>
35    <tr>
36      <td>offset</td>
37      <td>Address of the data to read within the device.</td>
38    </tr>
39    <tr>
40      <td>length</td>
41      <td>Size of data to be read.</td>
42    </tr>
43    <tr>
44      <td>buffer</td>
45      <td>Buffer where the read data is stored.<br />
46      <br />
47      If this member is NULL, indicates that the specified data segment will be needed later on.<br />
48      Although it is not necessary to prepare associated data inside a callback at this time, an event callback with the same content will be notified again later, so the appropriate data must be prepared before that time.<BR>
49      <br />
50      If this member is not NULL, the specified data segment is actually required.<br />
51      You must prepare the corresponding data, store it in the buffer pointed to by this member, and return.<br />
52      If the data being requested here has not been prepared, replace this member with NULL and return.<br />
53      Notification of an event callback with the same content will be made again later, so the data must be prepared before that time.
54      </td>
55    </tr>
56  </tbody>
57</table>
58
59
60<h2>Description</h2>
61<p>This data structure represents data segment information that is passed as an argument of the <a href="WFSEventType.html">WFS_EVENT_SERVER_SEGMENT_REQUEST</a> event notification.<br />In order to respond to read requests from a child (client), the parent (server) must read the data in the region specified by this structure from the device.
62</p>
63
64<h2>See Also</h2>
65<p><code><a href="server/WFS_CallServerPacketSendHook.html">WFS_CallServerPacketSendHook</a>, <a href="server/WFS_CallServerPacketRecvHook.html">WFS_CallServerPacketRecvHook</a>, <a href="client/WFS_CallClientPacketSendHook.html">WFS_CallClientPacketSendHook</a>, <a href="client/WFS_CallClientPacketRecvHook.html">WFS_CallClientPacketRecvHook</a></code></p>
66
67<h2>Revision History</h2>
68<p>
692007/06/06 Initial version.
70</p>
71<hr><p>CONFIDENTIAL</p></body>
72</html>
73