cmn-clib(CommonLibraryForC)
C言語共通ライブラリ
 全て データ構造 ファイル 関数 変数 型定義 列挙型 列挙値 マクロ定義
CmnLogMessage.c ファイル

ログメッセージ定義 共通関数 [詳解]

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cmnclib/Common.h"
#include "cmnclib/CmnLog.h"
#include "cmnclib/CmnString.h"

マクロ定義

#define MSG_BUFSIZ   2048
 
#define PARSE_CHAR   ','
 
#define COMMENT_CHAR   '#'
 

関数

CmnLogMessageCmnLogMessage_Create (const char *msgFile)
 ログメッセージ定義ファイル読み込み [詳解]
 
void CmnLogMessage_Free (CmnLogMessage *list)
 ログメッセージリスト解放処理 [詳解]
 
int CmnLogMessage_Get (CmnLogMessage *list, const char *msg_code, CmnLogMessage *msg)
 ログメッセージ取得 [詳解]
 

詳解

ログメッセージ定義 共通関数

ログメッセージ定義ファイルを扱う共通関数。
ログ出力メッセージの書式は以下。printf書式が使用可能。

<ログメッセージ定義ファイル例>
— message.conf(メッセージログファイル) ------------------—
C001, テストログs
C002, テストd回目s
-------------------------------------------------------------—

著者
H.Kumagai
日付
2004-06-06
Revision
1.2

関数詳解

CmnLogMessage* CmnLogMessage_Create ( const char *  msgFile)

ログメッセージ定義ファイル読み込み

ログメッセージファイルの読み込みを行い、 LogMessage構造体にデータを格納する。

引数
msgFile(I) ログメッセージ定義ファイルへのパス
戻り値
LogMessageへのポインタ読み込み完了
NULLFalse 読み込み失敗(以下のような場合に失敗する)
fileが無効なポインタの場合
メッセージ定義ファイルの文法が不正な場合
著者
H.Kumagai
覚え書き
この関数は、ログ出力共通関数から使用される。外部からの使用は禁止。
void CmnLogMessage_Free ( CmnLogMessage list)

ログメッセージリスト解放処理

ログメッセージリストのメモリ領域を解放する

引数
list(I) 解放するログメッセージリストへのポインタ
著者
H.Kumagai
覚え書き
この関数は、ログ出力共通関数から使用される。外部からの使用は禁止。
int CmnLogMessage_Get ( CmnLogMessage list,
const char *  msg_code,
CmnLogMessage msg 
)

ログメッセージ取得

メッセージコードに対応したメッセージコード文字列とメッセージ文字列を取得する

引数
list(I) ログメッセージリスト
msg_code(I) メッセージコード
msg(O) LogMessage構造体へのポインタを指定する。
メッセージ取得成功時には、msg->codeとmsg->msgに値が格納される
戻り値
True取得成功時
False取得失敗時(該当するメッセージコードが存在しない場合)
著者
H.Kumagai
覚え書き
この関数は、ログ出力共通関数から使用される。外部からの使用は禁止。