DbgTrace Class Reference

#include <dbgtrace.h>

List of all members.

Public Member Functions

 DbgTrace (void)
virtual ~DbgTrace (void)
void Initialize (__in UINT32 modules, __in UINT32 levelTrace, __in UINT32 levelMsg)
void FuncPrefix (__in const char *pszMod, __in const char *pszFunc, __in bool fEnter, __in bool fNewLine)
void MsgPrefix (__in const char *pszMod, __in const char *pszFunc, __in UINT32 levelMsg)

Public Attributes

UINT32 m_modulesTrace
UINT32 m_levelTrace
UINT32 m_levelMsg

Detailed Description

This class implements the debug tracing object. It provides two facilities. One allows the functions to trace the enter and exit conditions of the call by dumping the calling parameters of function entry and the return value of function exit. The other one allows the function to print out different level of messages such as fatal message, error message, warning message, info message and verbose message etc.


Constructor & Destructor Documentation

DbgTrace::DbgTrace ( void   )  [inline]

Constructor for the DbgTrace object.

virtual DbgTrace::~DbgTrace ( void   )  [inline, virtual]

Destructor for the DbgTrace object.


Member Function Documentation

void DbgTrace::FuncPrefix ( __in const char *  pszMod,
__in const char *  pszFunc,
__in bool  fEnter,
__in bool  fNewLine 
) [inline]

This method generates the function trace prefix string. The prefix contains the indentation, the module name and the function name.

Parameters:
pszMod Specifies the name of the module.
pszFunc Specifies the name of the function.
fEnter Specifies whether we are entering or exiting the function.
fNewLine Specifies whether we will print a new line.
void DbgTrace::Initialize ( __in UINT32  modules,
__in UINT32  levelTrace,
__in UINT32  levelMsg 
) [inline]

This function initializes the tracing module with the specified module IDs and trace levels.

Parameters:
modules Bit mask specifying which modules to enable tracing with. Each module is assigned a bit ID in the bit mask.
levelTrace Specifies the function trace level at or below which function tracing is enabled.
levelMsg Specifies the message trace level at or below which message tracing is enabled.
void DbgTrace::MsgPrefix ( __in const char *  pszMod,
__in const char *  pszFunc,
__in UINT32  levelMsg 
) [inline]

This method generates the message trace prefix string. The prefix contains the module and function names as well as message level info in which the message is printed.

Parameters:
pszMod Specifies the name of the module.
pszFunc Specifies the name of the function.
levelMsg Specifies message level.

Member Data Documentation


The documentation for this class was generated from the following file:

Generated by  doxygen 1.6.2