code_app/base/HGLog.h

42 lines
1.1 KiB
C

#ifndef __HGLOG_H__
#define __HGLOG_H__
#include "HGDef.h"
#include "HGBaseErr.h"
HG_DECLARE_HANDLE(HGLog);
/* 开启日志
* 参数:
* 1) fileName: in, 文件名
* 2) log: out, 日志句柄
* 说明:
*/
HGEXPORT HGResult HGAPI HGBase_OpenLog(const HGChar* fileName, HGLog* log);
/* 关闭日志
* 参数:
* 1) log: in, 日志句柄
* 说明:
*/
HGEXPORT HGResult HGAPI HGBase_CloseLog(HGLog log);
/* 获取日志文件大小
* 参数:
* 1) log: in, 日志句柄
* 2) size: out, 日志文件大小
* 说明:
* 1) 每次写入日志信息后,可以用该函数检查日志文件的大小,当日志文件足够大时,可以关闭该日志句柄,在新的日志文件上重新打开
*/
HGEXPORT HGResult HGAPI HGBase_GetLogFileSize(HGLog log, HGLonglong* size);
/* 写日志信息
* 参数:
* 1) log: in, 日志句柄
* 2) info: in, 信息, 一次一行, info无需加换行符
* 说明:
* 1) 该函数不是线程安全的, 在不同进程或不同线程调用的时候, 需要加锁
*/
HGEXPORT HGResult HGAPI HGBase_WriteLog(HGLog log, const HGChar* info);
#endif /* __HGLOG_H__ */