class HCLog

class to save log

Public Methods

[more] HCLog()
Constructor - initialize internal variable.
[more] ~HCLog()
Destructor - finalize internal variable.
[more]int SetDirectory( const char* szDirectory )
set directory full path for saving log files.
[more]int SetFileName( const char* szFileName )
set file name for saving current log.
[more]int Open( )
open log file.
[more]int Close()
close log file.
[more]int Print( const char* fmt, ... )
save log.
[more]int Print( HCLogLevel iLevel, const char* fmt, ... )
Store suitable log in log level.
[more]int Print( void* pArg, HCLogLevel iLevel, const char* fmt, ... )
Store suitable log in log level with user defined data.
[more]void PrintArg( void* pArg )
print item that can be divided in log.
[more]int GetLogTime( char* szTime, int iSize )
get current time for log
[more]int GetFileName( char* szFileName, int iSize )
get log file name
[more]const char* GetFileName()
return current log file name.
[more]void AddLogLevel( HCLogLevel iLevel )
add log level
[more]void DeleteLogLevel( HCLogLevel iLevel )
remove log level.
[more]void SetLogLevel( int iLevel )
set log level.
[more]int CheckFileName( BOOL fisRotate )
check whether current data is not equal date of log file
[more]void GetLogLevelString( int iLevel, char* szHeader, int iHeaderSize )
When store suitable log in log level, manufacture string to attach in front.
[more]FILE* GetLogFd()
return log file handle


Documentation

class to save log
o HCLog()
Constructor - initialize internal variable.

o ~HCLog()
Destructor - finalize internal variable.

oint 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.

oint SetFileName( const char* szFileName )
set file name for saving current log.

Parameters:
szFileName - log file name
Returns:
if success, return 0. otherwise return -1.

oint Open( )
open log file.

Returns:
if success, return 0. if log directory is not set, return -2. otherwise return -1

oint Close()
close log file.

Returns:
return 0.

oint Print( const char* fmt, ... )
save log.

Parameters:
fmt - [in] log data
Returns:
return 0.

oint 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.

oint 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.

ovoid 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 - Ãâ·ÂÇÑ ÀÎÀÚ

oint 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 À» ¸®ÅÏÇÑ´Ù.

oint GetFileName( char* szFileName, int iSize )
get log file name

Parameters:
szFileName - [out] log file name
iSize - [in] size of szFileName
Returns:
0 À» ¸®ÅÏÇÑ´Ù.

oconst char* GetFileName()
return current log file name.

Returns:
log file name

ovoid AddLogLevel( HCLogLevel iLevel )
add log level

Returns:
nothing

ovoid DeleteLogLevel( HCLogLevel iLevel )
remove log level.

Returns:
nothing.

ovoid SetLogLevel( int iLevel )
set log level.

Parameters:
iLevel - log level.

oint 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.

ovoid 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

oFILE* 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++.