前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFBLogger
ILogger インターフェースのラッパークラスです。
#include <SFBLogger.h.hpp>
class SFBLogger : public SFBBase;
SFMTYPEDEFWRAPPER(SFBLogger)

継承図

SFBLogger クラスの継承図

バージョン

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0
×

参照

BREW API ILogger

メンバ

パブリック関数
SFCError GetParam( AEELogParamType type , VoidConstPtr param )
SFBLogger インスタンスの構成を取得します。
SFCError GetParam( AEELogParamType type , SFXBufferConstRef param )
SFBLogger インスタンスの構成を取得します。
static
SFBLoggerSmp
NewInstance( AEECLSID clsid = AEECLSID_LOGGER_WIN , SFCErrorPtr exception = null )
SFBLogger インスタンスを生成します。
SFCError Printf( AEELogBucketType bucket , ACharConstPtr fileName , UInt16 lineNum , ACharConstPtr format , ... )
書式付き ASCII テキストメッセージを送信します。
SFCError PutItem( AEELogBucketType bucket , AEELogItemType type , UInt16 size , UInt08Ptr item )
ユーザー定義の優先順位付きバイナリ メッセージを送信します。
SFCError PutMsg( AEELogBucketType bucket , ACharConstPtr fileName , UInt16 lineNum , ACharConstPtr msg , UInt08 numArgs , UInt32 args[] )
形式が制限されサイズが固定された出力ログ メッセージを使用して高速で ロギングするために、定義済みのバイナリ メッセージを送信します。
SFCError PutRecord( AEELogBucketType bucket , AEELogRecord* record )
バイナリ メッセージを送信します。
SFCError SetParam( AEELogParamType type , UInt32 param , VoidConstPtr paramPtr )
SFBLogger インスタンスのパフォーマンスと動作を設定します。サポートされるパラメータは、実装に依存します。
SFCError SetParam( AEELogParamType type , UInt32 param , SFXBufferConstRef paramPtr )
SFBLogger インスタンスのパフォーマンスと動作を設定します。サポートされるパラメータは、実装に依存します。
プロテクト関数
static
SFBBaseSmp
FactoryByCreate( AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを生成します。
static
SFBBaseSmp
FactoryByQuery( SFBQuerySmpConstRef query , AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBLogger::GetParam
SFBLogger インスタンスの構成を取得します。
[ public ]
SFCError GetParam(
    AEELogParamType type   // 取得するパラメータ
    VoidConstPtr param     // 設定パラメータを格納するポインタ
);
[ public ]
SFCError GetParam(
    AEELogParamType type      // 取得するパラメータ
    SFXBufferConstRef param   // 設定パラメータを格納するポインタ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • 取得するパラメータがサポートされていないとき: SFERR_UNSUPPORTED
  • 失敗したとき: SFERR_FAILED

解説

サポートされるパラメータは、実装に依存します。

詳細情報 : AEELoggerTypes.h

参照

BREW API ILOGGER_GetParam


SFBLogger::NewInstance
SFBLogger インスタンスを生成します。
[ public, static ]
SFBLoggerSmp NewInstance(
    AEECLSID clsid = AEECLSID_LOGGER_WIN   // Class ID
    SFCErrorPtr exception = null           // エラー値
);

解説

ILogger を実装したインスタンスの ClassID として、 以下のいずれかを指定できます。

AEECLSID_LOGGER_FILE : ログをファイルに記録する
AEECLSID_LOGGER_ WIN : ログをシミュレータの出力ウィンドウに送る

SFBLogger::Printf
書式付き ASCII テキストメッセージを送信します。
[ public ]
SFCError Printf(
    AEELogBucketType bucket   // 項目を配置するバケット
    ACharConstPtr fileName    // この関数をコールしているファイルの名前
    UInt16 lineNum            // ファイル内の関数がコールされた行の番号
    ACharConstPtr format      // printf の書式文字列に類似した ASCII テキスト文字列
    ...                       // 書式文字列引数
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • fileName へのポインタが不正なとき: SFERR_INVALID_PARAM
  • メモリ不足のとき: SFERR_NO_MEMORY
  • ログ項目がフィルタされたとき: SFERR_UNSUPPORTED
  • 失敗したとき: SFERR_FAILED
  • ログファイルに、このパケット用のスペースが足りないとき: EFSFULL
  • 出力ログファイルが閉じているとき: EFILENOEXISTS

参照

BREW API ILOGGER_Printf


SFBLogger::PutItem
ユーザー定義の優先順位付きバイナリ メッセージを送信します。
[ public ]
SFCError PutItem(
    AEELogBucketType bucket   // 項目を配置するバケット
    AEELogItemType type       // ユーザー定義の項目タイプ
    UInt16 size               // タイプのサイズ( バイト数 )
    UInt08Ptr item            // タイプのインスタンスへのポインタ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • メモリ不足のとき: SFERR_NO_MEMORY
  • ログ項目がフィルタされたとき: SFERR_UNSUPPORTED
  • 失敗したとき: SFERR_FAILED
  • ログファイルに、このパケット用のスペースが足りないとき: EFSFULL
  • 出力ログファイルが閉じているとき: EFILENOEXISTS

参照

BREW API ILOGGER_PutItem


SFBLogger::PutMsg
形式が制限されサイズが固定された出力ログ メッセージを使用して高速で ロギングするために、定義済みのバイナリ メッセージを送信します。
[ public ]
SFCError PutMsg(
    AEELogBucketType bucket   // 項目を配置するバケット
    ACharConstPtr fileName    // この関数をコールしているファイルの名前( null 終結の ASCII )
    UInt16 lineNum            // ファイル内の関数がコールされた行の番号
    ACharConstPtr msg         // テキストメッセージ( null 終結の ASCII )
    UInt08 numArgs            // args 配列の長さ
    UInt32 args[]             // uint32 の引数を含む配列
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • メモリ不足のとき: SFERR_NO_MEMORY
  • ログ項目がフィルタされたとき: SFERR_UNSUPPORTED
  • 失敗したとき: SFERR_FAILED
  • ログファイルに、このパケット用のスペースが足りないとき: EFSFULL
  • 出力ログファイルが閉じているとき: EFILENOEXISTS

解説

出力バイナリメッセージのデータ型は AEELogBinMsgType 構造体で、AEELoggerTypes.h で定義されています。

参照

BREW API ILOGGER_PutMsg


SFBLogger::PutRecord
バイナリ メッセージを送信します。
[ public ]
SFCError PutRecord(
    AEELogBucketType bucket   // 項目を配置するバケット
    AEELogRecord* record      // AEELogRecord 構造体へのポインタ
);

参照

BREW API ILOGGER_PutRecord


SFBLogger::SetParam
SFBLogger インスタンスのパフォーマンスと動作を設定します。サポートされるパラメータは、実装に依存します。
[ public ]
SFCError SetParam(
    AEELogParamType type    // 変更するパラメータ
    UInt32 param            // 新しい設定パラメータ
    VoidConstPtr paramPtr   // 新しい設定パラメータへのポインタ
);
[ public ]
SFCError SetParam(
    AEELogParamType type         // 変更するパラメータ
    UInt32 param                 // 新しい設定パラメータ
    SFXBufferConstRef paramPtr   // 新しい設定パラメータへのポインタ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • 変更するパラメータがサポートされていないとき: SFERR_UNSUPPORTED
  • 失敗したとき: SFERR_FAILED
  • ファイル ロギングの出力ログファイルが閉じているとき: EFILENOEXISTS
  • ファイル ロギングの出力ログファイルが開いているとき: EFILENOEXISTS
  • シリアル ロギングが開いている最中のとき: AEESIO_EINPROGRESS
  • シリアル ロギングの要求したポート名がサポートされていないとき: AEESIO_ENOSUCHPORT
  • シリアル ロギングのポートが他のエンティティによって使用中のとき: AEESIO_EINUSE
  • シリアル ロギング中のその他のエラーのとき: OEM 特定のヘッダーファイルを参照

参照

BREW API ILOGGER_SetParam