ページの先頭行へ戻る
WSMGR ソフトウェア開発キット V7.2 使用手引書L10

8.4.3 ファイル転送状態の問い合わせ

8.4.3.1 ファイル転送状態の問い合わせQueryTransFileメソッド

構文

object.QueryTransFile( [time] )

引数

引数は次のものです。

項目

説明

time

整数

ファイル転送状態の変化を待機する時間(秒単位)を-1、0~65535の範囲で指定します。

二重発行動作

エラー

復帰値

0:正常/その他の値:異常

対象エミュレータ

関連プロパティ

TransCode,TotalDataSize,TransDataSize,RecvRecordType, RecvRecordLength

ファイル転送メソッドによって開始したファイル転送の状態を問い合わせます。


引数「time」へ0以外の値を指定した場合、

ファイル転送状態の変化を待機します。

指定時間内に転送状態が変化しないとメソッドはタイムアウト復帰します。


引数「time」へ0を指定した場合、

現在のファイル転送状態を取得します。

既にエラーが発生している場合には、転送状態としてエラーを取得します。


引数「time」へ-1を指定した場合には無限待ちします。

引数「time」の省略時には30が指定されたものとします。


以下の情報の変化を問い合わせます。

プロパティ

ファイル転送戻り値

TransCode

全転送データサイズ

TotalDataSize

転送済みデータサイズ

TransDataSize

受信情報・レコード形式

RecvRecordType

受信情報・レコード長

RecvRecordLength

注意

ConnectXのファイル転送開始メソッド以外の方法で開始したファイル転送には対応しません。

8.4.3.2 ファイル転送状態の通知フラグNoticeTransStatusFlagプロパティ

構文

object.NoticeTransStatusFlag[=TRUE/FALSE]

データ型

整数

アクセス方法

参照/設定

設定範囲

TRUE:通知する

FALSE:通知しない

初期値

FALSE

対象エミュレータ

「NoticeTransStatus(ファイル転送状態通知)」イベントのON/OFFスイッチです。

値は設定、参照することが可能です。

初期値として「FALSE」がセットされます。


FALSEを指定した場合、

「NoticeTransStatus(ファイル転送状態通知)」イベントは発生しません。

TRUEを指定した場合、

ファイル転送状態の変化を「NoticeTransStatus(ファイル転送状態通知)」イベントで通知します。

8.4.3.3 ファイル転送状態の通知NoticeTransStatusイベント

構文

object. NoticeTransStatus( )

引数

なし

復帰値

意味を持ちません

対象エミュレータ

関連プロパティ

NoticeTransStatusFlag,TransCode,TotalDataSize,TransDataSize, RecvRecordType,RecvRecordLength

以下の情報に変化があった場合に当イベントが発生します。

プロパティ

ファイル転送戻り値

TransCode

全転送データサイズ

TotalDataSize

転送済みデータサイズ

TransDataSize

受信情報・レコード形式

RecvRecordType

受信情報・レコード長

RecvRecordLength

「NoticeTransStatusFlag(ファイル転送状態通知フラグ)」プロパティへFALSEを指定した場合、イベントは発生しません。

注意

ConnectXのファイル転送開始メソッド以外の方法で開始したファイル転送には対応しません。

8.4.3.4 ファイル転送戻り値TransCodeプロパティ

構文

object.TransCode

データ型

整数

アクセス方法

参照

初期値

対象エミュレータ

ファイル転送状態を表す「ファイル転送戻り値」が格納されます。

値は参照のみ可能です。


アプリケーションは、「QueryTransFile(転送状態の問い合わせ)」メソッドの復帰、

または、

「NoticeTransStatus(転送状態通知)」イベントの発生によって値の変化するタイミングを知ることができます。


以下のファイル転送戻り値が格納されます。

ファイル転送状態

コード変換エラーが発生しました。ファイル転送は継続します。

-1

<正常>ファイル転送がスタートしました。

1

<正常>ファイル転送中。転送済みバイト数・・・。

2

<正常>ファイル転送が完了しました。

3

レコード長を超えたレコードがありました。

4

PCファイルの指定が無効です。

  • ファイルが指定されていない。

  • ファイル名長オーバー。

5

PCディスクの読み取りエラー。

  • 送信ファイルが見つかりません。

  • 送信ファイルがクローズできません。

  • ファイルの読込みに失敗しました。

  • 指定されたドライブ番号は無効です。

  • ドライブの準備が出来ていません。

9

PCディスクの書き込みエラー。

  • 新規入れ替え指定で受信ファイルが作成できません。

  • 格納ファイルが見つかりません。

  • ディスクの空き領域が足りません。

  • 受信ファイルがクローズできません。

  • ファイルの書込みに失敗しました。

  • 指定されたドライブ番号は無効です。

  • ドライブの準備が出来ていません。

12

オプションの指定が正しくありません。

18

ホストとの通信順序エラーです。

27

オプションxxxxの値が正しくありません。

43

ファイル転送中にエラーが発生しました。

  • DFインタフェースが異常終了しました。

  • 圧縮変換エラーが発生しました。

  • 指定要求が実行できません。

97

8.4.3.5 全転送データサイズTotalDataSizeプロパティ

構文

object.TotalDataSize

データ型

整数

アクセス方法

参照

初期値

対象エミュレータ

ファイル転送するデータの総量をバイト単位で表します。

値は参照のみ可能です。

アプリケーションは、「QueryTransFile(転送状態の問い合わせ)」メソッドの復帰、または、「NoticeTransStatus(転送状態通知)」イベントの発生によって値の変化するタイミングを知ることができます。


不定長データ転送時には-1がセットされます。

8.4.3.6 転送済みデータサイズTransDataSizeプロパティ

構文

object.TransDataSize

データ型

整数

アクセス方法

参照

初期値

対象エミュレータ

実行中のファイル転送において、転送済みのデータサイズをバイト単位で表します。

値は参照のみ可能です。

アプリケーションは、「QueryTransFile(転送状態の問い合わせ)」メソッドの復帰、または、「NoticeTransStatus(転送状態通知)」イベントの発生によって値の変化するタイミングを知ることができます。

8.4.3.7 受信情報・レコード形式RecvRecordTypeプロパティ

構文

object.RecvRecordType

データ型

整数

アクセス方法

参照

初期値

対象エミュレータ

受信するホストデータセットのレコード形式が格納されます。

ファイル送信時には意味を持ちません。

値は参照のみ可能です。

アプリケーションは、「QueryTransFile(転送状態の問い合わせ)」メソッドの復帰、または、「NoticeTransStatus(転送状態通知)」イベントの発生によって値の変化するタイミングを知ることができます。


「RecvRecordType」へ格納される値に次のものがあります。

意味

定義名

可変長

CX_RTYPE_VARIABLE

1

固定長

CX_RTYPE_FIXED

2

8.4.3.8 受信情報・レコード長RecvRecordLengthプロパティ

構文

object.RecvRecordLength

データ型

整数

アクセス方法

参照

初期値

対象エミュレータ

受信するホストデータセットのレコード長が格納されます。(単位:バイト)

ファイル送信時には意味を持ちません。

値は参照のみ可能です。

アプリケーションは、「QueryTransFile(転送状態の問い合わせ)」メソッドの復帰、または、「NoticeTransStatus(転送状態通知)」イベントの発生によって値の変化するタイミングを知ることができます。