Click here to Skip to main content
Click here to Skip to main content

Extended Trace: Trace macros for Win32.

, 23 Apr 2001
Rate this:
Please Sign up or sign in to vote.
Trace macros that provide messages with source code link, run-time callstack information, and function prototype information with parameter values.
<!-- Download Links --> <!-- Article image -->

Sample Image - ExtendedTrace.gif

Overview

Extended Trace is a collection of a lot of useful traces for Win32, such as:

  • TRACE(...) implementation for Win32.
  • Messages with source code links. Just double click on the message in the Output Window, and jump to the source code.
  • Function parameters. Are you wonder what parameters your function was called with? Just call a simple macro, and will trace yor function prototype with the actual parameter values to the Output Window.
  • Call stack information. You can trace the call stack with function prototypes and parameters' values. Just like the Visual Studio Call Stack window, but this is in run-time.

Usage

Add the ExtendedTrace.cpp to your project, and include ExtendedTrace.h to your source file.

Macros

EXTENDEDTRACEINITIALIZE( IniSymbolPath )

Initialize the symbol information. IniSymbolPath is the search path for the symbol files. The built-in path is ".;%_NT_SYMBOL_PATH%;%_NT_ALTERNATE_SYMBOL_PATH%;%SYSTEMROOT%;%SYSTEMROOT%\System32;". IniSymbolPath will be added to the built-in path. IniSymbolPath can be NULL.

EXTENDEDTRACEUNINITIALIZE()

Frees up the symbol information.

SRCLINKTRACECUSTOM( Msg, File, Line)

Write a message(Msg) to the Output Window with a link to File(Line)

SRCLINKTRACE( Msg )

Write a message(Msg) to the Output Window with a link to its source code.

FNPARAMTRACE()

Write the function prototype with parameters to the Output Window. You can call this function anytime in a function.

STACKTRACEMSG( Msg ), STACKTRACE(), THREADSTACKTRACEMSG( hThread, Msg ), THREADSTACKTRACE( hThread )

Dumps the call stack with function prototypes and the parameters' values to the Output Window. The call stack elements dumped with source code links, so you can jump directly to them.

TRACEF(...)

Same as the MFC TRACE(...)

 

Note: If you're using only TRACEF(...) or SRCLINKTRACExxx(...) macros, you don't need EXTENDEDTRACEINITIALIZE(...)/EXTENDEDTRACEUNINITIALIZE.

Example

#include "ExtendedTrace.h"

void g ( LPTSTR )
{
	// Dumps the actual call stack
	STACKTRACE();
}

void f( int, int, int )
{
	// What parameters was this function called with?
	FNPARAMTRACE();
	g( NULL );
}

int main( int, char** )
{
	// Just like the TRACE(...) in MFC
	TRACEF( _T("Application started at %d\n"), clock() );

	// Initializes the symbol files
	EXTENDEDTRACEINITIALIZE( NULL );

	// Trace message with a link to this line in the source code
	SRCLINKTRACE( _T("I'm calling f(...)\n") );

	f( 1, 2, 3);

	// Cleaning up
	EXTENDEDTRACEUNINITIALIZE();

	TRACEF( _T("Application ended at %d\n"), clock() );

	return 0;
}

The output in the Output Window:

Application started at 578
Loaded 'D:\WINNT\system32\dbghelp.dll', no matching symbolic information found.
c:\temp\magictrace\main.cpp(28) : I'm calling f(...)
Function info(thread=0x36C) : void f(int=0x00000001,int=0x00000002,int=0x00000003)
Call stack info(thread=0x36C) : 
     c:\temp\magictrace\main.cpp(12) : void g(char *=0x00000000)
     c:\temp\magictrace\main.cpp(19) : void f(int=0x00000001,int=0x00000002,int=0x00000003)
     c:\temp\magictrace\main.cpp(30) : main(int=0x00000001,TCHAR * *=0x00522C88)
     crtexe.c(338) : mainCRTStartup()
     KERNEL32!0x77E87903 : SetUnhandledExceptionFilter
Application ended at 1171
The thread 0x36C has exited with code 0 (0x0).

Enjoy!

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Zoltan Csizmadia
Web Developer
United States United States
No Biography provided

Comments and Discussions

 
GeneralMissing argument in some error messages PinmemberMenuki6-Mar-09 3:21 
GeneralcallStack.AddrFrame.Offset != 0 Pinmemberxrinlar13-May-07 11:24 
GeneralSometimes, it doesn't work. PinmembermAtrIxdjg8-Nov-06 22:33 
Sometimes, it doesn't work.
report error at "_tcschr( lpszParsed, _T(',') );"
change it like this "_tcschr( (char*)lpszParsed, _T(',') );"

 
Just do it at time, and live like a person on earth.

GeneralWorks for me PinmemberTor2k22-Feb-06 7:11 
Generalincorrect symbols PinsussAnonymous25-Sep-02 8:33 
GeneralCan't Get it to work PinmemberAnonymous5-Apr-02 6:05 
GeneralRe: Can't Get it to work PinsussAnonymous1-Aug-02 4:45 
Generalvc7 PinmemberAnonumus23-Mar-02 10:24 
GeneralRe: vc7 PinmemberAnthony_Yio22-Sep-04 22:01 
GeneralRe: vc7 PinmemberScott Langham17-Dec-04 9:24 
GeneralRe: vc7 PinmemberSanDiegoPhil30-Aug-06 12:36 
GeneralSTACKTRACEMSG PinmemberBobby G. Vinyard8-Mar-02 21:58 
GeneralGreat Work PinmemberAnonymous-554873528542318742328-Dec-01 11:43 
GeneralRe: Great Work PinmemberAnonymous234111111112-Jan-02 23:16 
GeneralWorks only on NT/2000 PinmemberAnonymous25-Apr-01 6:58 
GeneralTRACE, but no more than 512 characters PinmemberAnonymous24-Apr-01 20:35 
GeneralRe: TRACE, but no more than 512 characters Pinmemberlauren24-Apr-01 21:19 
GeneralRe: TRACE, but no more than 512 characters PinmemberMehmet Ozgul25-Apr-01 7:29 
GeneralRe: TRACE, but no more than 512 characters PinmemberZoltan Csizmadia25-Apr-01 7:58 
GeneralRe: TRACE, but no more than 512 characters PinmemberRick York25-Apr-01 19:05 
GeneralRe: TRACE, but no more than 512 characters PinmemberT1000_RUS31-Jul-07 1:56 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.141223.1 | Last Updated 24 Apr 2001
Article Copyright 2001 by Zoltan Csizmadia
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid