Click here to Skip to main content
6,306,412 members and growing! (19,958 online)
Email Password   helpLost your password?
Development Lifecycle » Debug Tips » General     Beginner

Creating a console for your MFC app's debug output

By matthias s.

How to send debugging output to a console in a MFC application
VC6, MFC, Dev, QA
Posted:17 Jun 2000
Views:98,285
Bookmarked:32 times
Announcements
Loading...
 
Search    
Advanced Search
printPrint   Broken Article?Report       add Share
  Discuss Discuss   Recommend Article Email
19 votes for this article.
Popularity: 5.05 Rating: 3.95 out of 5

1

2

3
2 votes, 40.0%
4
3 votes, 60.0%
5
  • Download demo project - 12 Kb
  • Sample Image - MFCConsole.gif

    It's simply a matter of three function calls to print a message to a console in your MFC application. There are several reasons why you might want to send your debugging output to a console. Mine were, that 1st, I didn't have an IDE on the PC where I tested the debug-builds of my app and 2nd, the Mainframe was not always visible, which made matters worse.

    A last word of warning beforehand: Closing the console window will exit your application! Let's go:

    Creating the console

    To create a console window you need to call AllocConsole(). This function does not take any parameters and returns a BOOL, indicating whether the console has been created or not. You should create the console sometime in the beginning of your code. In the sample I've put the code into the CWinApp::OnInitInstance() override. Like this:
    BOOL CSmplConsoleApp::InitInstance()
    {
    	// details omitted
    
    
    	// allocate a console
    
    #ifdef _DEBUG
    	if (!AllocConsole())
    		AfxMessageBox("Failed to create the console!", MB_ICONEXCLAMATION);
    #endif
    	return TRUE;
    	
    	//	and then create the frame
    
    	pFrame->LoadFrame(IDR_MAINFRAME,
    		WS_OVERLAPPEDWINDOW | FWS_ADDTOTITLE, NULL,
    		NULL);
    
    	// The one and only window has been initialized, so show and update it.
    
    	pFrame->ShowWindow(SW_SHOW);
    	pFrame->UpdateWindow();
    }
    

    It is important that you create your console before you create the main window. If you don't, the console will still be created, but your debugging messages send with _cprintf() will not arrive in your console. I couldn't figure out why it is like this, only that it is like this. If somebody has an explanation, please let me know.

    Writing to the console

    Send your output to the console via _cprintf(), which is prototyped like this:
    int _cprintf( const char *format [, argument] ... );
    

    The format has the same form and function as the format parameter for the printf() function. Please look up the details in your documentation. And don't forget to #include <conio.h> wherever you use _cprintf().

    The CChildView::OnPaint() override in the demo application looks like this:

    void CChildView::OnPaint() 
    {
    	CPaintDC dc(this); // device context for painting
    
    	
    	// TODO: Add your message handler code here
    
    #ifdef _DEBUG
    	static int nCallCounter = 0;
    	nCallCounter++;
    	_cprintf("Window painted now %i time(s)\n", nCallCounter);
    #endif
    	// Do not call CWnd::OnPaint() for painting messages
    
    }
    

    Getting rid of the console

    Somewhere near the end of your program you should call FreeConsole() to free the console <g>. Again, this function does not take any parameters and returns a BOOL indicating success or failure. Here is what the CWinApp::ExitInstance() override in the demo project looks like:

    int CSmplConsoleApp::ExitInstance() 
    {
    	//	deallocate console
    
    #ifdef _DEBUG
    	if (!FreeConsole())
    		AfxMessageBox("Could not free the console!");
    #endif
    	return CWinApp::ExitInstance();
    }
    

    Hope that helps!

    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

    About the Author

    matthias s.


    Member
    I'm into photography a lot. And yes, I do code as well. Mostly C# these days.
    Occupation: Web Developer
    Company: Photocase.com
    Location: Germany Germany

    Other popular Debug Tips articles:

    Article Top
    You must Sign In to use this message board.
    FAQ FAQ 
     
    Noise Tolerance  Layout  Per page   
     Msgs 1 to 17 of 17 (Total in Forum: 17) (Refresh)FirstPrevNext
    Generalproblems with close button in the console Pinmembersankariyo0:30 22 Apr '08  
    GeneralJust another possiblity: redirect TRACE PinsussFranz Renesnicek3:43 20 Sep '00  
    GeneralClosing console with X button PinsussLouis Daoust10:39 2 Aug '00  
    GeneralRe: Closing console with X button PinsussMatthias Steinbart20:51 2 Aug '00  
    GeneralRe: Closing console with X button PinsussPaolo Messina11:07 13 Aug '00  
    GeneralRe: Closing console with X button PinsussLouis Daoust6:00 16 Aug '00  
    GeneralRe: Closing console with X button PinsussPaolo Messina10:05 18 Aug '00  
    GeneralRe: Closing console with X button PinsussLouis Daoust10:41 18 Aug '00  
    GeneralRe: Closing console with X button PinsussPaolo Messina7:26 19 Aug '00  
    GeneralWhat about DebugView PinsussPaul E. Bible10:43 20 Jun '00  
    GeneralRe: What about DebugView PinsussMatthias Steinbart22:18 28 Jun '00  
    GeneralRe: What about DebugView PinmemberDjibril8:56 18 Dec '00  
    GeneralRe: What about DebugView PinmemberAnonymous7:03 29 Mar '01  
    GeneralEven Easier Way PinsussMichael A. Cornelius4:43 19 Jun '00  
    GeneralNice one! PinsussMatthias Steinbart22:21 28 Jun '00  
    GeneralVery nice ! PinsussHostalet0:26 26 Aug '02  
    GeneralRe: Even Easier Way Pinmemberskst11:41 8 Jul '03  

    General General    News News    Question Question    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

    PermaLink | Privacy | Terms of Use
    Last Updated: 17 Jun 2000
    Editor: Tim Deveaux
    Copyright 2000 by matthias s.
    Everything else Copyright © CodeProject, 1999-2009
    Web16 | Advertise on the Code Project