32.4.18 traceオブジェクト

スクリプトログまたはユーザ操作履歴に任意の文字列を出力するためのオブジェクトです。

メソッド名	機能
log	スクリプトログに任意の文字列を出力します。
userlog	ユーザ操作履歴に任意の文字列を出力します。

■log

スクリプトログの出力

指定された文字列をスクリプトログファイルへ出力します。

●呼び出し形式

log(message)

●パラメータ

パラメータ	説明	省略時の初期値
message	任意の文字列	空文字列

注意

次の文字はエスケープして使用してください。
\ " '
管理ツールでスクリプトログの出力設定が有効になっている場合のみ、ログの出力が行われます。詳細は「8.2.13 管理情報」の「■ログ」－「スクリプトログ：」を参照してください。

●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合はfalseを返します。

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.trace.log('ScriptLog');   // 任意の文字列の出力

■userlog

ユーザ操作履歴への出力

指定された文字列をユーザ操作履歴へ出力します。

●呼び出し形式

userlog(category, message)

●パラメータ

パラメータ	説明	省略時の初期値
category	操作履歴の付加情報に出力する文字列を指定	空文字
message	操作履歴の履歴に出力する文字列を指定	空文字

注意

messageパラメータに半角文字を指定する場合は、カナ文字用EBCDICコードで表現できる範囲の文字が使用できます。英小文字を指定した場合は、英大文字に変換されます。
次の文字はエスケープして使用してください。
\ " '
管理ツールでユーザ操作履歴の出力設定が有効になっている場合に出力されます。
本メソッドを使用してユーザ操作履歴へ出力した文字列は、ユーザ操作履歴ビューアの操作履歴の出力機能でファイルへ出力できます。
詳細は「16.3.6 操作履歴の出力」を参照してください。

●リターン値

関数の呼び出しが完了すると、実行結果オブジェクトを返します。

●実行結果オブジェクト

プロパティ	設定値	説明
ResultCode	0：正常 -1：ホストと接続されていません上記以外：致命的エラー	関数呼び出し結果が設定されます。
ErrorMessage	エラーメッセージ	エラーの内容を示す文字列が設定されます。正常時はnullが設定されます。

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.session.bind('connect', function (e) {
    if (e.errCode == 0) {
        var ret = dspemu.trace.userlog('接続情報', '接続しました。'); // ユーザ操作履歴への出力
        if (ret.ResultCode != 0) {
            // エラー時の処理
        }
    }
});