Logging

This category contains functions and types for controlling logging output. More...

Data Structures

Type	Name
struct	fplLogSettings Stores log settings. More...
struct	fplLogWriter Stores log writer settings. More...
struct	fplLogWriterConsole Log writer flags enumeration operators. More...
struct	fplLogWriterCustom Stores custom logging properties. More...

Typedefs

Type	Name
typedef void	fpl_log_func_callback(const char *funcName, const int lineNumber, const fplLogLevel level, const char *message) A function definition for a callback for printing a log message.

Enumerations

Type	Name
enum	fplLogLevel { fplLogLevel_All , fplLogLevel_Critical , fplLogLevel_Error , fplLogLevel_Warning , fplLogLevel_Info , fplLogLevel_Verbose , fplLogLevel_Debug , fplLogLevel_Trace , fplLogLevel_First , fplLogLevel_Last } An enumeration of log levels. More...
enum	fplLogWriterFlags { fplLogWriterFlags_None , fplLogWriterFlags_StandardConsole , fplLogWriterFlags_ErrorConsole , fplLogWriterFlags_DebugOut , fplLogWriterFlags_Custom } An enumeration of log writer flags. More...

Functions

Type	Name
fpl_common_api const fplLogSettings *	fplGetLogSettings (void) Gets the current log settings.
fpl_common_api fplLogLevel	fplGetMaxLogLevel (void) Gets the current maximum allowed log level.
fpl_common_api void	fplSetLogSettings (const fplLogSettings *params) Overwrites the current log settings.
fpl_common_api void	fplSetMaxLogLevel (const fplLogLevel maxLevel) Changes the current maximum log level to the given value.

Detailed Description

This category contains functions and types for controlling logging output.

Typedef Documentation

fpl_log_func_callback

typedef void fpl_log_func_callback(const char *funcName, const int lineNumber, const fplLogLevel level, const char *message)

A function definition for a callback for printing a log message.

Parameters

Direction	Parameter	Description
[in]	funcName	The function name.
[in]	lineNumber	The line number.
[in]	level	The log level fplLogLevel.
[in]	message	The log message string.

See also: Example: Log all errors to a custom logging function

Definition at line 7010 of file final_platform_layer.h.

Enumeration Type Documentation

fplLogLevel

enum fplLogLevel

An enumeration of log levels.

Name	Description
fplLogLevel_All	All.
fplLogLevel_Critical	Critical.
fplLogLevel_Error	Error.
fplLogLevel_Warning	Warning.
fplLogLevel_Info	Info.
fplLogLevel_Verbose	Verbose.
fplLogLevel_Debug	Debug.
fplLogLevel_Trace	Trace.
fplLogLevel_First	First fplLogLevel.
fplLogLevel_Last	Last fplLogLevel.

Definition at line 6976 of file final_platform_layer.h.

fplLogWriterFlags

enum fplLogWriterFlags

An enumeration of log writer flags.

Name	Description
fplLogWriterFlags_None	No appender flags.
fplLogWriterFlags_StandardConsole	Standard-Console output.
fplLogWriterFlags_ErrorConsole	Error-Console output.
fplLogWriterFlags_DebugOut	Debug output.
fplLogWriterFlags_Custom	Custom output.

Definition at line 7016 of file final_platform_layer.h.

Function Documentation

fplGetLogSettings()

fpl_common_api const fplLogSettings * fplGetLogSettings ( void )

Gets the current log settings.

Returns: Returns a reference to the current log settings structure

fplLogSettings .

Note: This function can be called regardless of the initialization state!

See also: Logging

fplGetMaxLogLevel()

fpl_common_api fplLogLevel fplGetMaxLogLevel ( void )

Gets the current maximum allowed log level.

Returns: Returns the current maximum log level

fplLogLevel .

Note: This function can be called regardless of the initialization state!

See also: Logging

fplSetLogSettings()

fpl_common_api void fplSetLogSettings ( const fplLogSettings * params)

Overwrites the current log settings.

Parameters

Direction	Parameter	Description
[in]	params	Reference to the source log settings structure fplLogSettings.

Note: This function can be called regardless of the initialization state!

See also: Logging

fplSetMaxLogLevel()

fpl_common_api void fplSetMaxLogLevel ( const fplLogLevel maxLevel)

Changes the current maximum log level to the given value.

Parameters

Direction	Parameter	Description
[in]	maxLevel	The new maximum log level fplLogLevel.

Note: This function can be called regardless of the initialization state!

See also: Logging