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=utf-8" />
5<meta http-equiv="Content-Style-Type" content="text/css" />
6<title>WFS_InitClient</title>
7<link rel="stylesheet" href="../../css/nitro.css" type="text/css" />
8</head>
9<body>
10
11<h1>WFS_InitClient <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>void WFS_InitClient(WFSClientContext *context, void *userdata, <a href="../WFSEventCallback.html">WFSEventCallback</a> callback, <a href="../../mi/allocator/MIAllocator.html">MIAllocator</a> *allocator);</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%"><em><strong><CODE>context</CODE></strong></em></td>
24<td style="width:87%">Pointer to the <CODE>WFSClientContext</CODE> structure to be initialized</td>
25    </tr>
26    <tr>
27<td style="width:13%"><em><strong><CODE>userdata</CODE></strong></em></td>
28<td style="width:87%">Any user-defined value to be linked with the context</td>
29    </tr>
30    <tr>
31<td style="width:13%"><em><strong><CODE>callback</CODE></strong></em></td>
32<td style="width:87%">A callback function that receives an event notification from the WFS library.<br />Specify NULL if unnecessary.</td>
33    </tr>
34    <tr>
35<td style="width:13%"><em><strong><CODE>allocator</CODE></strong></em></td>
36<td style="width:87%">The allocator used internally by the library</td>
37    </tr>
38  </tbody>
39</table>
40<h2>Return Values</h2>
41<p>None.</p>
42
43<h2>Description</h2>
44<p>Initializes the WFS library child (client) context structure. This function must be called at least once before using the <CODE>WFSClientContext</CODE> structure. This function has absolutely no impact on the status of the OS or wireless communications because it only initializes the contents of the <CODE>WFSClientContext</CODE> structure.<BR><br>The WFS library specification establishes the MP send packet size that can be used by child devices to be <code><a href="../../wbt/wbt_packet_size_min_const.html">WBT_PACKET_SIZE_MIN</a></code>.<br>
45</p>
46
47<h2>See Also</h2>
48<p><code><a href="../WFSEventCallback.html">WFSEventCallback</a><BR> <a href="WFS_StartClient.html">WFS_StartClient</a><BR> <a href="WFS_EndClient.html">WFS_EndClient</a><BR> <a href="WFS_GetTableFormat.html">WFS_GetTableFormat</a><BR> <a href="WFS_RequestClientRead.html">WFS_RequestClientRead</a><BR> <a href="WFS_GetClientReadProgress.html">WFS_GetClientReadProgress</a><BR> <a href="WFS_CallClientConnectHook.html">WFS_CallClientConnectHook</a><BR> <a href="WFS_CallClientDisconnectHook.html">WFS_CallClientDisconnectHook</a><BR> <a href="WFS_CallClientPacketSendHook.html">WFS_CallClientPacketSendHook</a><BR> <a href="WFS_CallClientPacketRecvHook.html">WFS_CallClientPacketRecvHook</a> </code></p>
49
50<h2>Revision History</h2>
51<p>
522009/11/11 Added the MP send packet size that can be used by child devices with WFS.<br>2007/06/06 Initial version.<br>
53</p>
54<hr><p>CONFIDENTIAL</p></body>
55</html>
56