Function Reference

_FTP_ProgressDownload

プログレスウィンドウを表示しながら、またはユーザー定義関数を呼ぶことでバイナリモードでファイルをダウンロードします。

#Include <FTPEx.au3>
_FTP_ProgressDownload($l_FTPSession, $s_LocalFile, $s_RemoteFile [, $FunctionToCall = ""])

 

パラメータ

$l_FTPSession _FTP_Connect()の返し値
$s_LocalFile 作成するローカルファイル
$s_RemoteFile リモートの元ファイル
$FunctionToCall [オプション]プログレスバーの更新と中止やアプリケーション終了のためのクリックなどのユーザー入力に対応する関数(以下に詳しい情報があります)

 

返し値

成功: 1
失敗: 0を返し、@errorを設定します:
@error: -1 - ローカルファイルを作成できません
-3 - リモートファイルのオープンに失敗
-4 - リモートファイルノ読み込みに失敗
-5 - リモートファイルを閉じるのに失敗
-6 - 進行状況のための関数によってダウンロードが中止されました。呼ばれた関数が返ります。

 

注意

$FunctionToCallについて:
   パラメータ: $Percentage - 進行状況のパーセンテージ
   返し値: ダウンロード継続 - 1
                  ダウンロード中止 - 0または0より小さい値
                       以上の返し値は _FTP_ProgressDownload()によっても返されます。
                       ユーザーによる中止、アプリケーションの終了、タイムアウトなど異なるアクションに対応できます。
   例:
                   Func _UpdateProgress($Percentage)
                      ProgressSet($percent,$percent &"%")
                      If _IsPressed("77") Then Return 0 ; F8で中断
                      Return 1 ; 1で再開
                   Endfunc

                   Func _UpdateProgress($Percentage)
                      GUICtrlSetData($ProgressBarCtrl,$percent)
                      Switch GUIGetMsg()
                         Case $GUI_EVENT_CLOSE
                            Return -1 ; _FTP_DownloadProgressが-1で中断。以降でアプリケーションを終了できます。
                        Case $Btn_Cancel
                           Return 0 ; 返し値なしのキャンセル
                      EndSwitch
                      Return 1 ; ダウンロード継続
                   Endfunc

 

関連