1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>WXCStateCode</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">WXCStateCode <img src="../image/NTR.gif"align="middle"><img src="../image/TWL.gif" align="middle"></h1>
15<h2>Definition</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;nitro/wxc.h&gt;</CODE><BR> <BR>
20<PRE>
21typedef enum
22{
23    <font color="#008000">/* Internal state that can be obtained with the WXC_GetStatus function */</font>
24    WXC_STATE_END,            /* State before WXC library initialization */
25    WXC_STATE_ENDING,         /* After WXC_End function and during end processing */
26    WXC_STATE_READY,         /* After WXC_Init function and before the WXC_Start function */
27    WXC_STATE_ACTIVE,         /* After the WXC_Start function and wireless is enabled */
28
29    <font color="#008000">/* Internal event notification sent to system callback */</font>
30    WXC_STATE_CONNECTED,      /* Connection notification (argument is pointer to WXCUserInfo structure that stores the information of the connection partner) */
31    WXC_STATE_EXCHANGE_DONE,  /* Data exchange completed (The argument is receive buffer specified by user) */
32    WXC_STATE_BEACON_RECV     /* Beacon receive (Argument is WXCBeaconFoundCallback structure) */
33}
34WXCStateCode;
35</PRE>
36</CODE><br> <br>
37  </dd>
38</dl>
39
40<H2>Description</H2>
41<P>This shows the enumerator constants that indicate WXC library internal states. The meaning of each enumerator constant is shown in the following table: <br><br>Value obtained with the <A href="common/WXC_GetStateCode.html">WXC_GetStateCode</A> function
42<TABLE border="0">
43  <TBODY>
44
45    <TR>
46<TD>Value</TD>
47<TD>State</TD>
48	  <TD>System callback specified with the <A href="common/WXC_Init.html">WXC_Init</A> function</td>
49    </TR>
50
51    <TR>
52<TD>WXC_STATE_END</TD>
53<TD>This is the state before the initialization of the WXC library or after the completion of the end process function, <A href="common/WXC_End.html">WXC_End</A>.
54	  </TD>
55	  <td>Notified when end processing by the <A href="common/WXC_End.html">WXC_End</A> function is completed. <br>A pointer to the work memory allocated with the <A href="common/WXC_Init.html">WXC_Init</A> function is passed as an argument. <br>This memory will have already been released to the user application at the point when this callback occurs.</td>
56    </TR>
57
58    <TR>
59<TD>WXC_STATE_ENDING</TD>
60<TD>State in which the <A href="common/WXC_End.html">WXC_End</A> function is called and the wireless end process is performed.
61	  </TD>
62	  <td>Notified immediately from inside the <A href="common/WXC_End.html">WXC_End</A> function call. <br>NULL is always passed to an argument.</td>
63    </TR>
64
65    <TR>
66<TD>WXC_STATE_READY</TD>
67<TD>State after the <A href="common/WXC_Init.html">WXC_Init</A> function is called and before the <A href="common/WXC_Start.html">WXC_Start</A> function is called.
68	  </TD>
69	  <td>Notified from inside the <A href="common/WXC_Init.html">WXC_Init</A> function call or when the state transition process by <A href="common/WXC_Stop.html">WXC_Stop</A> function has completed. <br>NULL is always passed to an argument.</td>
70    </TR>
71
72    <TR>
73<TD>WXC_STATE_ACTIVE</TD>
74<TD>State in which internal wireless is active after a call of the <A href="common/WXC_Start.html">WXC_Start</A> function.
75	  </TD>
76	  <td>Notified immediately from inside the <A href="common/WXC_Start.html">WXC_Start</A> function call. <br>NULL is always passed to an argument.</td>
77    </TR>
78
79  </TBODY>
80</TABLE>
81
82<BR>Value communicated only to the system callback specified with <A href="common/WXC_Init.html">WXC_Init</A> function.
83
84<TABLE border="0">
85  <TBODY>
86
87    <TR>
88<TD>Value</TD>
89	  <TD>System callback specified with the <A href="common/WXC_Init.html">WXC_Init</A> function</td>
90    </TR>
91
92    <TR>
93<TD>WXC_STATE_CONNECTED</TD>
94	  <td>When started as a parent, notified each time a child is connected. <br>A pointer to the <A href="WXCUserInfo.html">WXCUserInfo</A> structure is passed as an argument.</td>
95    </TR>
96
97    <TR>
98<TD>WXC_STATE_BEACON_RECV</TD>
99	  <td>Notified each time a beacon from a parent that is a possible connection target is detected. <br>A pointer to the <A href="WXCBeaconFoundCallback.html">WXCBeaconFoundCallback</A> structure is passed as an argument.</td>
100    </TR>
101  </TBODY>
102</TABLE>
103
104<BR>Value communicated only to the user callback specified with <A href="common/WXC_RegisterCommonData.html">WXC_RegisterCommonData</A> function.
105
106<TABLE border="0">
107  <TBODY>
108
109    <TR>
110<TD>Value</TD>
111	  <TD>User callback specified with the <A href="common/WXC_RegisterCommonData.html">WXC_RegisterCommonData</A> function</td>
112    </TR>
113
114    <TR>
115<TD>WXC_STATE_EXCHANGE_DONE</TD>
116	  <td>Notified each time data exchange completes.<br>The passed argument is a pointer to the <A href="WXCBlockDataFormat.html">WXCBlockDataFormat</A> structure that holds the received data.</td>
117    </TR>
118
119  </TBODY>
120</TABLE>
121
122<BR>
123</P>
124<h2>See Also</h2>
125<p><CODE><A href="WXCCallback.html">WXCCallback</A><BR><A href="WXCBeaconFoundCallback.html">WXCBeaconFoundCallback</A><BR><A href="WXCUserInfo.html">WXCUserInfo</A><br> <A href="common/WXC_Init.html">WXC_Init</A><BR><A href="common/WXC_Start.html">WXC_Start</A><BR><A href="common/WXC_End.html">WXC_End</A><BR><A href="common/WXC_GetStateCode.html">WXC_GetStateCode</A></CODE></p>
126
127<H2>Revision History</H2>
128<P>
1292006/02/20 Added descriptions for <CODE>WXC_STATE_EXCHANGE_DONE</CODE>. <br>2005/11/04 Added descriptions for <CODE>WXC_STATE_BEACON_RECV</CODE>. <br>2005/10/11 Modified descriptions for <CODE>WXC_STATE_READY</CODE>. <br>2005/08/04 Initial version.<br>
130</P>
131<hr><p>CONFIDENTIAL</p></body>
132</html>
133