Export (0) Print
Expand All

Exec Class

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.

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

public class Exec : ToolTaskExtension

The Exec type exposes the following members.

  NameDescription
Public methodExecInfrastructure. Initializes a new instance of the Exec class.
Top

  NameDescription
Protected propertyBagInfrastructure. Gets the collection of parameters used by the derived task class. (Inherited from ToolTaskExtension.)
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 propertyBuildEngine4Gets the instance of the IBuildEngine4 object used by the task. (Inherited from Task.)
Public propertyCommandInfrastructure. Gets or sets the command to run.
Public propertyConsoleOutputReturns 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.
Public propertyConsoleToMSBuildEnable the standard output to pipe to an item. (StandardOutput).
Public propertyCustomErrorRegularExpressionInfrastructure. Gets or sets a regular expression to spot error lines in the tool output.
Public propertyCustomWarningRegularExpressionInfrastructure. Gets or sets a regular expression to spot warning lines in the tool output.
Public propertyEchoOffIndicates that command line echoing is turned off. (Inherited from ToolTask.)
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. (Inherited from ToolTask.)
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. (Inherited from ToolTask.)
Public propertyExitCodeGets the returned exit code of the executable file. (Inherited from ToolTask.)
Protected propertyHasLoggedErrorsInfrastructure. Returns whether this ToolTask has logged any errors. (Inherited from ToolTaskExtension.)
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 propertyIgnoreExitCodeInfrastructure. 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).
Public propertyIgnoreStandardErrorWarningFormatInfrastructure. 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.
Public propertyLogGets an instance of a TaskLoggingHelperExtension class containing task logging methods. (Inherited from ToolTaskExtension.)
Public propertyLogStandardErrorAsErrorShould ALL messages received on the standard error stream be logged as errors. (Inherited from ToolTask.)
Public propertyOutputsInfrastructure. Gets or sets the output items from the task.
Protected propertyResponseFileEncodingGets the Encoding of the response file. (Inherited from ToolTask.)
Protected propertyStandardErrorEncodingInfrastructure. Gets the encoding of the captured task standard error stream. (Overrides ToolTask.StandardErrorEncoding.)
Public propertyStandardErrorImportanceTask Parameter: Importance with which to log text from the standard error stream. (Inherited from ToolTask.)
Protected propertyStandardErrorImportanceToUseGets the actual importance at which standard error messages will be logged. (Inherited from ToolTask.)
Protected propertyStandardErrorLoggingImportanceInfrastructure. Gets the importance to log ordinary messages with in the standard error stream. (Overrides ToolTask.StandardErrorLoggingImportance.)
Protected propertyStandardOutputEncodingInfrastructure. Gets the encoding of the captured task standard output stream. (Overrides ToolTask.StandardOutputEncoding.)
Public propertyStandardOutputImportanceTask Parameter: Importance with which to log text from the standard out stream. (Inherited from ToolTask.)
Protected propertyStandardOutputImportanceToUseGets the actual importance at which standard out messages will be logged. (Inherited from ToolTask.)
Protected propertyStandardOutputLoggingImportanceInfrastructure. Gets the importance to log ordinary messages with in the standard out stream. (Overrides ToolTask.StandardOutputLoggingImportance.)
Public propertyStdErrEncodingInfrastructure. Gets or sets the encoding of the captured task standard error stream that is visible to the project.
Public propertyStdOutEncodingInfrastructure. Gets or sets the encoding of the captured task standard output stream that is visible to the project.
Protected propertyTaskProcessTerminationTimeoutA timeout to wait for a task to terminate before killing it. In milliseconds. (Inherited from ToolTask.)
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. (Inherited from ToolTask.)
Protected propertyToolCanceledUsed to signal when a tool has been cancelled. (Inherited from ToolTask.)
Public propertyToolExeProjects may set this to override a task's ToolName. Tasks may override this to prevent that. (Inherited from ToolTask.)
Protected propertyToolNameInfrastructure. Gets the name of the tool (cmd.exe). (Overrides ToolTask.ToolName.)
Public propertyToolPathGets or sets the path of the executable file to run. (Inherited from ToolTask.)
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. (Inherited from ToolTask.)
Public propertyWorkingDirectoryInfrastructure. Gets or sets the directory in which the command will run.
Public propertyYieldDuringToolExecutionIndicates if the task will yield the node during tool execution. (Inherited from ToolTask.)
Top

  NameDescription
Protected methodAddCommandLineCommandsInfrastructure. 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).)
Protected methodAddResponseFileCommandsInfrastructure. Fills the specified CommandLineBuilderExtension with the switches and other information that the command line tool can run from a response file. (Inherited from ToolTaskExtension.)
Protected methodCallHostObjectToExecuteCalls the host object to perform the work of the task. (Inherited from ToolTask.)
Public methodCancelCancels the process executing the task by asking it to close nicely, then after a short period, forcing termination. (Inherited from ToolTask.)
Protected methodDeleteTempFileDeletes the specified temporary file. (Inherited from ToolTask.)
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. (Inherited from ToolTask.)
Protected methodExecuteToolInfrastructure. Executes the cmd.exe tool, waits for its completion, and cleans up the batch file after execution completes. (Overrides ToolTask.ExecuteTool(String, String, String).)
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 methodGenerateCommandLineCommandsInfrastructure. 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.)
Protected methodGenerateFullPathToToolInfrastructure. Returns the full path to the system tool cmd.exe. (Overrides ToolTask.GenerateFullPathToTool().)
Protected methodGenerateResponseFileCommandsInfrastructure. Gets the switch used by the command line tool to specify the response file. (Inherited from ToolTaskExtension.)
Protected methodGetBoolParameterWithDefaultInfrastructure. Gets the value of the specified Boolean parameter. (Inherited from ToolTaskExtension.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Protected methodGetIntParameterWithDefaultInfrastructure. Gets the value of the specified integer parameter. (Inherited from ToolTaskExtension.)
Protected methodGetProcessStartInfoInitializes the information required to spawn the process executing the tool. (Inherited from ToolTask.)
Protected methodGetResponseFileSwitchReturns the command line switch used by the executable file to specifiy a response (.rsp) file. (Inherited from ToolTask.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodGetWorkingDirectoryInfrastructure. Returns the working directory to use for the tool process. (Overrides ToolTask.GetWorkingDirectory().)
Protected methodHandleTaskExecutionErrorsInfrastructure. Logs error message and handles exit code. (Overrides ToolTask.HandleTaskExecutionErrors().)
Protected methodInitializeHostObjectInitializes the host object of the task. (Inherited from ToolTask.)
Protected methodLogEventsFromTextOutputInfrastructure. 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).)
Protected methodLogPathToToolInfrastructure. Logs the tool name and path. (Overrides ToolTask.LogPathToTool(String, String).)
Protected methodLogToolCommandInfrastructure. Logs the batch file command to be executed. (Overrides ToolTask.LogToolCommand(String).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodResponseFileEscapeOverridable method to escape the content of the response file. (Inherited from ToolTask.)
Protected methodSkipTaskExecutionIndicates whether task execution should be skipped. (Inherited from ToolTask.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodValidateParametersInfrastructure. Validates input parameters and logs errors or warnings, if any. Returns a Boolean value that indicates whether task execution should proceed. (Overrides ToolTask.ValidateParameters().)
Top

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), 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.

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