4.13.46 文字列の追加
機能
この部品は,ファイルの末尾に文字列を追加します。
文字列を追加したいファイルパス(common.strFilePathプロパティ)と追加する文字列(common.addStrプロパティ)を入力すると,指定したファイルの末尾に文字列を追加します(具体的には,End Of Fileが存在する行の1つ下の行に文字列を追加し改行を行います。ただし,指定したファイルが存在しなかった場合,ファイル作成後,1行目に文字列を追加して改行を行います)。
文字列を追加するファイルのパス(common.strFilePathプロパティ)には,ワイルドカードを使用したファイルのパスは指定できません。
追加する文字列は,実行対象サーバがWindowsの場合はOSのデフォルト文字コードで,UNIXの場合はユーザーの環境変数[LANG]で指定している文字コードで追加されます。
文字列を追加したいファイルパス(common.strFilePathプロパティ)について,次に示します。
・文字列を追加したいファイルをフルパスで指定してください。
・指定したファイルが存在しない場合,ファイルを作成して文字列を書き込みます。
・フォルダが存在しない場合,フォルダを作成後にファイルを作成し,文字列を書き込みます。
追加する文字列(common.addStrプロパティ)について,次に示します。
・正規表現の使用はサポートしていません。
・WindowsおよびUNIX問わず,「"」および「'」は入力しないでください。
実行対象サーバがWindowsおよびLinuxの場合,「"」を指定する場合は「¥0x22」,「'」を指定する場合は「¥0x27」と入力してください。
・実行対象サーバがWindowsの場合,「`t」(タブ)および「`r`n」(改行)のメタ文字を使用できます。
・実行対象サーバがUNIXの場合,「¥t」(タブ)および「¥n」(改行)のメタ文字を使用できます。
ただし,Linuxの場合,末尾の「¥n」(改行)は無視されます。
利用場面
定義ファイルを編集する場合に利用できます。
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については,リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象サーバ内前提製品】
なし。
【実行対象サーバの稼働OS】
(1) Windows Server
(2) Red Hat Enterprise Linux Server
(3) Oracle Linux
【実行対象サーバの使用条件】
なし。
注意事項
(1)common.strFilePathプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2)この部品をバイナリファイルに対して使用しないでください。バイナリファイルに対して使用した場合,ファイルが壊れるおそれがあります。
(3)この部品を同一ファイルに対して同時に実行しないでください。同一ファイルに対して同時に実行した場合,文字列の追加に失敗するおそれがあります。
(4)LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時,上位のロケール環境変数が優先されてしまうため,部品を実行する際に,LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか,LANG環境変数と同一の値に変更してください。
バージョン
04.00.00
部品のタグ
Control OS,Windows,Linux
タスクログに表示される部品の名称
osAddString
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
12 |
異常(ユーザーミス) プロパティ不正 |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
common.strFilePath |
文字列を追加するファイルのパス |
文字列を追加するファイルのフルパスを指定します。 |
− |
入力 |
○ |
common.addStr |
追加する文字列 |
ファイルに追加する文字列を指定します。1024文字以内の文字列を指定することを推奨します。推奨値を超える文字列を指定すると,実行対象サーバのOSによっては,指定した文字列の一部が消える場合があります。 |
− |
入力 |
○ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
− |