Share via

Exec Class

  • Article

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Implements the Exec task. Use the Exec element in your project file to create and execute this task. For usage and parameter information, see Exec Task.

MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.

Inheritance Hierarchy

System.Object
  Microsoft.Build.Utilities.Task
    Microsoft.Build.Utilities.ToolTask
      Microsoft.Build.Tasks.ToolTaskExtension
        Microsoft.Build.Tasks.Exec

Namespace:  Microsoft.Build.Tasks
Assembly:  Microsoft.Build.Tasks.Core (in Microsoft.Build.Tasks.Core.dll)

Syntax

'Declaration
Public Class Exec _
    Inherits ToolTaskExtension

public class Exec : ToolTaskExtension

public ref class Exec : public ToolTaskExtension

type Exec =  
    class 
        inherit ToolTaskExtension 
    end

public class Exec extends ToolTaskExtension

The Exec type exposes the following members.

Constructors

  Name Description
Public method Exec Infrastructure. Initializes a new instance of the Exec class.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.

Top

Properties

  Name Description
Protected property Bag Infrastructure. Gets the collection of parameters used by the derived task class.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTaskExtension.)
Public property BuildEngine Gets or sets the instance of the IBuildEngine object used by the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property BuildEngine2 Gets the instance of the IBuildEngine2 object used by the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property BuildEngine3 Gets the instance of the IBuildEngine3 object used by the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property BuildEngine4 Gets the instance of the IBuildEngine4 object used by the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property Command Infrastructure. Gets or sets the command to run.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property ConsoleOutput Returns the output as an Item. Whitespace is trimmed. ConsoleOutput is enabled when ConsoleToMSBuild is true. This avoids holding lines in memory if they aren't used. ConsoleOutput is a combination of stdout and stderr.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property ConsoleToMSBuild Enable the standard output to pipe to an item. (StandardOutput).MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property CustomErrorRegularExpression Infrastructure. Gets or sets a regular expression to spot error lines in the tool output.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property CustomWarningRegularExpression Infrastructure. Gets or sets a regular expression to spot warning lines in the tool output.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property EchoOff Indicates that command line echoing is turned off.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected property EnvironmentOverride 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. MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Public property EnvironmentVariables Array 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.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Public property ExitCode Gets the returned exit code of the executable file.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected property HasLoggedErrors Infrastructure. Returns whether this ToolTask has logged any errors.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTaskExtension.)
Protected property HelpKeywordPrefix Gets or sets the prefix used to compose Help keywords from resource names.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property HostObject Gets or sets the host object associated with the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property IgnoreExitCode Infrastructure. Gets or sets a Boolean value that indicates whether the Exec task should ignore the exit code provided by the executed command (true) or should return false if the executed command returns a non-zero exit code (false).MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property IgnoreStandardErrorWarningFormat Infrastructure. Gets or sets a Boolean value that indicates whether to ignore the standard error and warning format and log errors and warnings from the output as regular messages.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property Log Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTaskExtension.)
Public property LogStandardErrorAsError Should ALL messages received on the standard error stream be logged as errors.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Public property Outputs Infrastructure. Gets or sets the output items from the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Protected property ResponseFileEncoding Gets the Encoding of the response file.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected property StandardErrorEncoding Infrastructure. Gets the encoding of the captured task standard error stream.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.StandardErrorEncoding.)
Public property StandardErrorImportance Task Parameter: Importance with which to log text from the standard error stream.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected property StandardErrorImportanceToUse Gets the actual importance at which standard error messages will be logged.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected property StandardErrorLoggingImportance Infrastructure. Gets the importance to log ordinary messages with in the standard error stream.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.StandardErrorLoggingImportance.)
Protected property StandardOutputEncoding Infrastructure. Gets the encoding of the captured task standard output stream.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.StandardOutputEncoding.)
Public property StandardOutputImportance Task Parameter: Importance with which to log text from the standard out stream.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected property StandardOutputImportanceToUse Gets the actual importance at which standard out messages will be logged.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected property StandardOutputLoggingImportance Infrastructure. Gets the importance to log ordinary messages with in the standard out stream.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.StandardOutputLoggingImportance.)
Public property StdErrEncoding Infrastructure. Gets or sets the encoding of the captured task standard error stream that is visible to the project.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property StdOutEncoding Infrastructure. Gets or sets the encoding of the captured task standard output stream that is visible to the project.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Protected property TaskProcessTerminationTimeout A timeout to wait for a task to terminate before killing it. In milliseconds.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected property TaskResources Gets or sets the culture-specific resources associated with the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from Task.)
Public property Timeout Gets or sets the amount of time after which the task executable is terminated.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected property ToolCanceled Used to signal when a tool has been cancelled.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Public property ToolExe Projects may set this to override a task's ToolName. Tasks may override this to prevent that.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected property ToolName Infrastructure. Gets the name of the tool (cmd.exe).MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.ToolName.)
Public property ToolPath Gets or sets the path of the executable file to run.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Public property UseCommandProcessor Gets 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.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Public property WorkingDirectory Infrastructure. Gets or sets the directory in which the command will run.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property YieldDuringToolExecution Indicates if the task will yield the node during tool execution.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)

Top

Methods

  Name Description
Protected method AddCommandLineCommands Infrastructure. Generates command line arguments that the command line tool must run directly from the command line and not from a response file.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTaskExtension.AddCommandLineCommands(CommandLineBuilderExtension).)
Protected method AddResponseFileCommands Infrastructure. Fills the specified CommandLineBuilderExtension with the switches and other information that the command line tool can run from a response file.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTaskExtension.)
Protected method CallHostObjectToExecute Calls the host object to perform the work of the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Public method Cancel Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected method DeleteTempFile Deletes the specified temporary file.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Public method Equals (Inherited from Object.)
Public method Execute Runs the exectuable file with the specified task parameters.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected method ExecuteTool Infrastructure. Executes the cmd.exe tool, waits for its completion, and cleans up the batch file after execution completes.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.ExecuteTool(String, String, String).)
Protected method Finalize (Inherited from Object.)
Protected method GenerateCommandLineCommands Infrastructure. Gets the switches and other information that the command line tool must run directly from the command line and not from a response file.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTaskExtension.)
Protected method GenerateFullPathToTool Infrastructure. Returns the full path to the system tool cmd.exe.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.GenerateFullPathToTool().)
Protected method GenerateResponseFileCommands Infrastructure. Gets the switch used by the command line tool to specify the response file.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTaskExtension.)
Protected method GetBoolParameterWithDefault Infrastructure. Gets the value of the specified Boolean parameter.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTaskExtension.)
Public method GetHashCode (Inherited from Object.)
Protected method GetIntParameterWithDefault Infrastructure. Gets the value of the specified integer parameter.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTaskExtension.)
Protected method GetProcessStartInfo Initializes the information required to spawn the process executing the tool.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected method GetResponseFileSwitch Returns the command line switch used by the executable file to specifiy a response (.rsp) file.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Public method GetType (Inherited from Object.)
Protected method GetWorkingDirectory Infrastructure. Returns the working directory to use for the tool process.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.GetWorkingDirectory().)
Protected method HandleTaskExecutionErrors Infrastructure. Logs error message and handles exit code.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.HandleTaskExecutionErrors().)
Protected method InitializeHostObject Initializes the host object of the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected method LogEventsFromTextOutput Infrastructure. Logs the specified single line of text as an error or warning if the single line matched custom or standard error and warning formats or as a regular message if IgnoreStandardErrorWarningFormat is set to true and no custom format matched.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.LogEventsFromTextOutput(String, MessageImportance).)
Protected method LogPathToTool Infrastructure. Logs the tool name and path.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.LogPathToTool(String, String).)
Protected method LogToolCommand Infrastructure. Logs the batch file command to be executed.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.LogToolCommand(String).)
Protected method MemberwiseClone (Inherited from Object.)
Protected method ResponseFileEscape Overridable method to escape the content of the response file.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Protected method SkipTaskExecution Indicates whether task execution should be skipped.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Inherited from ToolTask.)
Public method ToString (Inherited from Object.)
Protected method ValidateParameters Infrastructure. Validates input parameters and logs errors or warnings, if any. Returns a Boolean value that indicates whether task execution should proceed.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides ToolTask.ValidateParameters().)

Top

Thread Safety

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

See Also

Reference

Microsoft.Build.Tasks Namespace