WBT_RegisterBlock

構文

#include <nitro/wbt.h>

BOOL WBT_RegisterBlock(WBTBlockInfoList *block_info_list, u32 block_id, const void *user_id, const void *data_ptr, int data_size, u16 permission_bmp);

引数

block_info_list 登録に使用するWBTBlockInfoList構造体のポインタ
この構造体はWBT_UnregisterBlock( )で解放されるまでWBTライブラリで使用されます。
block_id 登録するブロックに割り当てる一意のユーザ定義値
この値はWBT_BLOCK_ID_MINより大きな値のみ使用可能です。
user_id ブロックに付与するWBT_USER_ID_LENバイト分のユーザ定義情報
data_ptr ブロックデータの格納されたバッファ
この値がNULLでない場合、WBT_UnregisterBlock( )で解放されるまで
バッファはWBTライブラリに参照されるので変更や破棄はできません。
この値がNULLの場合、必要に応じてWBT_CMD_SYSTEM_CALLBACKコールバックにWBT_CMD_PREPARE_SEND_DATAイベントとして
部分的なバッファ準備要求が通知されます。
data_size ブロックデータのサイズ
permission_bmp 今後の拡張のために予約されています。
常に0を指定します。

返り値

指定されたブロックIDが現在登録済みでなく、かつ登録済みブロックの総数が
WBT_NUM_MAX_BLOCK_INFO_ID 未満であれば登録して TRUE を返します。
そうでないなら何もせず FALSE を返します。

説明

指定された情報を元にデータブロックをWBT内部のブロックリストへ登録します。
登録したブロックは、通信相手からWBT_GetBlock( )で受信可能になります。

参照

WBT_UnregisterBlock, WBT_GetBlockInfo, WBT_GetBlock
WBTBlockInfoList

履歴

2004/09/21 初版