4.4.5 DF WHATIS

転送状態の取得

【呼出形式（C）】

UINT  XWSIAPI
XWSI_DF_WHATIS(ReqHandle,ws_errno,request_mode,wait_time,trns_status)

USHORT           ReqHandle        リクエストハンドル
UINT            *ws_errno;        処理結果
USHORT           request_mode;    要求モード
USHORT           wait_time;       応答待ち時間
XWsiTrnsStat    *trns_status;     ファイル転送状態

【機能】

現在のファイル転送の状態をDUETファイル転送インタフェースに要求します。

転送実行状態、転送率、エラー発生事象などの情報を得ることができます。

WAITモードを指定することで、転送終了まで待つことができます。

【引数】

ReqHandle	WSMGR OPENコマンドによって得られたリクエストハンドル。
ws_errno	処理結果を格納する領域のアドレス。
request_mode	要求内容により２モード指定可能。 XWSIDF_REQSENSE (0): SENSE モードファイル転送実行中の状態、転送率を得ます。すでにエラーなどの事象が発生しているときはその情報が通知されます。 XWSIDF_REQWAIT (1): WAITモード指定された時間、エラーまたは転送終了の事象が発生するのを待ちます。注) コード変換エラーが発生してもファイル転送は継続されますが、その他のタイムアウト以外のエラー発生時は、転送は終了します。
wait_time	上記modeでWAITモード時の応答待ち時間（単位：秒、0を指定した場合は無限待ち）。
trns_status	ファイル転送状態を格納する領域のアドレス。

【関数返却値】

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

【出力】

ws_errno		関数返却値＝ XWSIWSOS_ERR (1) のとき Windows API コールから返されるエラーコードが格納されます。エラーコードはWin32エラーコードが返ります。関数返却値＝ XWSIWSAPI_ERR (2) のとき WSAPI のエラーコード一覧を参照してください。関数返却値＝ XWSIWSAPI_GOOD (0) のとき意味を持たないのでアプリケーションで参照する必要はありません。
trns_status		ファイル転送状態。
	1)trns_state	転送状態
		XWSIDF_STIDLE	(0)	ファイル転送Idle／終了状態
		XWSIDF_STTRAN	(1)	ファイル転送実行中
		XWSIDF_STWAITP	(2)	パラメータ（DF SETPARA）待ち
		注) DF SETPARA完了後のXWSIDF_STIDLEは転送が終了したことを意味します。
	2)trns_rate_unit	転送率の内容に対応した値 '%'(X'25') - パーセント 'B'(X'42') - バイト数
	3)trns_rate	転送率

【注意事項】

ホストの状態や回線の状態によっては、DF_WHAITSでファイル転送の終了を確認した直後にKCインタフェースを使用するとエラー(2020DUET処理中にKCインタフェースをCALLしました)になります。このエラーは、ホスト処理や回線の状態により、ファイル転送の終了とホストからのインジケータの変更にタイムラグが発生するため起こります。

この場合は、もう一度KCインタフェースを発行してください。