「ファイルの一覧を取得」アクティビティのご紹介をします。
1.アクティビティのプログラム名
RCA.Activities.FTP.EnumerateFiles
2.説明
Studio バージョン 2.0.2.0まで
クイックアクセス： 「ツールボックス」 > 「FTP」 > 「ファイルの一覧を取得」
Studio バージョン 2.0.3.0から
クイックアクセス： 「ツールボックス」 > 「FTP」 > 「ファイルの一覧を取得」
指定したFTPサーバーパスに存在するファイルのリストを取得し保存することができます。
※動作を確認したコボットStudioのバージョン：2.1.1.2
※バージョンによって文言などが一部異なる場合がございます
3.プロパティ
| プロパティ項目 | プロパティ名 | 入力欄 | 説明 |
|---|---|---|---|
| オプション | サブフォルダを含める | チェック項目 | チェックを入れるとサブフォルダ内のファイルも含めて取得する。 |
| その他 | ContinueOnError | 値を入力（Boolean型） | エラー時に後続の処理に進む。 |
| パブリック | チェック項目 | ログにアクティビティ内の変数と引数がログファイルに書き込まれ、Centerにプッシュされる。（詳細は「プロパティ項目「パブリック」について」を参照） | |
| 表示名 | 任意の文字列 | デザイナーパネルのアクティビティ名に反映される。 | |
| 出力 | ファイル | 値を入力（IEnumerable<FtpObjectInfo>型） | 取得したファイルの一覧を格納する変数を設定する。 |
| 入力 | リモートパス | 値を入力（String型） | ファイルの一覧を取得するFTPサーバー上のフォルダのパスを設定する。 |
4.使い方
「ファイルの一覧を取得する」アクティビティの実際の使用例を元に説明します。
【例】FTPサーバー上のフォルダ「ftp_test」内にあるファイルの一覧を取得しメッセージボックスに出力する。
今回一覧を取得するディレクトリは以下のような内容になっています。
「FTP」 > 「FTPスコープ」アクティビティを配置し、ファイル一覧の取得を行いたいFTPサーバーへの接続設定を行います。その後、「FTP」 > 「ファイルの一覧を取得」アクティビティを「FPTスコープ」内にドラッグ＆ドロップで配置します。
配置したらプロパティを設定します。「出力」 > 「ファイル」と「入力」 > 「リモートパス」をそれぞれ以下のように設定します。
- ファイル：IEnumerable<FtpObjectInfo>型変数 ※今回は「GetList」を設定し、以後GetListと記載します。
- リモートパス：”/ftp_test/”（「"/ftp_test"」も可能です）
※変数の作成方法について詳しくは「変数の作成」をご参照ください。
※FTPサーバーのルートパスを指定する場合は「リモートパス」プロパティに「"/"」を設定します。
次に「システム」 > 「コントロールフロー」 > 「繰り返し(コレクションの各要素)」アクティビティをドラッグ＆ドロップでデザイナーパネルに配置します。
配置したら「その他」 > 「TypeArgument」プロパティと「入力」 > 「値」プロパティをそれぞれ以下のように設定します。
- TypeArgument：RCA.Activities.FTP.Data.FtpObjectInfo
- 値：GetList
次に「システム」 > 「オリジナル」 > 「代入」アクティビティを「繰り返し(コレクションの各要素)」内にドラッグ＆ドロップで配置します。
配置したら、「その他」 > 「代入先」プロパティと「値」プロパティをそれぞれ以下のように設定します。
- 代入先：String型変数 ※今回は「FileList」を設定し、以後とFileList記載します。
- 値： FileList + item.Name + VbLf
※「VbLf」は改行コードです。
次に「コア」 > 「ダイアログ」 > 「メッセージボックス」 アクティビティをドラッグ＆ドロップで配置し、「入力」 > 「テキスト」プロパティに「FileList」を設定します。
「ホーム > スタート」をクリック、または、「F5キー」押下で実行します。実行するとメッセージボックスにファイルの一覧が表示されます。
※今回の例では「ftp_test」フォルダ内にtxtファイルのみ保管されていましたが、フォルダが含まれていた場合はメッセージボックス内にフォルダ名も表示されます。