Build solution from command line or with contexmenu item with Microsoft VS.NET

• Download VsBuilderHelper Console Application - 4.57 Kb

Introduction

This little article can give you a hint on how you can build your solution files quickly without running 6 Visual Studio applications that enlarge your scratch file till your computer is slow like my grandma.

First of all run %ProgramFiles%\Microsoft Visual Studio .NET\Common7\Tools\vsvars32.bat, if devenv.exe (Visual Studio IDE) could not be found from command line.

Command line switches of devenv.exe

To see this list, type devenv /? on command prompt

• /build - build the specified solution configuration
• /project - specifies the project to build instead of solution, must specify /build to use /project
• /projectconfig - specifies project configuration to build, must specify /project to use /projectconfig
• /out - write build output to specified file
• /rebuild - like /build, but forces a clean first
• /clean - clean up build outputs
• /deploy - build the specified solution configuration and then deploy it
• /run - run the specified solution configuration
• /runexit - run the specified solution configuration and then terminate
• /command - executes the specified internal command line after startup
• /mditabs - use tabbed documents interface
• /mdi - use MDI interface
• /fn - use specified font name
• /fs - use specified font size
• /LCID - use specified language ID
• /noVSIP - disables VSIP developers license key for VSIP testing
• /safemode - only default environment and services load for stability
• /resetskippkgs - allow VSPackages once flagged for loading failures to load again

Console Application BuilderHelper

This little console application is able to check the return value from devenv.exe and we can display the build log if there went something wrong.

The basic method looks like this:

System.Diagnostics.ProcessStartInfo is filled with needed information.

public int Build(string solutionFile, string solutionConfig)
{
    // get temp logfile path

    string logFileName = System.IO.Path.GetTempFileName();
    // populate process environment

    System.Diagnostics.ProcessStartInfo psi = 
        new System.Diagnostics.ProcessStartInfo();
    psi.FileName =@"devenv.exe";
    psi.ErrorDialog = true;
    psi.Arguments =  "\"" +solutionFile +"\"" +  
         @" /rebuild "+ solutionConfig 
         + " /out " + logFileName;

Now we start the process and wait for exit.

// start process

System.Diagnostics.Process p = System.Diagnostics.Process.Start(psi);
// instruct process to wait for exit

p.WaitForExit();
// get return code

int exitCode = p.ExitCode;
// free process resources

p.Close();

If devenv.exe did not return zero, we display the build log to the user.

// if there was a build error, display build log to console

if (exitCode != 0)
{
    System.IO.TextReader reader =  System.IO.File.OpenText(logFileName);
    errorLog = reader.ReadToEnd();
    reader.Close();
    //

    System.Console.WriteLine(errorLog);
    System.Console.WriteLine("Hit enter to abort...");
    System.Console.Read();
}
// delete temp logfile

System.IO.File.Delete(logFileName);

Last but not least, we return the code.

// return process exit code

    return exitCode;
}

Build Batch

• Create a new text file in the directory where your solution file is located, be sure to change extension from .txt to .bat. If you can't see the extension in your Explorer, change Explorer settings in Tools/Options/View to show extensions.
• Do not double click the file to edit, use the context menu item Edit or drag it to a text editor like Notepad.
• Add line VsBuilderHelper.exe solutionfilename.sln solution configuration, where solution configuration is usually debug or release..
• Save the file and close Notepad.
• Double click now your *.bat file. If everything went right, the console closes after while, otherwise the build log is displayed.

Extend context menu with build item

• Open Explorer, open Tools/Options.

• Change to tab "File Types".
• Search for sln extension, type sln to find quickly.
• Click on Extend button (every Windows version has another dialog for this).
• Click New in the Property Dialog.
• Choose a name for this item like Build Debug
• In the path field, type: "VsBuilderHelper.exe" "%1" solution configuration, where solution configuration is usually debug or release. If your VsBuilderHelper.exe is not in the path environment, please specify the full path to VsBuilderHelper.exe.
• Close the dialogs and go to any solution, right click solution file and choose your menu item. If everything went right, the console closes after a while, otherwise the build log is displayed.

Have phun with it...

Revision History

16.12.2002

• Fixed bug with project path that contains spaces.
• Build log stored in temporary file.
• Console application returns process exit code to caller.

14.12.2002

• Added console application BuilderHelper.
• Removed direct devenv call samples.