Exec Class
.NET Framework 4.5
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
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.
System.Object
Microsoft.Build.Utilities.Task
Microsoft.Build.Utilities.ToolTask
Microsoft.Build.Tasks.ToolTaskExtension
Microsoft.Build.Tasks.Exec
Microsoft.Build.Utilities.Task
Microsoft.Build.Utilities.ToolTask
Microsoft.Build.Tasks.ToolTaskExtension
Microsoft.Build.Tasks.Exec
Namespace: Microsoft.Build.Tasks
Assembly: Microsoft.Build.Tasks.v4.0 (in Microsoft.Build.Tasks.v4.0.dll)
The Exec type exposes the following members.
| Name | Description | |
|---|---|---|
|
Bag | Infrastructure. Gets the collection of parameters used by the derived task class. (Inherited from ToolTaskExtension.) |
|
BuildEngine | Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.) |
|
|
BuildEngine2 | Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.) |
|
|
BuildEngine3 | Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.) |
|
|
BuildEngine4 | (Inherited from Task.) |
|
|
Command | Infrastructure. Gets or sets the command to run. |
|
|
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. |
|
|
ConsoleToMSBuild | Enable the standard output to pipe to an item. (StandardOutput). |
|
|
CustomErrorRegularExpression | Infrastructure. Gets or sets a regular expression to spot error lines in the tool output. |
|
|
CustomWarningRegularExpression | Infrastructure. Gets or sets a regular expression to spot warning lines in the tool output. |
|
|
EchoOff | Indicates that command line echoing is turned off. (Inherited from ToolTask.) |
|
|
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. (Inherited from ToolTask.) |
|
|
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. (Inherited from ToolTask.) |
|
|
ExitCode | Gets the returned exit code of the executable file. (Inherited from ToolTask.) |
|
|
HasLoggedErrors | Infrastructure. Returns whether this ToolTask has logged any errors. (Inherited from ToolTaskExtension.) |
|
|
HelpKeywordPrefix | Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.) |
|
|
HostObject | Gets or sets the host object associated with the task. (Inherited from Task.) |
|
|
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). |
|
|
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. |
|
|
Log | Gets an instance of a TaskLoggingHelperExtension class containing task logging methods. (Inherited from ToolTaskExtension.) |
|
|
LogStandardErrorAsError | Should ALL messages received on the standard error stream be logged as errors. (Inherited from ToolTask.) |
|
|
Outputs | Infrastructure. Gets or sets the output items from the task. |
|
|
ResponseFileEncoding | Gets the Encoding of the response file. (Inherited from ToolTask.) |
|
|
StandardErrorEncoding | Infrastructure. Gets the encoding of the captured task standard error stream. (Overrides ToolTask.StandardErrorEncoding.) |
|
|
StandardErrorImportance | Task Parameter: Importance with which to log text from the standard error stream. (Inherited from ToolTask.) |
|
|
StandardErrorImportanceToUse | Gets the actual importance at which standard error messages will be logged. (Inherited from ToolTask.) |
|
|
StandardErrorLoggingImportance | Infrastructure. Gets the importance to log ordinary messages with in the standard error stream. (Overrides ToolTask.StandardErrorLoggingImportance.) |
|
|
StandardOutputEncoding | Infrastructure. Gets the encoding of the captured task standard output stream. (Overrides ToolTask.StandardOutputEncoding.) |
|
|
StandardOutputImportance | Task Parameter: Importance with which to log text from the standard out stream. (Inherited from ToolTask.) |
|
|
StandardOutputImportanceToUse | Gets the actual importance at which standard out messages will be logged. (Inherited from ToolTask.) |
|
|
StandardOutputLoggingImportance | Infrastructure. Gets the importance to log ordinary messages with in the standard out stream. (Overrides ToolTask.StandardOutputLoggingImportance.) |
|
|
StdErrEncoding | Infrastructure. Gets or sets the encoding of the captured task standard error stream that is visible to the project. |
|
|
StdOutEncoding | Infrastructure. Gets or sets the encoding of the captured task standard output stream that is visible to the project. |
|
|
TaskProcessTerminationTimeout | A timeout to wait for a task to terminate before killing it. In milliseconds. (Inherited from ToolTask.) |
|
|
TaskResources | Gets or sets the culture-specific resources associated with the task. (Inherited from Task.) |
|
|
Timeout | Gets or sets the amount of time after which the task executable is terminated. (Inherited from ToolTask.) |
|
|
ToolCanceled | Used to signal when a tool has been cancelled. (Inherited from ToolTask.) |
|
|
ToolExe | Projects may set this to override a task's ToolName. Tasks may override this to prevent that. (Inherited from ToolTask.) |
|
|
ToolName | Infrastructure. Gets the name of the tool (cmd.exe). (Overrides ToolTask.ToolName.) |
|
|
ToolPath | Gets or sets the path of the executable file to run. (Inherited from ToolTask.) |
|
|
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. (Inherited from ToolTask.) |
|
|
WorkingDirectory | Infrastructure. Gets or sets the directory in which the command will run. |
|
|
YieldDuringToolExecution | Indicates if the task will yield the node during tool execution. (Inherited from ToolTask.) |
| Name | Description | |
|---|---|---|
|
AddCommandLineCommands | Infrastructure. Generates command line arguments that the command line tool must run directly from the command line and not from a response file. (Overrides ToolTaskExtension.AddCommandLineCommands(CommandLineBuilderExtension).) |
|
|
AddResponseFileCommands | Infrastructure. Fills the specified CommandLineBuilderExtension with the switches and other information that the command line tool can run from a response file. (Inherited from ToolTaskExtension.) |
|
|
CallHostObjectToExecute | Calls the host object to perform the work of the task. (Inherited from ToolTask.) |
|
Cancel | Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination. (Inherited from ToolTask.) |
|
|
DeleteTempFile | Deletes the specified temporary file. (Inherited from ToolTask.) |
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
|
Execute | Runs the exectuable file with the specified task parameters. (Inherited from ToolTask.) |
|
|
ExecuteTool | Infrastructure. Executes the cmd.exe tool, waits for its completion, and cleans up the batch file after execution completes. (Overrides ToolTask.ExecuteTool(String, String, String).) |
|
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
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. (Inherited from ToolTaskExtension.) |
|
|
GenerateFullPathToTool | Infrastructure. Returns the full path to the system tool cmd.exe. (Overrides ToolTask.GenerateFullPathToTool().) |
|
|
GenerateResponseFileCommands | Infrastructure. Gets the switch used by the command line tool to specify the response file. (Inherited from ToolTaskExtension.) |
|
|
GetBoolParameterWithDefault | Infrastructure. Gets the value of the specified Boolean parameter. (Inherited from ToolTaskExtension.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetIntParameterWithDefault | Infrastructure. Gets the value of the specified integer parameter. (Inherited from ToolTaskExtension.) |
|
|
GetProcessStartInfo | Initializes the information required to spawn the process executing the tool. (Inherited from ToolTask.) |
|
|
GetResponseFileSwitch | Returns the command line switch used by the executable file to specifiy a response (.rsp) file. (Inherited from ToolTask.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
GetWorkingDirectory | Infrastructure. Returns the working directory to use for the tool process. (Overrides ToolTask.GetWorkingDirectory().) |
|
|
HandleTaskExecutionErrors | Infrastructure. Logs error message and handles exit code. (Overrides ToolTask.HandleTaskExecutionErrors().) |
|
|
InitializeHostObject | Initializes the host object of the task. (Inherited from ToolTask.) |
|
|
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. (Overrides ToolTask.LogEventsFromTextOutput(String, MessageImportance).) |
|
|
LogPathToTool | Infrastructure. Logs the tool name and path. (Overrides ToolTask.LogPathToTool(String, String).) |
|
|
LogToolCommand | Infrastructure. Logs the batch file command to be executed. (Overrides ToolTask.LogToolCommand(String).) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
ResponseFileEscape | (Inherited from ToolTask.) |
|
|
SkipTaskExecution | Indicates whether task execution should be skipped. (Inherited from ToolTask.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
|
ValidateParameters | Infrastructure. Validates input parameters and logs errors or warnings, if any. Returns a Boolean value that indicates whether task execution should proceed. (Overrides ToolTask.ValidateParameters().) |
Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
