tfCLogger.h File Reference

#include "tf_port_c.h"

Include dependency graph for tfCLogger.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	tfLogLevelHandle
struct	tfLogEventHandle

Functions
HRESULT	tfLogLevel_init (struct tfLogLevelHandle *handle)
	Initialize an instance.
HRESULT	tfLogEventHandle_init (struct tfLogEventHandle *handle)
	Initialize an instance.
HRESULT	tfLogger_setLevel (unsigned int level)
	Set the Level objectsets the logging level to one a value from Logger::Level.
HRESULT	tfLogger_getLevel (unsigned int *level)
	Get the Level objectget the current logging level.
HRESULT	tfLogger_enableFileLogging (const char *fileName, unsigned int level)
	turns on file logging to the given file as the given level.
HRESULT	tfLogger_disableFileLogging ()
	turns off file logging, but has no effect on console logging.
HRESULT	tfLogger_getFileName (char **str, unsigned int *numChars)
	Get the File Name objectget the name of the currently used log file.
HRESULT	tfLogger_log (unsigned int level, const char *msg)
	logs a message to the log.

Function Documentation

tfLogEventHandle_init()

HRESULT tfLogEventHandle_init

(

struct tfLogEventHandle *

handle

)

Initialize an instance.

Parameters

handle

handle to populate

Returns

S_OK on success

tfLogger_disableFileLogging()

HRESULT tfLogger_disableFileLogging

(

)

turns off file logging, but has no effect on console logging.

Returns

S_OK on success

tfLogger_enableFileLogging()

HRESULT tfLogger_enableFileLogging	(	const char *	fileName,
		unsigned int	level )

turns on file logging to the given file as the given level.

Parameters

fileName	path to log file
level	logging level

Returns

S_OK on success

tfLogger_getFileName()

HRESULT tfLogger_getFileName	(	char **	str,
		unsigned int *	numChars )

Get the File Name objectget the name of the currently used log file.

Parameters

str	string array of file name
numChars	number of characters in string

Returns

S_OK on success

tfLogger_getLevel()

HRESULT tfLogger_getLevel

(

unsigned int *

level

)

Get the Level objectget the current logging level.

Parameters

level

logging level

Returns

S_OK on success

tfLogger_log()

HRESULT tfLogger_log	(	unsigned int	level,
		const char *	msg )

logs a message to the log.

Parameters

level	logging level
msg	log message

Returns

S_OK on success

tfLogger_setLevel()

HRESULT tfLogger_setLevel

(

unsigned int

level

)

Set the Level objectsets the logging level to one a value from Logger::Level.

Parameters

level

logging level

Returns

S_OK on success

tfLogLevel_init()

HRESULT tfLogLevel_init

(

struct tfLogLevelHandle *

handle

)

Initialize an instance.

Parameters

handle

handle to populate

Returns

S_OK on success