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 http-equiv="Content-Style-Type" content="text/css">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<BASE target="main">
8<TITLE>WM Block Transfer Protocol API Function List (WBT)</TITLE>
9<LINK rel="stylesheet" href="../css/apilist.css">
10</HEAD>
11<BODY>
12<H1>WM Block Transfer Protocol API Function List (WBT)</H1>
13<H3><A name="Init">Initialization</A></H3>
14<TABLE border="1" width="100%">
15  <TBODY>
16    <TR>
17      <TH width="25%"><A href="init/WBT_InitParent.html" target="_self">WBT_InitParent</A></TH>
18      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
19      <TD>Initializes the library as a wireless parent device.</TD>
20    </TR>
21    <TR>
22      <TH width="25%"><A href="init/WBT_InitChild.html" target="_self">WBT_InitChild</A></TH>
23      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
24      <TD>Initializes the library as a wireless child device.</TD>
25    </TR>
26    <TR>
27      <TH width="25%"><A href="init/WBT_End.html" target="_self">WBT_End</A></TH>
28      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
29      <TD>Ends the library.</TD>
30    </TR>
31  </TBODY>
32</TABLE>
33<H3><A name="Common">Common</A></H3>
34<TABLE border="1" width="100%">
35  <TBODY>
36    <TR>
37      <TH width="25%"><A href="common/WBT_AidbitmapToAid.html" target="_self">WBT_AidbitmapToAid</A></TH>
38      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
39      <TD>Converts the lowest bit of an AID bitmap to an AID.</TD>
40    </TR>
41    <TR>
42      <TH width="25%"><A href="common/WBT_AidToAidbitmap.html" target="_self">WBT_AidToAidbitmap</A></TH>
43      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
44      <TD>Converts an AID to an AID bitmap.</TD>
45    </TR>
46    <TR>
47      <TH width="25%"><A href="common/WBT_GetOwnAid.html" target="_self">WBT_GetOwnAid</A></TH>
48      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
49      <TD>Gets the AID set in self.</TD>
50    </TR>
51    <TR>
52      <TH width="25%"><A href="common/WBT_CalcPacketbitmapSize.html" target="_self">WBT_CalcPacketbitmapSize</A></TH>
53      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
54      <TD>Gets the bitmap buffer size necessary to receive data.</TD>
55    </TR>
56    <TR>
57      <TH width="25%"><A href="common/WBT_GetCurrentDownloadProgress.html" target="_self">WBT_GetCurrentDownloadProgress</A></TH>
58      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
59      <TD>Gets the progress status of the current reception.</TD>
60    </TR>
61    <TR>
62      <TH width="25%"><A href="common/WBT_NumOfRegisteredBlock.html" target="_self">WBT_NumOfRegisteredBlock</A></TH>
63      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
64      <TD>Gets the total number of data blocks currently registered.</TD>
65    </TR>
66    <TR>
67      <TH width="25%"><A href="common/WBT_RegisterBlock.html" target="_self">WBT_RegisterBlock</A></TH>
68      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
69      <TD>Registers data blocks.</TD>
70    </TR>
71    <TR>
72      <TH width="25%"><A href="common/WBT_UnregisterBlock.html" target="_self">WBT_UnregisterBlock</A></TH>
73      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
74      <TD>Releases registered data blocks.</TD>
75    </TR>
76    <TR>
77      <TH width="25%"><A href="common/WBT_PrintBTList.html" target="_self">WBT_PrintBTList</A></TH>
78      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
79      <TD>Debug outputs the current WBT internal status.</TD>
80    </TR>
81  </TBODY>
82</TABLE>
83<H3><A name="Parent">Parent Device Settings</A></H3>
84<TABLE border="1" width="100%">
85  <TBODY>
86    <TR>
87      <TH width="25%"><A href="parent/WBT_SetPacketSize.html" target="_self">WBT_SetPacketSize</A></TH>
88      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
89      <TD>Resets the MP communication packet size that can be used with WBT.</TD>
90    </TR>
91    <TR>
92      <TH width="25%"><A href="parent/WBT_MpParentSendHook.html" target="_self">WBT_MpParentSendHook</A></TH>
93      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
94      <TD>Generates the WBT protocol packet data that should be sent with MP communication.</TD>
95    </TR>
96    <TR>
97      <TH width="25%"><A href="parent/WBT_MpParentRecvHook.html" target="_self">WBT_MpParentRecvHook</A></TH>
98      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
99      <TD>Notifies the WBT of WBT protocol packet data received with MP communication.</TD>
100    </TR>
101  </TBODY>
102</TABLE>
103<H3><A name="Child">Child Device Settings</A></H3>
104<TABLE border="1" width="100%">
105  <TBODY>
106    <TR>
107      <TH width="25%"><A href="child/WBT_SetOwnAid.html" target="_self">WBT_SetOwnAid</A></TH>
108      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
109      <TD>Notifies the WBT of its own AID.</TD>
110    </TR>
111    <TR>
112      <TH width="25%"><A href="child/WBT_MpChildSendHook.html" target="_self">WBT_MpChildSendHook</A></TH>
113      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
114      <TD>Generates the WBT protocol packet data that should be sent with MP communication.</TD>
115    </TR>
116    <TR>
117      <TH width="25%"><A href="child/WBT_MpChildRecvHook.html" target="_self">WBT_MpChildRecvHook</A></TH>
118      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
119      <TD>Notifies the WBT of WBT protocol packet data received with MP communication.</TD>
120    </TR>
121  </TBODY>
122</TABLE>
123
124<H3><A name="Command">Commands</A></H3>
125<TABLE border="1" width="100%">
126  <TBODY>
127    <TR>
128      <TH width="25%"><A href="command/WBT_RequestSync.html" target="_self">WBT_RequestSync</A></TH>
129      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
130      <TD>Synchronizes the communication status.</TD>
131    </TR>
132    <TR>
133      <TH width="25%"><A href="command/WBT_GetBlockInfo.html" target="_self">WBT_GetBlockInfo</A></TH>
134      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
135      <TD>Gets the data block information registered by the other party.</TD>
136    </TR>
137    <TR>
138      <TH width="25%"><A href="command/WBT_GetBlock.html" target="_self">WBT_GetBlock</A></TH>
139      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
140      <TD>Gets the data block registered by the other party.</TD>
141    </TR>
142    <TR>
143      <TH width="25%"><A href="command/WBT_PutUserData.html" target="_self">WBT_PutUserData</A></TH>
144      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
145      <TD>Sends optional small-sized data to the other party.</TD>
146    </TR>
147    <TR>
148      <TH width="25%"><A href="command/WBT_CancelCurrentCommand.html" target="_self">WBT_CancelCurrentCommand</A></TH>
149      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
150      <TD>Stops the WBT command that is being issued.</TD>
151    </TR>
152  </TBODY>
153</TABLE>
154<H3><A name="const">Constants and Macros</A></H3>
155<TABLE border="1" width="100%">
156  <TBODY>
157    <TR>
158      <TH width="25%"><A href="wbt_num_max_block_info_id_const.html" target="_self">WBT_NUM_MAX_BLOCK_INFO_ID</A></TH>
159      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
160      <TD>The maximum number of data blocks that can be registered at the same time.</TD>
161    </TR>
162    <TR>
163      <TH width="25%"><A href="wbt_block_id_min_const.html" target="_self">WBT_BLOCK_ID_MIN</A></TH>
164      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
165      <TD>The minimum value for IDs that can be registered as data blocks.</TD>
166    </TR>
167    <TR>
168      <TH width="25%"><A href="wbt_packet_size_min_const.html" target="_self">WBT_PACKET_SIZE_MIN</A></TH>
169      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
170      <TD>The minimum value for MP communication packet sizes to be set in the WBT library.</TD>
171    </TR>
172    <TR>
173      <TH width="25%"><A href="wbt_user_id_len_const.html" target="_self">WBT_USER_ID_LEN</A></TH>
174      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
175      <TD>The maximum size of user-specific information that can be given to the registered block information.</TD>
176    </TR>
177    <TR>
178      <TH width="25%"><A href="wbt_size_user_data_const.html" target="_self">WBT_SIZE_USER_DATA</A></TH>
179      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
180      <TD>The maximum size of data that can be sent with the <A href="command/WBT_PutUserData.html" target="_self"><CODE>WBT_PutUserData</CODE></A> function.</TD>
181    </TR>
182    <TR>
183      <TH width="25%"><A href="wbt_result_const.html" target="_self">WBTResult</A></TH>
184      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
185      <TD>The enumerated type that expresses the WBT library command result.</TD>
186    </TR>
187    <TR>
188      <TH width="25%"><A href="wbt_command_type_const.html" target="_self">WBTCommandType</A></TH>
189      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
190      <TD>The enumerated type that expresses the command type that notifies the WBT callback.</TD>
191    </TR>
192    <TR>
193      <TH width="25%"><A href="wbt_packet_bitmap_size.html" target="_self">WBT_PACKET_BITMAP_SIZE</A></TH>
194      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
195      <TD>Calculates the necessary reception bitmap buffer size from the packet size and data size.</TD>
196    </TR>
197    <TR>
198      <TH width="25%"><A href="wbt_aid_consts.html" target="_self">WBT_AID_*</A></TH>
199      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
200      <TD>Macro group for the AID.</TD>
201    </TR>
202  </TBODY>
203</TABLE>
204<H3><A name="struct">Structures</A></H3>
205<TABLE border="1" width="100%">
206  <TBODY>
207    <TR>
208      <TH width="25%"><A href="wbt_callback_type.html" target="_self">WBTCallback</A></TH>
209      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
210      <TD>Format for WBT library callback functions.</TD>
211    </TR>
212    <TR>
213      <TH width="25%"><A href="wbt_command_type.html" target="_self">WBTCommand</A></TH>
214      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
215      <TD>Structure for information passed to WBT library callbacks.</TD>
216    </TR>
217    <TR>
218      <TH width="25%"><A href="wbt_block_info_type.html" target="_self">WBTBlockInfo</A></TH>
219      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
220      <TD>Structure that expresses registered block information.</TD>
221    </TR>
222    <TR>
223      <TH width="25%"><A href="wbt_block_info_list_type.html" target="_self">WBTBlockInfoList</A></TH>
224      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
225      <TD>Structure that expresses list elements used in data block registration.</TD>
226    </TR>
227    <TR>
228      <TH width="25%"><A href="wbt_block_info_table_type.html" target="_self">WBTBlockInfoTable</A></TH>
229      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
230      <TD>Table that manages pointers to where registered block information requested by other parties is stored.</TD>
231    </TR>
232    <TR>
233      <TH width="25%"><A href="wbt_packet_bitmap_table_type.html" target="_self">WBTPacketBitmapTable</A></TH>
234      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
235      <TD>Table that manages the pointers to bitmap buffers to manage the reception progress of data requested by other parties.</TD>
236    </TR>
237    <TR>
238      <TH width="25%"><A href="wbt_recv_buf_table_type.html" target="_self">WBTRecvBufTable</A></TH>
239      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
240      <TD>Table that manages pointers to where data reception requested by other parties is stored.</TD>
241    </TR>
242    <TR>
243      <TH width="25%"><A href="wbt_request_sync_callback_type.html" target="_self">WBTRequestSyncCallback</A></TH>
244      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
245      <TD rowspan="5">Structure passed when the callback completes.
246      <BR> See the <A href="wbt_command_type_const.html" target="_self"><CODE>WBTCommandType</CODE></A> function for details.</TD>
247    </TR>
248    <TR>
249      <TH width="25%"><A href="wbt_get_block_done_callback_type.html" target="_self">WBTGetBlockDoneCallback</A></TH>
250      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
251      <TD></TD>
252    </TR>
253    <TR>
254      <TH width="25%"><A href="wbt_prepare_send_data_callback_type.html" target="_self">WBTPrepareSendDataCallback</A></TH>
255      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
256      <TD></TD>
257    </TR>
258    <TR>
259      <TH width="25%"><A href="wbt_recv_user_data_callback_type.html" target="_self">WBTRecvUserDataCallback</A></TH>
260      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
261      <TD></TD>
262    </TR>
263    <TR>
264      <TH width="25%"><A href="wbt_get_block_callback_type.html" target="_self">WBTGetBlockCallback</A></TH>
265      <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
266      <TD></TD>
267    </TR>
268  </TBODY>
269</TABLE>
270
271<table border="0" height="100%"><tr><td style="background-color : white;"></td></tr></table>
272
273<hr><p>CONFIDENTIAL</p></body>
274</HTML>