class to save log
Public Methods
-
HCLog()
- Constructor - initialize internal variable.
-
~HCLog()
- Destructor - finalize internal variable.
-
int SetDirectory( const char* szDirectory )
- set directory full path for saving log files.
-
int SetFileName( const char* szFileName )
- set file name for saving current log.
-
int Open( )
- open log file.
-
int Close()
- close log file.
-
int Print( const char* fmt, ... )
- save log.
-
int Print( HCLogLevel iLevel, const char* fmt, ... )
- Store suitable log in log level.
-
int Print( void* pArg, HCLogLevel iLevel, const char* fmt, ... )
- Store suitable log in log level with user defined data.
-
void PrintArg( void* pArg )
- print item that can be divided in log.
-
int GetLogTime( char* szTime, int iSize )
- get current time for log
-
int GetFileName( char* szFileName, int iSize )
- get log file name
-
const char* GetFileName()
- return current log file name.
-
void AddLogLevel( HCLogLevel iLevel )
- add log level
-
void DeleteLogLevel( HCLogLevel iLevel )
- remove log level.
-
void SetLogLevel( int iLevel )
- set log level.
-
int CheckFileName( BOOL fisRotate )
- check whether current data is not equal date of log file
-
void GetLogLevelString( int iLevel, char* szHeader, int iHeaderSize )
- When store suitable log in log level, manufacture string to attach in front.
-
FILE* GetLogFd()
- return log file handle
Documentation
class to save log
HCLog()
- Constructor - initialize internal variable.
~HCLog()
- Destructor - finalize internal variable.
int SetDirectory( const char* szDirectory )
- set directory full path for saving log files.
- Parameters:
- szDirectory - directory full path
- Returns:
- if success, return 0.
otherwise return -1.
int SetFileName( const char* szFileName )
- set file name for saving current log.
- Parameters:
- szFileName - log file name
- Returns:
- if success, return 0.
otherwise return -1.
int Open( )
- open log file.
- Returns:
- if success, return 0.
if log directory is not set, return -2.
otherwise return -1
int Close()
- close log file.
- Returns:
- return 0.
int Print( const char* fmt, ... )
- save log.
- Parameters:
- fmt - [in] log data
- Returns:
- return 0.
int Print( HCLogLevel iLevel, const char* fmt, ... )
- Store suitable log in log level.
- Parameters:
- iLevel - [in] log level
fmt - [in] log data
- Returns:
- if success, return 0.
In case do not agree with log level that is established present, return 1.
int Print( void* pArg, HCLogLevel iLevel, const char* fmt, ... )
- Store suitable log in log level with user defined data.
- Parameters:
- iLevel - [in] log level
pArg - [in] user defined variable - additional data for log
fmt - [in] log data
- Returns:
- if success, return 0.
otherwise return -1.
void PrintArg( void* pArg )
- print item that can be divided in log.
- that divide each other among several log in case need this inherit and use .
When use being inherited, must print data to m_psttFd file descriptor if exist
otherwise print data to stderr.
- Parameters:
- pArg - Ãâ·ÂÇÑ ÀÎÀÚ
int GetLogTime( char* szTime, int iSize )
- get current time for log
sizeo of szTime variable must be at least 9 byte.
- Parameters:
- szTime - [out] current time for log
iSize - [in] size of szTime
- Returns:
- 0 À» ¸®ÅÏÇÑ´Ù.
int GetFileName( char* szFileName, int iSize )
- get log file name
- Parameters:
- szFileName - [out] log file name
iSize - [in] size of szFileName
- Returns:
- 0 À» ¸®ÅÏÇÑ´Ù.
const char* GetFileName()
- return current log file name.
- Returns:
- log file name
void AddLogLevel( HCLogLevel iLevel )
- add log level
- Returns:
- nothing
void DeleteLogLevel( HCLogLevel iLevel )
- remove log level.
- Returns:
- nothing.
void SetLogLevel( int iLevel )
- set log level.
- Parameters:
- iLevel - log level.
int CheckFileName( BOOL fisRotate )
- check whether current data is not equal date of log file
- Parameters:
- fisRotate - if current date is not equal date of log file,
rotate log file? if TRUE, rotate log file.
- Returns:
- if current date is equal date of log file, return 0.
otherwise return -1.
void GetLogLevelString( int iLevel, char* szHeader, int iHeaderSize )
- When store suitable log in log level, manufacture string to attach in front.
- Parameters:
- iLevel - log level
szHeader - string to attach in front of log
iHeaderSize - size of szHeader
- Returns:
- nothing
FILE* GetLogFd()
- return log file handle
- Returns:
- log file handle
- This class has no child classes.
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.