Click here to Skip to main content
11,641,659 members (61,978 online)
Click here to Skip to main content

Redirecting an arbitrary Console's Input/Output

, 27 Nov 2003 304.9K 11.4K 115
Rate this:
Please Sign up or sign in to vote.
Redirecting an arbitrary console's input/output in a simple, graceful way

Sample Image - redir.gif

Introduction

To redirect the input/output of a console application is interesting and useful. You can display the child's output in a window (just like Visual Studio's output window), or search some keywords in the output string to determine if the child process has completed its work successfully. An old, 'ugly' DOS program could become an useful component of your fancy Win32 GUI program.

My idea is to develop a simple, easy to use redirector class which can redirect an arbitrary console, and won't be affected by the behavior of the child process.

Background

The technique of redirecting the input/output of a console process is very sample: The CreateProcess() API through the STARTUPINFO structure enables us to redirect the standard handles of a child console based process. So we can set these handles to either a pipe handle, file handle, or any handle that we can read and write. The detail of this technique has been described clearly in MSDN: HOWTO: Spawn Console Processes with Redirected Standard Handles.

However, MSDN's sample code has two big problem. First, it assumes the child process will send output at first, then wait for input, then flush the output buffer and exit. If the child process doesn't behave like that, the parent process will be hung up. The reason of this is the ReadFile() function remains blocked untill the child process sends some output, or exits.

Second, It has problem to redirect a 16-bit console (including console based MS-DOS applications.) On Windows 9x, ReadFile remains blocked even after the child process has terminated; On Windows NT/XP, ReadFile always returns FALSE with error code set to ERROR_BROKEN_PIPE if the child process is a DOS application.

Solving the block problem of ReadFile

To prevent the parent process from being blocked by ReadFile, we can simply pass a file handle as stdout to the child process, then monitor this file. A more simple way is to call PeekNamedPipe() function before calling ReadFile(). The PeekNamedPipe function checks information about data in the pipe, then returns immediately. If there's no data available in the pipe, don't call ReadFile.

By calling PeekNamedPipe before ReadFile, we also solve the block problem of redirecting a 16-bit console on Windows 9x.

The class CRedirector creates pipes and launchs the child process at first. then creates a listener thread to monitor the output of the child process. This is the main loop of the listener thread:

    for (;;)
    {
        // redirect stdout till there's no more data.
        nRet = pRedir->RedirectStdout();
        if (nRet <= 0)
            break;

        // check if the child process has terminated.
        DWORD dwRc = ::WaitForMultipleObjects(
            2, aHandles, FALSE, pRedir->m_dwWaitTime);
        if (WAIT_OBJECT_0 == dwRc)      // the child process ended
        {
            ...
            break;
        }
        if (WAIT_OBJECT_0+1 == dwRc)    // m_hEvtStop was signalled, exit
        {
            ...
            break;
        }
    }

This is the main loop of the RedirectStdout() function:

    for (;;)
    {
        DWORD dwAvail = 0;
        if (!::PeekNamedPipe(m_hStdoutRead, NULL, 0, NULL,
            &dwAvail, NULL))    // error, the child process might ended
            break;

        if (!dwAvail)           // no data available, return
            return 1;

        char szOutput[256];
        DWORD dwRead = 0;
        if (!::ReadFile(m_hStdoutRead, szOutput, min(255, dwAvail),
            &dwRead, NULL) || !dwRead)  
                 // error, the child process might ended
            break;

        szOutput[dwRead] = 0;
        WriteStdOut(szOutput);          // display the output
    }

WriteStdOut is a virtual member function. It does nothing in CRedirector class. However it can be overrided to achieve our specific target, like I did in the demo project:

    int nSize = m_pWnd->GetWindowTextLength();  
             // m_pWnd points to a multiline Edit control
    m_pWnd->SetSel(nSize, nSize);
    m_pWnd->ReplaceSel(pszOutput);      
           // add the message to the end of Edit control

To redirect DOS console based applications on NT/2000/XP

MSDN's solution is to launch an intermediate Win32 Console application as a stub process between the Win32 parent and the 16-bit console based child. In fact the DOS prompt program (on NT/XP it's cmd.exe, on 9x it's command.com) is a natural stub process we just need. We can test this in RedirDemo.exe:

  1. Input 'cmd.exe' in Command Editbox, then press Run button.
  2. Input the name of the 16-bit console based application (dosapp.exe for example) in the Input Editbox, then press Input button. Now we can see the output of the 16-bit consol.
  3. Input 'exit' in the Input Editbox, then press Input button to terminate cmd.exe

Apparently this is not a good solution because it's too complicated. A more effective way is to use a batch file as the stub. Edit stub.bat file like this:

%1 %2 %3 %4 %5 %6 %7 %8 %9

Then run a command like 'stub.bat dosapp.exe', then the 16-bit DOS console application runs OK.

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

nickadams
Web Developer
Canada Canada
Nick Adams is one of my favorite figures in Hemingway's stories. I use it because Jeff Lee has been occupied on Codeproject.

You may also be interested in...

Comments and Discussions

 
QuestionHow do I use the Redirection Demo tool? Pin
Mike Dorl26-Feb-15 7:46
memberMike Dorl26-Feb-15 7:46 
QuestionWhich License? Pin
tngraf00126-Nov-14 2:55
membertngraf00126-Nov-14 2:55 
QuestionCan this be done in QT? Pin
Shaunak De13-Aug-13 19:43
memberShaunak De13-Aug-13 19:43 
BugUnicode Character Set Pin
prashu10030-Aug-12 4:04
memberprashu10030-Aug-12 4:04 
QuestionAbout running a FTP console app, just like telnet Pin
LionKun11-Dec-11 2:15
memberLionKun11-Dec-11 2:15 
GeneralMy vote of 4 Pin
Normand M. Blais3-Oct-10 5:03
memberNormand M. Blais3-Oct-10 5:03 
QuestionIt is not working on windows 2008 R2 Pin
manas.thombare8-Jul-10 6:25
membermanas.thombare8-Jul-10 6:25 
GeneralBe aware of casting LPCTSTR to LPTSTR Pin
EmoBemo30-Nov-09 6:14
memberEmoBemo30-Nov-09 6:14 
Great article. Every time I see something so simple to use I feel inspired. There is a little problem though.

When you execute something like

CRedirector redir;
...
redir.Open(_T("some.exe"));

it crashes. I think it is from the casting in
if (!::CreateProcess(
			NULL,
			(LPTSTR)pszCmdLine,
			NULL, NULL,
			TRUE,
			CREATE_NEW_CONSOLE,
			NULL, NULL,
			&si,
			&pi))
			return FALSE;
pszCmdLine is const and CreateProcess wants non-const. If you pass some CString on CRedirector::Open then you may not get the access-violation behaviour because the buffer of the CString may be longer than the text in it. But when it comes to static const TCHAR[] CreateProcess may want to write where it should not. Maybe you should copy it in a non-const
TCHAR[] before calling CreateProccess.

cheers,
Emo
GeneralThanks! Pin
Kyudos17-Sep-09 17:24
memberKyudos17-Sep-09 17:24 
GeneralSuperb execution... but have a simple question... Pin
Hurty9-Jul-09 22:52
memberHurty9-Jul-09 22:52 
GeneralWriteStdError shouldn't be called with _T Pin
sashoalm17-Apr-09 22:55
membersashoalm17-Apr-09 22:55 
Generaltelnet.exe Pin
suiram4024-Feb-09 18:01
membersuiram4024-Feb-09 18:01 
GeneralCaptureConsole.DLL - A universal Console Output Redirector for all Compilers Pin
Elmue3-Feb-09 6:02
memberElmue3-Feb-09 6:02 
GeneralStrange problem Pin
Mr. S27-Nov-08 0:30
memberMr. S27-Nov-08 0:30 
GeneralTelnet.exe Pin
tptshepo11-Nov-08 19:55
membertptshepo11-Nov-08 19:55 
Questionhow to send a CTRL+C??? Pin
Motorcure16-Sep-08 23:08
memberMotorcure16-Sep-08 23:08 
AnswerRe: how to send a CTRL+C??? Pin
varandas7918-Mar-11 6:02
membervarandas7918-Mar-11 6:02 
QuestionHow to you know when the process has ended? Pin
mimosa21-Apr-08 13:28
membermimosa21-Apr-08 13:28 
GeneralAbout Redirecting Debug IO Pin
yonken6-Apr-08 0:26
memberyonken6-Apr-08 0:26 
QuestionHow to change the bounds of bytes to output data at a time. Pin
chol92112-Nov-07 22:19
memberchol92112-Nov-07 22:19 
Question.net port Pin
neolode16-Sep-07 6:38
memberneolode16-Sep-07 6:38 
GeneralOverlapped structure Pin
charian09203-May-07 17:28
membercharian09203-May-07 17:28 
QuestionAlso works for DLLs? Pin
roel hermans3-May-07 1:28
memberroel hermans3-May-07 1:28 
QuestionWhat about advanced key events? Pin
torch#27-Mar-07 22:49
membertorch#27-Mar-07 22:49 
QuestionAdapting To Windows Powershell? Pin
Robert T.25-Oct-06 9:33
memberRobert T.25-Oct-06 9:33 
AnswerRe: Adapting To Windows Powershell? Pin
Anne Jan Beeks31-Jan-07 3:22
memberAnne Jan Beeks31-Jan-07 3:22 
GeneralRe: Adapting To Windows Powershell? Pin
Robert T.26-Mar-07 6:07
memberRobert T.26-Mar-07 6:07 
GeneralRe: Adapting To Windows Powershell? Pin
Anne Jan Beeks26-Mar-07 6:32
memberAnne Jan Beeks26-Mar-07 6:32 
QuestionHow to avoid using fflush(); ? Pin
q.sa1-Oct-06 8:10
memberq.sa1-Oct-06 8:10 
QuestionAsking for help, Unexpected behavior with my client app Pin
gemex9-Aug-06 22:18
membergemex9-Aug-06 22:18 
GeneralCalling CRedirector::Close() in output thread problem ! Pin
Reivax7214-Jun-06 0:26
memberReivax7214-Jun-06 0:26 
GeneralPlease Help me VB Pin
WolverineSoft2-May-06 13:15
memberWolverineSoft2-May-06 13:15 
General::SetConsoleCtrlHandler(CRedirector::CtrlHandler, TRUE); Pin
Tcpip200525-Apr-06 22:06
memberTcpip200525-Apr-06 22:06 
GeneralRe: ::SetConsoleCtrlHandler(CRedirector::CtrlHandler, TRUE); Pin
Motorcure17-Sep-08 15:33
memberMotorcure17-Sep-08 15:33 
QuestionHow can i flush the clild's data? Pin
Galterian20-Feb-06 1:34
memberGalterian20-Feb-06 1:34 
QuestionWhy the telnet doesn't work with it? Pin
iamtony3-May-05 16:27
memberiamtony3-May-05 16:27 
AnswerRe: Why the telnet doesn't work with it? Pin
nickadams4-May-05 4:01
membernickadams4-May-05 4:01 
GeneralRe: Why the telnet doesn't work with it? Pin
osirisgothra6-Sep-07 7:07
memberosirisgothra6-Sep-07 7:07 
GeneralRedirecting Cygwin Console Pin
sars14-Mar-05 14:35
membersars14-Mar-05 14:35 
Generalprintf problem is not solved.... Pin
Monk_10-Dec-04 1:18
memberMonk_10-Dec-04 1:18 
GeneralRe: printf problem is not solved.... Pin
Anonymous10-Dec-04 11:31
sussAnonymous10-Dec-04 11:31 
GeneralNot all stdout or stderr is printed Pin
jarrusin19-Nov-04 8:16
memberjarrusin19-Nov-04 8:16 
Generalredirecting output of console application consisting of several threads Pin
Luft Waffe12-Nov-04 3:13
memberLuft Waffe12-Nov-04 3:13 
GeneralRe: redirecting output of console application consisting of several threads Pin
nickadams17-Nov-04 16:28
membernickadams17-Nov-04 16:28 
QuestionHow can i stop the running Process ? Pin
Sick@work28-Jul-04 2:02
memberSick@work28-Jul-04 2:02 
AnswerRe: How can i stop the running Process ? Pin
nickadams29-Jul-04 4:10
membernickadams29-Jul-04 4:10 
GeneralRe: How can i stop the running Process ? Pin
Sick@work4-Aug-04 0:12
memberSick@work4-Aug-04 0:12 
GeneralRe: How can i stop the running Process ? Pin
nickadams5-Aug-04 3:16
membernickadams5-Aug-04 3:16 
GeneralRe: How can i stop the running Process ? Pin
Michael A. Rusakov10-Jul-07 3:30
memberMichael A. Rusakov10-Jul-07 3:30 
GeneralRe: How can i stop the running Process ? Pin
vikijain8-Nov-04 4:29
membervikijain8-Nov-04 4:29 

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.150731.1 | Last Updated 28 Nov 2003
Article Copyright 2003 by nickadams
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid