WBT_GetBlock

C Specification

#include <nitro/wbt.h>

BOOL WBT_GetBlock(u16 target, u32 block_id, WBTRecvBufTable *recv_buf_table, u32 recv_size, WBTPacketBitmapTable *p_bmp_table, WBTCallback callback);

Arguments

target The target AID bitmap that receives block data. The target can specify multiple parents or children at once.
block_id The block ID of the data to receive. The specified block ID must be recorded with the WBT_RegisterBlock function on the object side.
recv_buf_table A pointer to the WBTRecvBufTable 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.
recv_size The receive size of the data.
p_bmp_table A pointer to the WBTPacketBitmapTable 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 NULL.
callback WBTCallback format function that receives notifications when commands are completed.
This callback is called from within the WBT_MpParentRecvHook or WBT_MpChildRecvHook
functions.

Return Values

If no command is currently processing, the function issues the command and returns TRUE. Otherwise, the function does nothing and returns FALSE.

Description

Receives block data from a specified target device.
The call fails if a command is still processing.

See Also

WBT_RequestSync, WBT_GetBlockInfo, WBT_PutUserData

Revision History

06/01/2005 Added statement about the callback being called from the WBT_MpParentRecvHook function or the WBT_MpChildRecvHook function.
02/18/2005 Changed description of packet_bitmap to "bitmap buffer for receive history record".
09/21/2004 Initial version