FTP コネクタのメソッド

FTP コネクタのメソッドは、自動化の一部として、ファイル転送プロトコル (FTP) サーバー上でさまざまなアクションを実行します。メソッドを有効にするには、適切なパラメーターを指定する必要があります。

SetConfiguration

ファイル転送プロトコル (FTP) サーバーアクセスの詳細を設定します。最初にこのメソッドを実行する必要があります。

パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

表 : 1. SetConfiguration メソッドのパラメーター

パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
URL	ファイル転送プロトコル (FTP) の URL	データ入力	文字列	なし	あり
ユーザー名	ファイル転送プロトコル (FTP) サーバーにアクセスするためのユーザー名。	データ入力	文字列	なし	あり
パスワード	ファイル転送プロトコル (FTP) サーバーにアクセスするためのパスワードです。	データ入力	文字列	なし	あり

CreateFolder

ファイル転送プロトコル (FTP) サーバーにフォルダを作成します。

パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

表 : 2. CreateFolder メソッドのパラメーター

パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
FolderName	フォルダ名でフォルダが作成される ファイル転送プロトコル (FTP) サーバー内のパスです。	データ入力	文字列	なし	あり
戻る	フォルダが作成された場合は True を返し、それ以外の場合は False を返します。	データ出力	ブール	なし	適用外

DeleteFile

FTP サーバー内のファイルを削除します。

パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

表 : 3. DeleteFile メソッドのパラメーター

パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
RemoteFilePath	ファイル転送プロトコル (FTP) サーバー内の削除するファイルへのパスです。	データ入力	文字列	なし	あり
戻る	ファイルが削除された場合は True を返し、それ以外の場合は False を返します。	データ出力	ブーリアン	適用外	適用外

DeleteFolder

ファイル転送プロトコル (FTP) サーバー内の指定されたフォルダを削除します。

パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

表 : 4. DeleteFolder メソッドパラメーター

パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
RemoteFolderPath	フォルダ名を含む ファイル転送プロトコル (FTP) サーバー内のフォルダへのパスです。	データ入力	文字列	なし	あり
戻る	フォルダが削除された場合は True を返し、それ以外の場合は False を返します。	データ出力	ブーリアン	適用外	適用外

DownloadFile

ファイル転送プロトコル (FTP) サーバーからローカルドライブにファイルをダウンロードします。

パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

表 : 5. DownloadFile メソッドのパラメーター

パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
RemoteFile	ファイル転送プロトコル (FTP) 内のファイルへのパスとファイル名。	データ入力	文字列	なし	あり
LocalFile	ファイルがダウンロードされるローカルドライブ内のパスです。	データ入力	文字列	なし	あり
タイムアウト	ファイル転送プロトコル (FTP) サーバーへの要求がタイムアウトするまでの時間です。	データ入力	整数	なし	いいえ
戻る	ファイルがダウンロードされた場合は True を返し、それ以外の場合は False を返します。	データ出力	ブール	なし	適用外

DownloadFolder

ファイル転送プロトコル (FTP) サーバーからローカルドライブにフォルダをダウンロードします。

パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

表 : 6. DownloadFolder メソッドのパラメーター

パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
RemoteFolderPath	ファイル転送プロトコル (FTP) 内のフォルダへのパスとフォルダ名。	データ入力	文字列	なし	あり
LocalFolderPath	フォルダがダウンロードされるローカルドライブ内のパスです。	データ入力	文字列	なし	あり
タイムアウト	ファイル転送プロトコル (FTP) サーバーへの要求がタイムアウトするまでの時間です。	データ入力	整数	なし	いいえ
戻る	フォルダがダウンロードされた場合は True を返し、それ以外の場合は False を返します。	データ出力	ブール	なし	適用外

GetFileList

ファイル転送プロトコル (FTP) サーバー内のフォルダのファイルのリストを返します。

パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

表 : 7. GetFileList メソッドのパラメーター

パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
RemoteFolderPath	ファイル転送プロトコル (FTP) 内のフォルダへのパスとフォルダ名。	データ入力	文字列	なし	あり
戻る	フォルダ内のファイルのリストを返します。	データ出力	文字列	適用外	適用外

RenameFile

ファイル転送プロトコル (FTP) サーバー内のファイル名を変更します。

パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

表 : 8. RenameFile メソッドのパラメーター

パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
RemoteFilePath	ファイル転送プロトコル (FTP) サーバー内のファイルへのパスとファイル名です。	データ入力	文字列	なし	あり
NewNameofFile	ファイル転送プロトコル (FTP) サーバー内のファイルへのパスとファイルの新しい名前。	データ入力	文字列	なし	あり
戻る	ファイル名が変更された場合は True を返し、それ以外の場合は False を返します。	データ出力	ブーリアン	適用外	適用外

RenameFolder

ファイル転送プロトコル (FTP) サーバー内のフォルダ名を変更します。

パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

表 : 9. RenameFolder メソッドのパラメーター

パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
RemoteFolder	ファイル転送プロトコル (FTP) サーバー内のフォルダへのパスとフォルダ名です。	データ入力	文字列	なし	あり
NewNameofFolder	ファイル転送プロトコル (FTP) サーバー内のフォルダへのパスとフォルダの新しい名前です。	データ入力	文字列	なし	あり
戻る	フォルダ名が変更された場合は True を返し、それ以外の場合は False を返します。	データ出力	ブーリアン	適用外	適用外

UploadFile

ローカルドライブから ファイル転送プロトコル (FTP) サーバーにファイルをアップロードします。

パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

表 : 10. UploadFile メソッドのパラメーター

パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
LocalFilePath	ローカルドライブ内のファイルへのパスです。	データ入力	文字列	なし	あり
RemoteFilePath	ファイル転送プロトコル (FTP) サーバー内の場所へのパス	データ入力	文字列	なし	あり
戻る	ファイルがアップロードされた場合は True を返し、それ以外の場合は False を返します。	データ出力	ブーリアン	適用外	適用外

UploadFolder

ローカルドライブから ファイル転送プロトコル (FTP) サーバーにフォルダをアップロードします。

パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

表 : 11. UploadFolder メソッドのパラメーター

パラメーター	説明	データポートタイプ	データタイプ	デフォルト値	必須？
LocalFolderPath	ローカルドライブ内のフォルダへのパスです。	データ入力	文字列	なし	あり
RemoteFolderPath	ファイル転送プロトコル (FTP) サーバー内の場所へのパス。	データ入力	文字列	なし	あり
戻る	フォルダがアップロードされた場合は True を返し、それ以外の場合は False を返します。	データ出力	ブーリアン	適用外	適用外