Home > コンポーネント シリーズ > FTP > FTP - 設定 > FTP - メソッド

FTP - メソッド

以下のメソッドを使用してFTPコンポーネントを構成します。

FTPコンポーネントのダイレクトアクセスメソッドは、環境変数をサポートしていません。

次の表では、使用できるメソッドおよびパラメータを一覧にしています。太字のパラメータは必須です。全てのメソッドは接続情報を含みます。

メソッド

パラメタ

説明

Append File

リモートサーバディレクトリにファイルを追加上書きします。

送り元ファイル名

FTPサーバ上に追加するファイルのフルパスおよび名前(そのパスおよび名前には、ローカルコンピュータ上のソースファイルの名前およびパスを指定してください)。

送り先ファイル名

FTPサーバ上に追加されたファイルのフルパスおよび名前(パスおよび名前には、FTPサーバ上のファイルの名前およびパスを指定してください)。

例: Folder1\Folder2\Test.txt

転送モード

転送モードをドロップダウンリストから選択します。

  • ASCII

  • Binary

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Change Directory

リモートサーバの現在アクティブなディレクトリを変更します。

ディレクトリ名

FTPサーバの作業ディレクトリの変更したい名前を入力します。

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Delete File

リモートサーバディレクトリからファイルを削除します。

ファイル名

FTPサーバから削除するファイルのフルパスおよび名前です。パスおよび名前には、FTPサーバ上のファイルのパスおよび名前を指定してください。

例: Folder1\Folder2\Test.txt

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Directory Listing

ディレクトリコンテンツのリストを定義済みXML形式で返します。

ディレクトリ名

リストにしたいFTPサーバディレクトリの名前を入力します。

出力XML

出力BLOBをXMLファイルにするかどうか以下のいずれかをドロップダウンリストから選択します:

  • Yes

  • No

ディレクトリリスト

をクリックし変数リストを開きます。ディレクトリ内容が返される変数を選択し[選択]をクリックします。

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

File Exists

リモートサーバのディレクトリにファイルがあるかどうかチェックします。

名前

チェックしたいファイルの名前を入力します。

ファイル存在

このパラメータはリモートサーバにファイルが存在するかどうかを示します。

をクリックして変数リストを開き、どこにこの情報を保持したいか指定します。

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Get File

リモートサーバディレクトリからファイルを受信(get)します。

送り元ファイル名

FTPサーバから取り出されるファイルのフルパスと名前。パスと名前は、オリジナルの位置とFTPサーバ上のファイルの名前を指定してください。

例えば: Folder1\Folder2\Test.txt

送り先ファイル名

ローカルコンピュータ上にコピーするファイルのフルパスおよび名前。パスおよび名前には、ローカルコンピュータ上のファイルの名前およびパスを指定してください。

転送モード

転送モードをドロップダウンリストから選択します。

  • ASCII

  • Binary

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Get Operating System

選択したサーバのOS情報とデータの返される場所の詳細を指定します。

オペレーティングシステム

クリックして変数リストを開きます。OSによって返される環境変数を選択することができます。

このメソッドは、Unicodeデータで返ります。

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Local Change Directory

次のメソッドのデフォルトディレクトリを変更します: Get File, Multi Get,Put File, Multi Put

このメソッドを使用して、例えばデフォルトローカルディレクトリを%Magic xpi%から"d:\temp"に変更します

ディレクトリ名

FTPサーバ上で変更されたディレクトリのフルパスです。デフォルトローカルディレクトリの値をリセット( %Magic xpi%に戻す)するには、Local Change Directory メソッドの[ディレクトリ名]パラメータに値を設定しないでください。

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Make Directory

リモートサーバのディレクトリにディレクトリを作成します。

ディレクトリ名

FTPサーバ上で作成するディレクトリをフルパスで指定します。

サブディレクトリを含める

メインディレクトリにサブディレクトリを含めるかどうかを以下のドロップダウンリストから選択します。

  • Yes

  • No

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Multi Del

リモートサーバのディレクトリから複数のファイルを削除します。

フィルタ

フィルタ定義はワイルドカード(*,?)を使用して、特定の方法で名前が付けられているファイルをフィルタリングする場合に使用します。

サブディレクトリを含める

メインディレクトリにサブディレクトリを含めるかどうかを以下のドロップダウンリストから選択します。

  • Yes

  • No

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Multi Get

リモートサーバのディレクトリから複数のファイルを取得します。

送り先フォルダ

ローカルコンピュータ上にコピーするフォルダのフルパスおよび名前を入力します。パスおよび名前には、ローカルコンピュータ上のフォルダの名前およびパスを指定してください。

フィルタ

フィルタ定義はワイルドカード(*,?)を使用して、特定の方法で名前が付けられているファイルをフィルタリングする場合に使用します。

転送モード

転送モードをドロップダウンリストから選択します。

  • ASCII

  • Binary

サブディレクトリを含める

メインディレクトリにサブディレクトリを含めるかどうかを以下のドロップダウンリストから選択します。

  • Yes

  • No

上書き

既存のファイルを上書きするかどうかを以下のドロップダウンリストから選択します。

  • Yes

  • No

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Multi Put

リモートサーバのディレクトリに複数のファイルを転送します。

送り先フォルダ

FTPサーバのファイルのコピー先のフルパスと名前

フィルタ

フィルタ定義はワイルドカード(*,?)を使用して、特定の方法で名前が付けられているファイルをフィルタリングする場合に使用します。

転送モード

転送モードをドロップダウンリストから選択します。

  • ASCII

  • Binary

サブディレクトリを含む

メインディレクトリにサブディレクトリを含めるかどうかを以下のドロップダウンリストから選択します。

  • Yes

  • No

上書き

既存のファイルを上書きするかどうかを以下のドロップダウンリストから選択します。

  • Yes

  • No

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Put File

リモートサーバのディレクトリにファイル転送します。

送り元ファイル名

FTPサーバに転送するファイルのフルパスおよび名前を入力します。パスおよび名前には、ローカルコンピュータ上のファイルの元のパスおよび名前を指定してください。

送り先ファイル名

FTPサーバ上に置くファイルのフルパスおよび名前を入力します。パスおよび名前には、FTPサーバ上のファイルの名前およびパスを指定してください。

例えば: Folder1\Folder2\Test.txt

転送モード

転送モードをドロップダウンリストから選択します。

  • ASCII

  • Binary

上書き

既存のファイルを上書きするかどうかを以下のドロップダウンリストから選択します。

  • Yes

  • No

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Remove Directory

リモートサーバのディレクトリ内のディレクトリを削除します。

ディレクトリ名

FTPサーバから削除するディレクトリのフルパスを入力します。

サブディレクトリを含める

メインディレクトリにサブディレクトリを含めるかどうかを以下のドロップダウンリストから選択します。

  • Yes

  • No

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Rename File

FTPサーバのディレクトリ内のファイルやディレクトリをリネームします。

送り元ファイル名

FTPサーバ上で移動され、リネームされるファイルの元のパスとファイル名を入力します。パスおよびファイル名には、FTPサーバ上のファイルの元の場パスおよびファイル名を指定してください。

送り先ファイル名

FTPサーバで転送、リネームされた後のフルパスとファイル名を入力します。パスと名前はそのファイルの新しい名前でFTPサーバ上を指定する必要があります。

エラーコード

このパラメータは、エラーが発生した場合、対応するエラーコードとともに返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

Run Server Command

FTPサーバーでカスタムサーバーコマンドを実行します。

コマンド

サーバーで実行するサーバーコマンド式を入力します。 コマンドに許可される最大長は1000文字です。

サイトコマンドの実行メソッドの一部として、ACTV(アクティブモード)コマンドの実行はサポートされていません。 同じことを実行すると、想定しない結果が生じる可能性があります。

コマンドの戻り値

FTPサーバーから返されるコマンド応答を設定します。(blobタイプ)。 コマンドが失敗すると、エラー変数「505 Operation Fail」がエラー変数に入力されます。

エラーコード

エラーが発生すると、対応するエラーコードとともにこのパラメーターが返されます。

をクリックし、変数リストを開きます。エラーコードが返される変数を選択し、[選択]をクリックします。

関連トピック:

ダイレクトアクセスメソッドの使い方