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_RegisterServerTable</title>
7<link rel="stylesheet" href="../../css/nitro.css" type="text/css" />
8</head>
9<body>
10
11<h1>WFS_RegisterServerTable <img src="../../image/NTR.gif"><img src="../../image/TWL.gif"></h1>
12<h2>Syntax</h2>
13
14<dl>
15  <dd>
16<code>#include &lt;nitro/wfs.h&gt;</code><br /> <br /> <code>BOOL WFS_RegisterServerTable(WFSServerContext *context, <a href="../../mi/device/MIDevice.html">MIDevice</a> *device, u32 fatbase, u32 overlay);</code><br /> <br />
17  </dd>
18</dl>
19<h2>Arguments</h2>
20<table border="1" width="100%">
21  <tbody>
22    <tr>
23<td style="width:13%"><CODE>context</CODE></td>
24<td style="width:87%">Pointer to the <CODE>WFSServerContext</CODE> structure.</td>
25    </tr>
26    <tr>
27<td style="width:13%"><CODE>device</CODE></td>
28<td style="width:87%">Interface with the device storing the ROM image.</td>
29    </tr>
30    <tr>
31<td style="width:13%"><CODE>fatbase</CODE></td>
32<td style="width:87%">Address within the device where the ROM image is located.</td>
33    </tr>
34    <tr>
35<td style="width:13%"><CODE>overlay</CODE></td>
36<td style="width:87%">Internal device address at which the ROM image that includes the overlay to be merged is located.<br />Specify the same value as <CODE>fatbase</CODE> if the overlay is not to be merged.</td>
37    </tr>
38  </tbody>
39</table>
40<h2>Return Values</h2>
41<p>Returns <CODE>TRUE</CODE> if the ROM file table is correctly loaded and registered; otherwise, returns <CODE>FALSE</CODE>.</p>
42
43<h2>Description</h2>
44<p>Extracts the file table from a ROM image located on a device, and registers it in a WFS parent (server) context structure. All connected WFS children (clients) will automatically get this file table from the server.
45</p>
46<p>
47If a read request for the ROM image registered with this function is issued from a child (client), notification of a <a href="../WFSEventType.html"><code>WFS_EVENT_SERVER_SEGMENT_REQUEST</code></a> event will be made. The application must handle the read request appropriately within the event callback.<BR>
48</p>
49<p>
50If no special processing is required to set the file table or respond to a read request, a parent (server) process can be much more easily implemented using  <a href="WFS_ExecuteRomServerThread.html"><code>WFS_ExecuteRomServerThread</code></a> instead of this function.
51</p>
52
53<h2>See Also</h2>
54<p><a href="WFS_InitServer.html"><CODE>WFS_InitServer</CODE></a><BR> <a href="WFS_EndServer.html"><CODE>WFS_EndServer</CODE></a><BR> <a href="WFS_ExecuteRomServerThread.html"><CODE>WFS_ExecuteRomServerThread</CODE></a></p>
55
56<h2>Revision History</h2>
57<p>
582007/06/14 Added a description of the <code>WFS_ExecuteRomServerThread</code> function.<br /> 2007/06/06 Initial version.
59</p>
60<hr><p>CONFIDENTIAL</p></body>
61</html>
62