iDRS™ SDK 16
Loading...
Searching...
No Matches
CConsoleLogger_interface.h File Reference

Interface for CConsoleLogger wrapper. More...

Go to the source code of this file.

Functions

CConsoleLogger CConsoleLogger_Create (idrs_exception *pargException)
 Creates an object.
 
void CConsoleLogger_OnReceivedMessage (CConsoleLogger argCConsoleLogger, 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 output string and then prints it to console.
 
void CConsoleLogger_Destroy (CConsoleLogger argCConsoleLogger, idrs_exception *pargException)
 Destroys a CConsoleLogger handle.
 

Detailed Description

Interface for CConsoleLogger wrapper.

Function Documentation

◆ CConsoleLogger_Create()

CConsoleLogger CConsoleLogger_Create ( idrs_exception *  pargException)

Creates an object.

Parameters
pargExceptionPointer to exception structure that will be filled if an exception occurs
Remarks
Instances created by this method can also be provided to ILogger methods

◆ CConsoleLogger_Destroy()

void CConsoleLogger_Destroy ( CConsoleLogger  argCConsoleLogger,
idrs_exception *  pargException 
)

Destroys a CConsoleLogger handle.

Parameters
argCConsoleLoggerCConsoleLogger handle to destroy
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CConsoleLogger_OnReceivedMessage()

void CConsoleLogger_OnReceivedMessage ( CConsoleLogger  argCConsoleLogger,
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 output string and then prints it to console.

Parameters
argCConsoleLoggerCConsoleLogger handle
evMessageSeverityLevelThe severity level of the message that will be logged
strMessageA message providing more information about the occurred event
pargExceptionPointer to exception structure that will be filled if an exception occurs