FLImaging 6.5.8.1
Log.h
1#pragma once
2
11#include "FLBase.h"
12
14namespace FLImaging
15{
17 namespace Base
18 {
19 class CInternalLog;
27 typedef void(__stdcall* CLogCallbackProcType)(const wchar_t*, CFLBase*);
28
35 class FL_EXPORT CLog : public CFLBase
36 {
37 protected:
46
47 public:
55 virtual ~CLog();
56
68 static const CResult Initialize();
69
79 static bool IsInitialized();
80
92 static const CResult Terminate();
93
109 static const CResult __stdcall Write(const char* pszFormat, ...);
110
126 static const CResult __stdcall Write(const wchar_t* pWcsFormat, ...);
127
128
146 static const CResult __stdcall WriteWithColor(uint32_t u32Color, const char* pszFormat, ...);
147
165 static const CResult __stdcall WriteWithColor(uint32_t u32Color, const wchar_t* pWcsFormat, ...);
166
167
185 static const CResult __stdcall WriteByCategory(const char* pszCategory, const char* pszFormat, ...);
186
204 static const CResult __stdcall WriteByCategory(const wchar_t* pWcsCategory, const wchar_t* pWcsFormat, ...);
205
206
226 static const CResult __stdcall WriteWithColorByCategory(const char* pszCategory, uint32_t u32Color, const char* pszFormat, ...);
227
247 static const CResult __stdcall WriteWithColorByCategory(const wchar_t* pWcsCategory, uint32_t u32Color, const wchar_t* pWcsFormat, ...);
248
249
261 static const CResult SetLogBufferSize(int64_t i64BufferSize = 65536);
262
263
273 static int64_t GetLogBufferSize();
274
275
285 static void SetLogPath(const wchar_t* pWcsLogPath = nullptr);
286
287
297 static const wchar_t* GetLogPathName();
298
308 static const wchar_t* GetLogFileName();
309
319 static const wchar_t* GetLogFileNameWithPath();
320
336 static void SetLogCallback(CLogCallbackProcType pCallback, CFLBase* pReceiver);
337
348
361
362 DeclareGetClassType();
363
364 private:
365 static CLog* GetInstance();
366
367 CInternalLog* m_pInternal;
368 };
369 }
370}
371
Top-level base class of FLImaging.
Definition FLBase.h:36
Log class.
Definition Log.h:36
static const wchar_t * GetLogFileName()
Get log save file name.
static CFLBase * GetReceiver()
Return log callback receive object pointer.
static const CResult __stdcall WriteWithColor(uint32_t u32Color, const wchar_t *pWcsFormat,...)
Write log with specified color.
static bool IsInitialized()
Get initialization status.
static const wchar_t * GetLogFileNameWithPath()
Get log save file name including path.
static const CResult __stdcall Write(const wchar_t *pWcsFormat,...)
Write log.
static const CResult __stdcall WriteWithColor(uint32_t u32Color, const char *pszFormat,...)
Write log with specified color.
static const CResult __stdcall Write(const char *pszFormat,...)
Write log.
static int64_t GetLogBufferSize()
Get size of buffer to create when writing a log.
static const CResult Initialize()
Initialize.
static CLogCallbackProcType GetLogCallback()
Set log callback.
CLog()
Constructor.
static const CResult __stdcall WriteByCategory(const wchar_t *pWcsCategory, const wchar_t *pWcsFormat,...)
Write log by specified categories.
static const CResult __stdcall WriteWithColorByCategory(const char *pszCategory, uint32_t u32Color, const char *pszFormat,...)
Write log with specified color and category.
static const CResult Terminate()
Terminate the log system. After explicitly calling the function, the log recording function will no l...
static const wchar_t * GetLogPathName()
Get log save path.
static void SetLogCallback(CLogCallbackProcType pCallback, CFLBase *pReceiver)
Set log callback.
static void SetLogPath(const wchar_t *pWcsLogPath=nullptr)
Specify log storage path.
static const CResult SetLogBufferSize(int64_t i64BufferSize=65536)
Set the size of the buffer to create when writing a log.
static const CResult __stdcall WriteWithColorByCategory(const wchar_t *pWcsCategory, uint32_t u32Color, const wchar_t *pWcsFormat,...)
Write log with specified color and category.
static const CResult __stdcall WriteByCategory(const char *pszCategory, const char *pszFormat,...)
Write log by specified categories.
FLImaging module execution result object.
Definition ResultsDef.h:1514
void(__stdcall * CLogCallbackProcType)(const wchar_t *, CFLBase *)
Log Callback Procedure Type.
Definition Log.h:27