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<base target="main" />
7<title>Wireless File System (WFS) Library Function List</title>
8<link rel="stylesheet" href="../css/apilist.css" />
9</head>
10<body>
11<h1>Wireless File System (WFS) Library Function List</h1>
12<h3><a name="server" id="server">Parent (Server)</a></h3>
13<h4>Initialization</h4>
14<table border="1" width="100%">
15  <tbody>
16    <tr>
17      <th style="width:25%"><a href="server/WFS_InitServer.html" target="_self">WFS_InitServer</a></th>
18      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
19      <td>Initializes the WFS library parent (server-side) context.</td>
20    </tr>
21    <tr>
22      <th style="width:25%"><a href="server/WFS_EndServer.html" target="_self">WFS_EndServer</a></th>
23      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
24      <td>Terminates the WFS library parent (server-side) context.</td>
25    </tr>
26    <tr>
27      <th style="width:25%"><a href="server/WFS_RegisterServerTable.html" target="_self">WFS_RegisterServerTable</a></th>
28      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
29      <td>Loads the ROM file table to be distributed and registers it with the server.</td>
30    </tr>
31    <tr>
32      <th style="width:25%"><a href="server/WFS_ExecuteRomServerThread.html" target="_self">WFS_ExecuteRomServerThread</a></th>
33      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
34      <td>Registers the ROM file table to be distributed and executes a thread for automatically responding to requests.</td>
35    </tr>
36  </tbody>
37</table>
38<h4>Hook</h4>
39<table border="1" width="100%">
40  <tbody>
41    <tr>
42      <th style="width:25%"><a href="server/WFS_CallServerConnectHook.html" target="_self">WFS_CallServerConnectHook</a></th>
43      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
44      <td>Notifies the library that a new child (client) has connected.</td>
45    </tr>
46    <tr>
47      <th style="width:25%"><a href="server/WFS_CallServerDisconnectHook.html" target="_self">WFS_CallServerDisconnectHook</a></th>
48      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
49      <td>Notifies the library that a child (client) has disconnected.</td>
50    </tr>
51    <tr>
52      <th style="width:25%"><a href="server/WFS_CallServerPacketSendHook.html" target="_self">WFS_CallServerPacketSendHook</a></th>
53      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
54      <td>Gets MP communication packet data that needs to be sent to children (clients).</td>
55    </tr>
56    <tr>
57      <th style="width:25%"><a href="server/WFS_CallServerPacketRecvHook.html" target="_self">WFS_CallServerPacketRecvHook</a></th>
58      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
59      <td>Analyzes MP communication packet data received from children (clients).</td>
60    </tr>
61  </tbody>
62</table>
63<h4>Settings</h4>
64<table border="1" width="100%">
65  <tbody>
66    <tr>
67      <th style="width:25%"><a href="server/WFS_GetServerConnectedBitmap.html" target="_self">WFS_GetServerConnectedBitmap</a></th>
68      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
69      <td>Gets the status of currently connected children (clients) as a bitmap.</td>
70    </tr>
71    <tr>
72      <th style="width:25%"><a href="server/WFS_GetServerBusyBitmap.html" target="_self">WFS_GetServerBusyBitmap</a></th>
73      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
74      <td>Gets the status of children (clients) currently issuing requests as a bitmap.</td>
75    </tr>
76    <tr>
77      <th style="width:25%"><a href="server/WFS_GetServerSyncBitmap.html" target="_self">WFS_GetServerSyncBitmap</a></th>
78      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
79      <td>Gets the status of children (clients) for which request-response synchronization is set as a bitmap.</td>
80    </tr>
81    <tr>
82      <th style="width:25%"><a href="server/WFS_GetServerPacketLength.html" target="_self">WFS_GetServerPacketLength</a></th>
83      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
84      <td>Gets the MP communication packet size of the parent (server).</td>
85    </tr>
86    <tr>
87      <th style="width:25%"><a href="server/WFS_SetServerPacketLength.html" target="_self">WFS_SetServerPacketLength</a></th>
88      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
89      <td>Sets the MP communication packet size of the parent (server).</td>
90    </tr>
91    <tr>
92      <th style="width:25%"><a href="server/WFS_SetServerSync.html" target="_self">WFS_SetServerSync</a></th>
93      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
94      <td>Sets the synchronization group to use when a parent (server) responds to requests from children (clients).</td>
95    </tr>
96  </tbody>
97</table>
98<h3><a name="client" id="client">Child (Client)</a></h3>
99<h4>Initialization</h4>
100<table border="1" width="100%">
101  <tbody>
102    <tr>
103      <th style="width:25%"><a href="client/WFS_InitClient.html" target="_self">WFS_InitClient</a></th>
104      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
105      <td>Initializes the WFS library child (client) context.</td>
106    </tr>
107    <tr>
108      <th style="width:25%"><a href="client/WFS_EndClient.html" target="_self">WFS_EndClient</a></th>
109      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
110      <td>Terminates the WFS library child (client) context.</td>
111    </tr>
112    <tr>
113      <th style="width:25%"><a href="client/WFS_StartClient.html" target="_self">WFS_StartClient</a></th>
114      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
115      <td>Starts the child (client) communication process.</td>
116    </tr>
117  </tbody>
118</table>
119<h4>Hook</h4>
120<table border="1" width="100%">
121  <tbody>
122    <tr>
123      <th style="width:25%"><a href="client/WFS_CallClientConnectHook.html" target="_self">WFS_CallClientConnectHook</a></th>
124      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
125      <td>Notifies the library that connection to the parent (server) has been established.</td>
126    </tr>
127    <tr>
128      <th style="width:25%"><a href="client/WFS_CallClientDisconnectHook.html" target="_self">WFS_CallClientDisconnectHook</a></th>
129      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
130      <td>Notifies the library that the connection to the parent (server) has ended.</td>
131    </tr>
132    <tr>
133      <th style="width:25%"><a href="client/WFS_CallClientPacketSendHook.html" target="_self">WFS_CallClientPacketSendHook</a></th>
134      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
135      <td>Gets MP communication packet data that needs to be sent to the parent (server).</td>
136    </tr>
137    <tr>
138      <th style="width:25%"><a href="client/WFS_CallClientPacketRecvHook.html" target="_self">WFS_CallClientPacketRecvHook</a></th>
139      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
140      <td>Analyzes MP communication packet data received from the parent (server).</td>
141    </tr>
142  </tbody>
143</table>
144<h4>Operation</h4>
145<table border="1" width="100%">
146  <tbody>
147    <tr>
148      <th style="width:25%"><a href="client/WFS_IsClientReady.html" target="_self">WFS_IsClientReady</a></th>
149      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
150      <td>Determines whether the child (client) is ready.</td>
151    </tr>
152    <tr>
153      <th style="width:25%"><a href="client/WFS_GetTableFormat.html" target="_self">WFS_GetTableFormat</a></th>
154      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
155      <td>Accesses the ROM file table received from the parent (server).</td>
156    </tr>
157    <tr>
158      <th style="width:25%"><a href="client/WFS_RequestClientRead.html" target="_self">WFS_RequestClientRead</a></th>
159      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
160      <td>Issues a ROM read request to the parent (server).</td>
161    </tr>
162    <tr>
163      <th style="width:25%"><a href="client/WFS_GetClientReadProgress.html" target="_self">WFS_GetClientReadProgress</a></th>
164      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
165      <td>Gets the progress status of a ROM read request.</td>
166    </tr>
167    <tr>
168      <th style="width:25%"><a href="client/WFS_ReplaceRomArchive.html" target="_self">WFS_ReplaceRomArchive</a></th>
169      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
170      <td>Directly mounts the WFS library to the &quot;rom&quot; archive of the FS library.</td>
171    </tr>
172  </tbody>
173</table>
174<h3><a name="struct" id="struct">Types and Structures</a></h3>
175<table border="1" width="100%">
176  <tbody>
177    <tr>
178      <th style="width:25%"><a href="WFSEventType.html" target="_self">WFSEventType</a></th>
179      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
180      <td>Enumerated value indicating the various types of notification events of the WFS library.</td>
181    </tr>
182    <tr>
183      <th style="width:25%"><a href="WFSEventCallback.html" target="_self">WFSEventCallback</a></th>
184      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
185      <td>The event notification callback function format for the WFS library.</td>
186    </tr>
187    <tr>
188      <th style="width:25%"><a href="WFSRequestClientReadDoneCallback.html" target="_self">WFSRequestClientReadDoneCallback</a></th>
189      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
190      <td>The callback function format for the <a href="client/WFS_RequestClientRead.html"><code>WFS_RequestClientRead</code></a> function.</td>
191    </tr>
192    <tr>
193      <th style="width:25%"><a href="WFSPacketBuffer.html" target="_self">WFSPacketBuffer</a></th>
194      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
195      <td>An argument structure used by the WFS library's hook functions.</td>
196    </tr>
197    <tr>
198      <th style="width:25%"><a href="WFSPeerInfo.html" target="_self">WFSPeerInfo</a></th>
199      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
200      <td>An argument structure used by the WFS library's hook functions.</td>
201    </tr>
202    <tr>
203      <th style="width:25%"><a href="WFSSegmentBuffer.html" target="_self">WFSSegmentBuffer</a></th>
204      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
205      <td>The argument structure used for WFS library event notifications.</td>
206    </tr>
207    <tr>
208      <th style="width:25%"><a href="WFSTableFormat.html" target="_self">WFSTableFormat</a></th>
209      <td width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></td>
210      <td>This structure represents file table information to be retrieved by children (clients).</td>
211    </tr>
212  </tbody>
213</table>
214
215<table border="0" style="border-width:0px;height:100%;"><tr><td style="background-color:white;"></td></tr></table>
216
217<hr><p>CONFIDENTIAL</p></body>
218</html>