This documentation is archived and is not being maintained.

ToolTask Class

When overridden in a derived form, provides functionality for a task that wraps a command line tool.

Namespace:  Microsoft.Build.Utilities
Assembly:  Microsoft.Build.Utilities.v4.0 (in Microsoft.Build.Utilities.v4.0.dll)

public abstract class ToolTask : Task, 
	ICancelableTask, ITask

The ToolTask type exposes the following members.

Protected methodToolTask()Initializes a new instance of the ToolTask class.
Protected methodToolTask(ResourceManager)Initializes a new instance of the ToolTask class with the specified ResourceManager.
Protected methodToolTask(ResourceManager, String)Initializes a new instance of the ToolTask class with the specified ResourceManager and Help keyword prefix.

Public propertyBuildEngineGets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
Public propertyBuildEngine2Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
Public propertyBuildEngine3Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
Public propertyEchoOffIndicates that command line echoing is turned off.
Protected propertyEnvironmentOverride Obsolete. Gets a set of environment variable name-value pairs. Designed to be overridden in a custom task class (derived from ToolTask) to return a set of new or altered environment variables to create the execution context of the associated tool.
Public propertyEnvironmentVariablesArray of equals-separated pairs of environment variables that should be passed to the spawned executable, in addition to (or selectively overriding) the regular environment block.
Public propertyExitCodeGets the returned exit code of the executable file.
Protected propertyHasLoggedErrorsWhether this ToolTask has logged any errors
Protected propertyHelpKeywordPrefixGets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
Public propertyHostObjectGets or sets the host object associated with the task. (Inherited from Task.)
Public propertyLogGets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
Public propertyLogStandardErrorAsErrorShould ALL messages received on the standard error stream be logged as errors.
Protected propertyResponseFileEncodingGets the Encoding of the response file.
Protected propertyStandardErrorEncodingGets the Encoding of the standard error stream of the task.
Public propertyStandardErrorImportanceTask Parameter: Importance with which to log text from the standard error stream.
Protected propertyStandardErrorImportanceToUseGets the actual importance at which standard error messages will be logged.
Protected propertyStandardErrorLoggingImportanceGets the MessageImportance with which to log errors.
Protected propertyStandardOutputEncodingGets the Encoding of the standard output stream of the task.
Public propertyStandardOutputImportanceTask Parameter: Importance with which to log text from the standard out stream.
Protected propertyStandardOutputImportanceToUseGets the actual importance at which standard out messages will be logged.
Protected propertyStandardOutputLoggingImportanceGets the MessageImportance with which to log errors.
Protected propertyTaskProcessTerminationTimeoutA timeout to wait for a task to terminate before killing it. In milliseconds.
Protected propertyTaskResourcesGets or sets the culture-specific resources associated with the task. (Inherited from Task.)
Public propertyTimeoutGets or sets the amount of time after which the task executable is terminated.
Protected propertyToolCanceledUsed to signal when a tool has been cancelled.
Public propertyToolExeProjects may set this to override a task's ToolName. Tasks may override this to prevent that.
Protected propertyToolNameGets the name of the executable file to run.
Public propertyToolPathGets or sets the path of the executable file to run.
Public propertyUseCommandProcessorGets or sets a switch that specifies whether the tool task will create a batch file for the command-line and execute that using the command-processor, rather than executing the command directly.
Public propertyYieldDuringToolExecutionIndicates if the task will yield the node during tool execution.

Protected methodCallHostObjectToExecuteCalls the host object to perform the work of the task.
Public methodCancelCancels the process executing the task by asking it to close nicely, then after a short period, forcing termination.
Protected methodDeleteTempFileDeletes the specified temporary file.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodExecuteRuns the exectuable file with the specified task parameters. (Overrides Task.Execute().)
Protected methodExecuteToolCreates a temporoary response (.rsp) file and runs the executable file.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGenerateCommandLineCommandsReturns a string value containing the command line arguments to pass directly to the executable file.
Protected methodGenerateFullPathToToolReturns the fully qualified path to the executable file.
Protected methodGenerateResponseFileCommandsReturns a string value containing the command line arguments to add to the response (.rsp) file before running the executable file.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetProcessStartInfoInitializes the information required to spawn the process executing the tool.
Protected methodGetResponseFileSwitchReturns the command line switch used by the executable file to specifiy a response (.rsp) file.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodGetWorkingDirectoryReturns the directory in which to run the executable file.
Protected methodHandleTaskExecutionErrorsHandles execution errors raised by the executable file.
Protected methodInitializeHostObjectInitializes the host object of the task.
Protected methodLogEventsFromTextOutputParses a single line of text to identify any errors or warnings in canonical format.
Protected methodLogPathToToolLogs the tool name and path to all registered loggers.
Protected methodLogToolCommandLogs the starting point of the run to all registered loggers.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSkipTaskExecutionIndicates whether task execution should be skipped.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodValidateParametersIndicates whether all task paratmeters are valid.

This abstract class provides default implementations for the methods and properties of a task that wraps a command line tool.

The following example creates a ToolTask that runs Ilasm.exe (MSIL Assembler). The CommandLineBuilder, ToolLocationHelper, and TaskLoggingHelper classes are used to generate the information needed to run the task.

using System;
using System.Collections;
using System.Text;
using Microsoft.Build.Utilities;
using Microsoft.Build.Framework;

namespace MSBuildTasks
    /// <summary>
    /// A very simple and incomplete ToolTask to wrap the ILASM.EXE tool.
    /// </summary>
    public class ILAsm : ToolTask
        #region Member Data
        /// <summary>
        /// Gets the collection of parameters used by the task class.
        /// </summary>
        /// <value>Parameter bag.</value>
        protected internal Hashtable Bag
                return bag;

        private Hashtable bag = new Hashtable();

        #region ILAsm Task Properties
        /// <summary>
        /// The Source file that is to be compled (.il)
        /// </summary>
        public ITaskItem Source
            get { return Bag["Source"] as ITaskItem; }
            set { Bag["Source"] = value; }
        /// <summary>
        /// Either EXE or DLL indicating the assembly type to be generated
        /// </summary>
        public string TargetType
            get { return Bag["TargetType"] as string; }
            set { Bag["TargetType"] = value; }

        #region ToolTask Members
        protected override string ToolName
            get { return "ILAsm.exe"; }

        /// <summary>
        /// Use ToolLocationHelper to find ILASM.EXE in the Framework directory
        /// </summary>
        /// <returns></returns>
        protected override string GenerateFullPathToTool()
            // Ask ToolLocationHelper to find ILASM.EXE - it will look in the latest framework directory available
            return ToolLocationHelper.GetPathToDotNetFrameworkFile(ToolName, TargetDotNetFrameworkVersion.VersionLatest);

        #region ILAsm Task Members
        /// <summary>
        /// Construct the command line from the task properties by using the CommandLineBuilder
        /// </summary>
        /// <returns></returns>
        protected override string GenerateCommandLineCommands()
            CommandLineBuilder builder = new CommandLineBuilder();

            // We don't need the tool's logo information shown

            string targetType = Bag["TargetType"] as string;
            // Be explicit with our switches
            if (targetType != null)
                if (String.Compare(targetType, "DLL", true) == 0)
                else if (String.Compare(targetType, "EXE", true) == 0)
                    Log.LogWarning("Invalid TargetType (valid values are DLL and EXE) specified: {0}", targetType);

            // Add the filename that we want the tool to process
            builder.AppendFileNameIfNotNull(Bag["Source"] as ITaskItem);

            // Log a High importance message stating the file that we are assembling
            Log.LogMessage(MessageImportance.High, "Assembling {0}", Bag["Source"]);

            // We have all of our switches added, return the commandline as a string
            return builder.ToString();

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.