1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<title>WMStartMPCallback</title>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</head>
10<body>
11<h1 align="left">WMStartMPCallback</h1>
12<h2>Definition</h2>
13<dl>
14  <dd>
15<CODE>#include &lt;nitro/wm.h&gt;</CODE><BR>
16  <PRE><CODE>typedef struct WMStartMPCallback
17{
18    u16         apiid;
19    u16             errcode;
20    u16         state;
21    u8            reserved[2];
22    WMMpRecvBuf*    recvBuf;
23    u16             timeStamp;
24    u16             rate_rssi;
25    u16             destAdrs[3];
26    u16             srcAdrs[3];
27    u16 seqNum;
28    u16             tmptt;
29    u16             pollbmp;
30    u16             reserved2;
31} WMStartMPCallback;</CODE></PRE>
32  </dd>
33</dl><h2>Elements</h2>
34<TABLE border="1" width="100%">
35  <TBODY>
36    <TR>
37      <TD width="200"><CODE>apiid</CODE></TD>
38      <TD width="800">ID of the API that acts as the source for the callback generation. It is equivalent to the <A href="WMApiid.html"><code>WMApiid</code></A> enumerated type.
39      Here, it is fixed as <CODE>WM_APIID_START_MP</CODE>.
40      </TD>
41    </TR>
42    <TR>
43      <TD width="200"><CODE>errcode</CODE></TD>
44      <TD width="800">Result of the asynchronous process. It is equivalent to the <A href="WMErrCode.html"><code>WMErrCode</code></A> enumerated type.</TD>
45    </TR>
46    <TR>
47      <TD width="200"><CODE>state</CODE></TD>
48      <TD width="800">If <CODE>errcode</CODE> is <CODE>WM_ERRCODE_SUCCESS</CODE>, the <A href="WMStateCode.html">WM Cause Code</A> generated by the callback is stored. There are four causes:
49      <CODE>WM_STATECODE_MP_START</CODE>, <CODE>WM_STATECODE_MPEND_IND</CODE>, <CODE>WM_STATECODE_MP_IND</CODE> and <CODE>WM_STATECODE_MPACK_IND</CODE>.<BR>
50      Among the error codes listed, normally <CODE>WM_STATECODE_MP_START</CODE> is the only one that the application needs to process.
51      </TD>
52    </TR>
53    <TR>
54      <TD width="200"><CODE>recvBuf</CODE></TD>
55      <TD width="800">If <CODE>state</CODE> is <CODE>WM_STATECODE_MPEND_IND</CODE> or <CODE>WM_STATECODE_MP_IND</CODE>, a pointer to the receive data storage destination will be stored.
56      The receive buffer specified in <CODE>WM_StartMP</CODE> is handled as a double buffer. This indicates which of the buffers will be the first data storage destination.
57      When a machine accepts data as a parent, this will be a pointer to the <CODE>WMMpRecvHeader</CODE> type.
58      </TD>
59    </TR>
60    <TR>
61      <TD width="200"><CODE>
62      timeStamp<BR>rate_rssi<BR>destAdrs<BR>srcAdrs<BR>seqNum<BR>tmptt<BR>pollbmp
63      </CODE></TD>
64      <TD width="800">When <CODE>state</CODE> is <code>WM_STATECODE_MPACK_IND</code>, each of the arguments stores the information on the MP communication that was performed.</TD>
65    </TR>
66  </TBODY>
67</TABLE>
68<H2>Description</H2>
69<P>
70This structure is passed to the callback function for the <A href="WM_StartMP.html"><CODE>WM_StartMP</CODE></A> and <A href="WM_StartMPEx.html"><CODE>WM_StartMPEx</CODE></A> functions.
71</P>
72<H2>Revision History</H2>
73<P>
742007/07/18 Added text about <CODE>state</CODE>.<BR> 2004/08/11 Added members to be stored at the time of MP completion callback.<br> 2004/08/02 Standardized structure names.<br> 2004/07/29 Initial version.
75</P>
76<hr><p>CONFIDENTIAL</p></body>
77</html>
78