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>WBT_GetBlock</title> 9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css"> 10</head> 11 12<body> 13 14<h1 align="left">WBT_GetBlock <img src="../../image/NTR.gif"><img src="../../image/TWL.gif"></h1> 15<h2>Syntax</h2> 16 17<dl> 18 <dd> 19<CODE>#include <nitro/wbt.h></CODE><BR> <BR> <CODE>BOOL WBT_GetBlock(u16 target, u32 block_id, <A href="../wbt_recv_buf_table_type.html">WBTRecvBufTable</A> *recv_buf_table, u32 recv_size, <A href="../wbt_packet_bitmap_table_type.html">WBTPacketBitmapTable</A> *p_bmp_table, <A href="../wbt_callback_type.html">WBTCallback</A> callback);</CODE><br> <br> 20 </dd> 21</dl> 22<h2>Arguments</h2> 23<p> 24<TABLE border="1" width="100%"> 25 <TBODY> 26 <TR> 27<TD width="13%"><CODE>target</CODE></TD> 28<TD width="87%">Target AID bitmap that receives block data.<br /> When child, only parent <code>1</code> can be specified.</TD> 29 </TR> 30 <TR> 31<TD width="13%"><CODE>block_id</CODE></TD> 32<TD width="87%">Block ID of the data to receive. The specified block ID must be recorded with the <A href="../common/WBT_RegisterBlock.html"><CODE>WBT_RegisterBlock</CODE></A> function on the object side.</TD> 33 </TR> 34 <TR> 35<TD width="13%"><CODE>recv_buf_table</CODE></TD> 36<TD width="87%">Pointer to the <A href="../wbt_recv_buf_table_type.html"><CODE>WBTRecvBufTable</CODE></A> table containing the storage address (receive archive record) of the data to receive. You must set a valid storage address for all AIDs specified with the target in this table.</TD> 37 </TR> 38 <TR> 39<TD width="13%"><CODE>recv_size</CODE></TD> 40<TD width="87%">Receive size of the data.</TD> 41 </TR> 42 <TR> 43<TD width="13%"><CODE>p_bmp_table</CODE></TD> 44<TD width="87%">A pointer to the <A href="../wbt_packet_bitmap_table_type.html"><CODE>WBTPacketBitmapTable</CODE></A> table containing the bitmap buffer to manage the progress of the data to receive. You must set a valid bitmap buffer for all AIDs specified with the target in this table. Any AID not specified by target can be <CODE>NULL</CODE>. 45</TD> 46 </TR> 47 <TR> 48<TD width="13%"><CODE>callback</CODE></TD> 49<TD width="87%"><A href="../wbt_callback_type.html"><CODE>WBTCallback</CODE></A> format function that receives notifications when commands are completed. This callback is called from within the <a href="../parent/WBT_MpParentRecvHook.html"><CODE>WBT_MpParentRecvHook</CODE></a> or <a href="../child/WBT_MpChildRecvHook.html">WBT_MpChildRecvHook</CODE></a> function. 50</TD> 51 </TR> 52 </TBODY> 53</TABLE> 54</p> 55 56<h2>Return Values</h2> 57<p>If no command is currently processing, the function issues a command and returns <CODE>TRUE</CODE>. Otherwise, the function does nothing and returns <CODE>FALSE</CODE>.</p> 58 59<H2>Description</H2> 60<p>Receives block data from a specified target device.<br> <font color="#800000">The call fails if a command is still processing.</font> <br> 61</p> 62<H2>See Also</H2> 63<p> 64<A href="WBT_RequestSync.html"><CODE>WBT_RequestSync</CODE></A><BR> <A href="WBT_GetBlockInfo.html"><CODE>WBT_GetBlockInfo</CODE></A><BR> <A href="WBT_PutUserData.html"><CODE>WBT_PutUserData</CODE></A> 65</p> 66<H2>Revision History</H2> 67<P> 682006/03/13 Revised description of target argument.<br> 2005/06/01 Added statement about the callback being called from the <CODE>WBT_MpParentRecvHook</CODE> or <CODE>WBT_MpChildRecvHook</CODE> function.<br> 2005/02/18 Changed description of packet_bitmap to "bitmap buffer for receive history record."<br> 2004/09/21 Initial version. 69</P> 70<hr><p>CONFIDENTIAL</p></body> 71</html> 72
