rtl/logfile.h File Reference

#include "sal/config.h"
#include "sal/saldllapi.h"
#include "sal/types.h"

Go to the source code of this file.

Defines

#define RTL_LOGFILE_TRACE(string)   ((void)0)
#define RTL_LOGFILE_TRACE1(frmt, arg1)   ((void)0)
#define RTL_LOGFILE_TRACE2(frmt, arg1, arg2)   ((void)0)
#define RTL_LOGFILE_TRACE3(frmt, arg1, arg2, arg3)   ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR(project, author, string)   ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR1(project, author, frmt, arg1)   ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR2(project, author, frmt, arg1, arg2)   ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR3(project, author, frmt, arg1, arg2, arg3)   ((void)0)

Functions

SAL_DLLPUBLIC void rtl_logfile_trace (const sal_Char *pszFormat,...)
 This function allows to log arbitrary messages even in a product-environment.
SAL_DLLPUBLIC void rtl_logfile_longTrace (char const *format,...)
 Like rtl_logfile_trace, but prefixing every log entry with the current time and thread ID.
SAL_DLLPUBLIC sal_Bool rtl_logfile_hasLogFile (void)
 Return if a log file is written.

Define Documentation

#define RTL_LOGFILE_TRACE ( string   )     ((void)0)
#define RTL_LOGFILE_TRACE1 ( frmt,
arg1   )     ((void)0)
#define RTL_LOGFILE_TRACE2 ( frmt,
arg1,
arg2   )     ((void)0)
#define RTL_LOGFILE_TRACE3 ( frmt,
arg1,
arg2,
arg3   )     ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR ( project,
author,
string   )     ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR1 ( project,
author,
frmt,
arg1   )     ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR2 ( project,
author,
frmt,
arg1,
arg2   )     ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR3 ( project,
author,
frmt,
arg1,
arg2,
arg3   )     ((void)0)

Function Documentation

SAL_DLLPUBLIC sal_Bool rtl_logfile_hasLogFile ( void   ) 

Return if a log file is written.

Returns:
true if a log file is written
Since:
UDK 3.2.11
SAL_DLLPUBLIC void rtl_logfile_longTrace ( char const *  format,
  ... 
)

Like rtl_logfile_trace, but prefixing every log entry with the current time and thread ID.

Parameters:
format a format string with fprintf-like syntax
... an arbitrary number of arguments for fprintf, matching the given format string
Since:
UDK 3.2.0
SAL_DLLPUBLIC void rtl_logfile_trace ( const sal_Char pszFormat,
  ... 
)

This function allows to log arbitrary messages even in a product-environment.

The logfile is created on first access and closed, when the sal-library gets unloaded. The file is line buffered. A log file is not created if no log messages are written.

The first time, rtl_logfile_trace is called, it checks for the bootstrap variable RTL_LOGFILE. If the variable is not empty, it creates a file with the name _.log, where is the process id of the running process.

Parameters:
pszFormat A format string with fprintf-syntax
... An arbitrary number of arguments for fprintf, matching the format string.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 2 Dec 2013 by  doxygen 1.6.1