CFileLogger_interface.h File Reference

Interface for CFileLogger wrapper. More...

Go to the source code of this file.

Functions
CFileLogger	CFileLogger_Create (const idrs_string strFilePath, idrs_exception *pargException)
	Creates an object with the given characteristics.
void	CFileLogger_OnReceivedMessage (CFileLogger argCFileLogger, enum SeverityLevel const evMessageSeverityLevel, const idrs_string strMessage, idrs_exception *pargException)
	OnReceivedMessage is a method which will be called on reception of meaningful events to provide information about the status and the type of the event. Function will provide information only to events that occur with a severity level equal or higher than the logging severity level provided by user. This function appends the timestamp and the message severity level overhead to the received string and then stores it to a file on disk.
void	CFileLogger_Destroy (CFileLogger argCFileLogger, idrs_exception *pargException)
	Destroys a CFileLogger handle.

Detailed Description

Interface for CFileLogger wrapper.

Function Documentation

CFileLogger_Create()

CFileLogger CFileLogger_Create	(	const idrs_string	strFilePath,
		idrs_exception *	pargException
	)

Creates an object with the given characteristics.

Parameters

strFilePath	The path of the file that will save the logger messages
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

Instances created by this method can also be provided to ILogger methods

CFileLogger_Destroy()

void CFileLogger_Destroy	(	CFileLogger	argCFileLogger,
		idrs_exception *	pargException
	)

Destroys a CFileLogger handle.

Parameters

argCFileLogger	CFileLogger handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CFileLogger_OnReceivedMessage()

void CFileLogger_OnReceivedMessage	(	CFileLogger	argCFileLogger,
		enum SeverityLevel const	evMessageSeverityLevel,
		const idrs_string	strMessage,
		idrs_exception *	pargException
	)

OnReceivedMessage is a method which will be called on reception of meaningful events to provide information about the status and the type of the event. Function will provide information only to events that occur with a severity level equal or higher than the logging severity level provided by user. This function appends the timestamp and the message severity level overhead to the received string and then stores it to a file on disk.

Parameters

argCFileLogger	CFileLogger handle
evMessageSeverityLevel	The severity level of the message that will be logged
strMessage	A message providing information about the occurred event
pargException	Pointer to exception structure that will be filled if an exception occurs