JP1 Version 8 JP1/Script(UNIX(R)用)
Message(ファイルまたはコンソール画面にテキストを出力する)
機能
ファイル,またはコンソール画面にメッセージテキストを出力します。
また,コンソール画面に表示しているメッセージテキストを消去します。
形式
Message ( Target , 〔OutputName〕 , 〔Text〕 , 〔LineLength〕 , 〔MaxLines〕 )
指定項目
Target
テキストの出力先を次の値で指定します。
値 |
意味 |
Target_File |
ファイルに出力します。 |
Target_DispOn |
コンソール画面に出力します。 |
Target_DispClear |
コンソール画面に表示しているメッセージテキストを消去します。 |
Target_DispOff |
Target_SPAFile |
実行中スクリプトの解析トレースファイルに出力します。 |
Target_SPXFile |
実行中スクリプトの実行トレースファイルに出力します。 |
OutputName
- TargetにTarget_Fileを指定した場合
出力先ファイルのフルパスを文字列,または値を格納した変数名で指定します。
- TargetにTarget_DispOn,Target_DispClear,Target_DispOff,Target_SPAFile,Target_SPXFileを指定した場合
この値は無効になります。
Text
- TargetにTarget_File,Target_DispOn,Target_SPAFile,Target_SPXFileを指定した場合
出力するメッセージテキストを文字列,または値を格納した変数名で指定します。
TargetにTarget_DispOn以外を指定した場合は,メッセージテキストに含まれる文字列,"\r", "\n", "\t", "\\"は,それぞれ対応するコントロールコードとして処理されます。コントロールコードとして処理しない場合については,「4.1.6 コーディング規則」を参照してください。
- TargetにTarget_DispOn,Target_DispClear,Target_DispOffを指定した場合
この値は無効になります。
LineLength
- TargetにTarget_Fileを指定した場合
出力するメッセージテキストの1行の長さを数値,または値を格納した変数名で指定します。メッセージテキストに含まれる"\r","\n"を除いた値を指定します。
この値はOutputNameで指定したファイル名に対して,初めてMessageコマンドを実行する場合に指定します。Messageコマンドを2回目以降に実行する場合にLineLengthの値が変更されたとき,1行の長さを変更してOutputNameで指定したファイルを新しく作成します。
この値は省略できます。省略した場合,150を仮定します。
- TargetにTarget_DispOn,Target_DispClear,Target_DispOffを指定した場合
この値は無効になります。
- TargetにTarget_SPAFile,Target_SPXFileを指定した場合
この値は無効になり,実行環境ファイルで定義されたトレース情報の最大列数を仮定します。
MaxLines
- TargetにTarget_Fileを指定した場合
出力するメッセージテキストの最大行数を数値,または値を格納した変数名で指定します。
この値はLineLengthと同様に,OutputNameで指定したファイル名に対して,初めてMessageコマンドを実行する場合に指定します。Messageコマンドを2回目以降に実行する場合にMaxLinesの値が変更されたとき,最大行数を変更してOutputNameで指定したファイルを新しく作成します。
この値は省略できます。省略した場合,1,024を仮定します。
- TargetにTarget_DispOn,Target_DispClear,Target_DispOffを指定した場合
この値は無効になります。
- TargetにTarget_SPAFile,Target_SPXFileを指定した場合
この値は無効になり,実行環境ファイルで定義されたトレース情報の最大行数を仮定します。
説明
指定したファイル,またはコンソール画面に,指定したメッセージテキストを出力します。また,出力したコンソール画面の内容を消去します。
コマンドが正常に実行された場合は真(True)を,エラーが発生した場合は偽(False)を,コマンドの実行結果として返します。
注意事項
- 複数起動の指定をしたスクリプト中に,Target_SPAFile,またはTarget_SPXFileを指定したMessageコマンドがあり,そのスクリプトファイルを同時に複数実行した場合,同一の解析トレースファイル,または実行トレースファイルにメッセージを出力します。このため,ファイルに排他制御がかかり,実行性能が低下することがありますので注意が必要です。また,Target_Fileで出力するファイル名が固定の場合も同様です。
- Target_Fileで作成したファイルを他のアプリケーションでテキスト出力しないでください。その後のMessageコマンドの出力結果が保証されません。
- MessageコマンドでTarget_Fileを指定して,ユニークなファイル名称を持ったユーザトレースファイルを大量に作成する場合,トレース管理ファイルの増大によって,スクリプトの実行性能に影響を与える場合があります。また,以下の例のようにスクリプト実行が,メモリ不足で異常終了したり,コマンド実行がメモリ不足でエラーになる場合があります。
- スクリプト実行が終了コード「20」で異常終了する。
- Copyコマンドで「メモリ不足が発生しました」となる。
このような場合は,MessageコマンドからTextOpen/TextWrite/TextCloseコマンドによってトレースファイルを作成してください。
例
' スクリプト実行の履歴を"Loging.TXT"に書き込む。
Message ( Target_File ,_BIN_+"Loging.TXT" ,"実行開始" ,30 ,100 )
:
Message ( Target_File ,_BIN_+"Loging.TXT" ,"実行終了" ,30 ,100 )
' スクリプト実行の履歴状況をコンソールに表示する。
Message ( Target_DispOn ,"実行状況" ,"開始しました。")
Message ( Target_DispOn ,"実行状況" ,"終了しました。")
Sleep ( 3000 )
Message ( Target_DispOff ,"実行状況" )
All Rights Reserved. Copyright (C) 2003, 2006, Hitachi, Ltd.