Sometimes in the middle of a .NET application (either C# or VB) you want to run an executable and collect the output. This post presents a simple function (RunExecutable) that makes it easy to do this.
This blog is inactive.New blog: EricWhite.com/blogBlog TOCI write a lot of documents that contain code. Many of those documents also contain the expected output from the code. When you have a very large document with many code snippets, it is useful to automate the testing of those snippets. It gives me a warm and fuzzy feeling to verify that all of the code in my document(s) is validated just before I publish. I’m going to use RunExecutable in an upcoming post that shows how to extract C# code from an Open XML document, compile it, run it, and validate that the output matches the output in the document. This is particularly useful to, say, authors writing programming books.
But this code is useful in its own right. Here is the code to run an executable, and collect the output:
publicstaticRunResults RunExecutable(string executablePath, string arguments,
RunResults runResults = newRunResults
Output = newStringBuilder(),
Error = newStringBuilder(),
RunException = null
using (Process proc = newProcess())
proc.StartInfo.FileName = executablePath;
proc.StartInfo.Arguments = arguments;
proc.StartInfo.WorkingDirectory = workingDirectory;
proc.StartInfo.UseShellExecute = false;
proc.StartInfo.RedirectStandardOutput = true;
proc.StartInfo.RedirectStandardError = true;
(o, e) => runResults.Output.Append(e.Data).Append(Environment.NewLine);
(o, e) => runResults.Error.Append(e.Data).Append(Environment.NewLine);
runResults.ExitCode = proc.ExitCode;
thrownewArgumentException("Invalid executable path.", "executablePath");
catch (Exception e)
runResults.RunException = e;
RunResults runResults = RunExecutable("./ConsoleApplication2.exe", "aaa bbb ccc", ".");
if (runResults.RunException != null)
After input from Jochan (see below), I've updated the code as shown. Thanks, Jochan!
Code is attached.
Your code is wrong! It will *not* work, if your process will output (much) data to "StandardError" and "StandardOutput"!
See docu of "RedirectStandardOutput/Error"... please use a thread to read the error/output...
I understand that this will not work if producing very much output. Remember, this is in the context of validating snippets of code that are in a document, where you would not expect output to be massive. Sorry, I'm not an expert in all cases of use of these. Do you feel that a separate thread is necessary even when validating snippets of code in a document?
Thanks for your input. I certainly don't want to show code that demonstrates incorrect use. If you can clarify further, it would be helpful.
Code is updated per Jochan's comments. Thanks.
You can use lambda expressions to write an event handler, even for classes that predate C# 3.0 and the
Very nice! I've used a similar approach to do this asynchronously from another thread, writing the output lines to a TextBox as they come in:
Oops, that link didn't work. Let's try this again...
Many types of documents contain code, including API documentation, tutorials, specifications, technical
does not work. Here is an example with less code, more clarity and less time to waste: