9.1.9 msgメッセージの出力

<この項の構成>
(1) 機能
(2) 形式
(3) 引数
(4) 戻り値
(5) 例外

(1) 機能

メッセージを出力します。引数で指定したメッセージIDおよびメッセージを出力します。このメソッドは,メッセージの出力が必要なときに実行してください。

●出力先にイベントログファイルを指定した場合(Windows限定)
引数messageIDの終端文字の指定によって,イベントログの種類が決まります。引数messageIDの終端文字の指定とイベントログの種類の対応を表9-1に示します。

表9-1 引数messageIDの終端文字の指定とイベントログの種類の対応

引数messageIDの終端文字の指定イベントログの種類
-Eエラー
-W警告
-I情報
上記以外

(2) 形式

メッセージIDおよびメッセージを出力する場合は,形式1~形式3の形式で指定してください。メッセージだけを出力する場合は,形式4~形式6の形式で指定してください。

(a) 形式1

void msg(
   String        messageID,
   String        message,
   DbjTraceDef   level,
   int           output
)

(b) 形式2

void msg(
   String        messageID,
   String        message,
   DbjTraceDef   level
)

形式2の場合,トレース情報の出力先はアプリケーショントレースファイルになります。

(c) 形式3

void msg(
   String        messageID,
   String        message
)

形式3の場合,トレース情報の出力先はアプリケーショントレースファイルになります。また,トレースレベルはDbjTraceDef.ERRORになります。

(d) 形式4

void msg(
   String        message,
   DbjTraceDef   level,
   int           output
)

(e) 形式5

void msg(
   String        message,
   DbjTraceDef   level
)

形式5の場合,トレース情報の出力先はアプリケーショントレースファイルになります。

(f) 形式6

void msg(
   String        message
)

形式6の場合,トレース情報の出力先はアプリケーショントレースファイルになります。また,トレースレベルはDbjTraceDef.ERRORになります。

(3) 引数

messageID(入力)
出力するメッセージIDを11バイト以内で指定します。11バイトを超えた場合は,11バイトまでの文字列が設定されます。nullを指定した場合,メッセージIDは設定されません。
message(入力)
出力するメッセージを指定します。
level(入力)
トレースレベルを指定します。次に示すトレースレベルのうち,どれかを指定してください。
  • DbjTraceDef.ERROR
    障害監視レベル
  • DbjTraceDef.MANAGE
    通常運用レベル
  • DbjTraceDef.HINT
    障害調査レベル
  • DbjTraceDef.DEBUG
    デバッグレベル
output(入力)
トレース情報の出力先を指定します。次に示す出力先を指定できます。
  • DbjTraceDef.PROMPT
    コマンドプロンプト(標準出力・標準エラー出力)に出力します。
  • DbjTraceDef.TRACE
    アプリケーショントレースファイルに出力します。
  • DbjTraceDef.ERRORLOG
    アプリケーションエラーログファイルに出力します。
  • DbjTraceDef.SYSTEM
    イベントログファイルまたはsyslogファイルに出力します。
前記以外の出力先を指定した場合,トレース情報は出力されません(実行したメソッドは正常終了します)。
複数の出力先を指定する場合は,OR演算子を用いて定数を連結してください。例えば,DbjTraceDef.TRACEとDbjTraceDef.ERRRORLOGに同時出力する場合は,DbjTraceDef.TRACE | DbjTraceDef.ERRORLOGと指定してください。

(4) 戻り値

なし

(5) 例外

なし