4.13.32 ファイル削除
機能
この部品は,指定した実行対象サーバの指定したパスに存在するファイルを削除します。
実行対象サーバのOSがWindowsの場合,この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合,または,無効の場合,システムアカウントで実行を行う部品「ファイル削除(SYSTEM)」を実行してください。
利用場面
ファイル転送部品によって転送したファイルを削除する場合や,ほかの部品によって出力されたファイルを削除する場合に使用します。
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については,リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象サーバ内前提製品】
なし。
【実行対象サーバの稼働OS】
(1) Windows Server
(2) Red Hat Enterprise Linux Server
(3) Oracle Linux
【実行対象サーバの使用条件】
なし。
注意事項
(1)この部品はファイルだけ削除できます。フォルダやディレクトリは削除できません。フォルダやディレクトリの削除を行う場合は,osDeleteFolder部品を使用してください。
バージョン
04.00.00
部品のタグ
Control OS,Windows,Linux
タスクログに表示される部品の名称
osDeleteFile
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
12 |
異常(ユーザーミス) プロパティ不正 |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
common.filePath |
ファイルパス |
削除するファイルをフルパスで指定します。 |
− |
入力 |
○ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |