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_CallClientPacketSendHook</title>
7<link rel="stylesheet" href="../../css/nitro.css" type="text/css" />
8</head>
9
10<body>
11
12<h1>WFS_CallClientPacketSendHook <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 /> <br /> <code>void WFS_CallClientPacketSendHook(WFSClientContext *context, <a href="../WFSPacketBuffer.html">WFSPacketBuffer</a> *packet);</code><br /> <br />
18  </dd>
19</dl>
20
21<h2>Arguments</h2>
22<table border="1" width="100%">
23  <tbody>
24    <tr>
25<td style="width:13%"><CODE>context</CODE></td>
26<td style="width:87%">Pointer to the <CODE>WFSClientContext</CODE> structure.</td>
27    </tr>
28    <tr>
29<td style="width:13%"><CODE>packet</CODE></td>
30<td style="width:87%">Pointer to the <a href="../WFSPacketBuffer.html"><CODE>WFSPacketBuffer</CODE></a> structure storing send packet information. The following information must be specified for each member.<br />
31      <table border="1" width="100%">
32        <tbody>
33          <tr>
34<td style="width:13%"><CODE>buffer</CODE></td>
35<td style="width:87%">Buffer that stores packet data.</td>
36          </tr>
37          <tr>
38<td style="width:13%"><CODE>length</CODE></td>
39<td style="width:87%">Buffer size.</td>
40          </tr>
41          <tr>
42<td style="width:13%"><CODE>bitmap</CODE></td>
43<td style="width:87%">AID bitmap indicating clients that data can be sent to.<BR>It is acceptable to always use <CODE>0x0001</CODE> (parent/server only) because you are sending from a child (client) to the parent (server).</td>
44          </tr>
45        </tbody>
46      </table>
47      </td>
48    </tr>
49  </tbody>
50</table>
51
52<h2>Return Values</h2>
53<p>None. (The packet size that was actually generated is stored in the <CODE>length</CODE> member of the <CODE>packet</CODE> argument.)</p>
54
55<h2>Description</h2>
56<p>Converts internal WFS library protocol into packet data for a single MP communication session. Using this function to generate packet data and sending it with functions such as <a href="../../wm/wm/WM_SetMPDataToPort.html"><code>WM_SetMPDataToPort</code></a> results in the WFS status of both parent and child being updated. Applications must call this function and perform MP communications repeatedly at an appropriate frequency.<BR>
57</p>
58
59<h2>See Also</h2>
60<p>
61<a href="WFS_CallClientConnectHook.html"><CODE>WFS_CallClientConnectHook</CODE></a><BR> <a href="WFS_CallClientDisconnectHook.html"><CODE>WFS_CallClientDisconnectHook</CODE></a><BR> <a href="WFS_CallClientPacketRecvHook.html"><CODE>WFS_CallClientPacketRecvHook</CODE></a>
62</p>
63
64<h2>Revision History</h2>
65<p>
662007/06/06 Initial version.
67</p>
68<hr><p>CONFIDENTIAL</p></body>
69</html>
70