4.4.6 DF CANCEL

転送のキャンセル

【呼出形式（C）】

UINT  XWSIAPI 
XWSI_DF_CANCEL(ReqHandle,ws_errno,wait_time）

USHORT      ReqHandle      リクエストハンドル
UINT       *ws_errno       処理結果
USHORT      wait_time      応答待ち時間

【機能】

ファイル転送実行中にファイル転送のキャンセルを要求します。

DF WAITSTART完了後、要求が可能です。このインタフェースは、キャンセル処理終了後、アプリケーションに復帰します。

【引数】

ReqHandle	WSMGR OPENコマンドによって得られたリクエストハンドル。
ws_errno	処理結果を格納する領域のアドレス。
wait_time	応答待ち時間（単位秒/0:無限待ち）。

【関数返却値】

XWSIWSAPI_GOOD	(0)	WSAPI が正常に処理されました。
XWSIWSOS_ERR	(1)	WSMGR でWindows API コールを行いその結果エラーになった場合、設定されます。また、そのとき受け取ったエラーコードをws_errno に格納します。
XWSIWSAPI_ERR	(2)	WSAPI が異常で終了したことを示します。エラー詳細は、ws_errno に格納されます。

【出力】

ws_errno

ws_errno 関数返却値＝ XWSIWSOS_ERR (1) のとき
Windows API コールから返されるエラーコードが格納されます。
エラーコードはWin32エラーコードが返ります。

関数返却値＝ XWSIWSAPI_ERR (2) のとき
WSAPI のエラーコード一覧を参照してください。

関数返却値＝ XWSIWSAPI_GOOD (0) のとき
意味を持たないのでアプリケーションで参照する必要はありません。

【注意事項】

応答待ち時間を無限待ちに設定した場合、ホスト側のトラブルなどで返ってこないことがあります。

また、応答待ち時間タイムアウトが発生してもキャンセル処理は継続されます。したがって、再度DF CANCEL を発行した場合、すでに転送が終了しているためにエラーコードが返ります。