ToolTaskExtension Class
TOC
Collapse the table of content
Expand the table of content

ToolTaskExtension Class

 

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

Comprises extended utility methods for constructing a task that wraps a command line 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.

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


public ref class ToolTaskExtension abstract : ToolTask

NameDescription
System_CAPS_protpropertyBag

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

System_CAPS_pubpropertyBuildEngine

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.)

System_CAPS_pubpropertyBuildEngine2

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.)

System_CAPS_pubpropertyBuildEngine3

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.)

System_CAPS_pubpropertyBuildEngine4

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.)

System_CAPS_pubpropertyEchoOff

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.)

System_CAPS_protpropertyEnvironmentOverride

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.)

System_CAPS_pubpropertyEnvironmentVariables

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.)

System_CAPS_pubpropertyExitCode

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.)

System_CAPS_protpropertyHasLoggedErrors

This API supports the product infrastructure and is not intended to be used directly from your code. 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.(Overrides ToolTask::HasLoggedErrors.)

System_CAPS_protpropertyHelpKeywordPrefix

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.)

System_CAPS_pubpropertyHostObject

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.)

System_CAPS_pubpropertyLog

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

System_CAPS_pubpropertyLogStandardErrorAsError

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.)

System_CAPS_protpropertyResponseFileEncoding

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.)

System_CAPS_protpropertyStandardErrorEncoding

Gets the Encoding of the standard error stream 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.)

System_CAPS_pubpropertyStandardErrorImportance

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.)

System_CAPS_protpropertyStandardErrorImportanceToUse

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.)

System_CAPS_protpropertyStandardErrorLoggingImportance

Gets the MessageImportance with which to log 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.)

System_CAPS_protpropertyStandardOutputEncoding

Gets the Encoding of the standard output stream 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.)

System_CAPS_pubpropertyStandardOutputImportance

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.)

System_CAPS_protpropertyStandardOutputImportanceToUse

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.)

System_CAPS_protpropertyStandardOutputLoggingImportance

Gets the MessageImportance with which to log 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.)

System_CAPS_protpropertyTaskProcessTerminationTimeout

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.)

System_CAPS_protpropertyTaskResources

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.)

System_CAPS_pubpropertyTimeout

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.)

System_CAPS_protpropertyToolCanceled

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.)

System_CAPS_pubpropertyToolExe

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.)

System_CAPS_protpropertyToolName

Gets the name 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.)

System_CAPS_pubpropertyToolPath

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.)

System_CAPS_pubpropertyUseCommandProcessor

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.)

System_CAPS_pubpropertyYieldDuringToolExecution

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.)

NameDescription
System_CAPS_protmethodAddCommandLineCommands(CommandLineBuilderExtension^)

This API supports the product infrastructure and is not intended to be used directly from your code. Fills the specified CommandLineBuilderExtension with the switches and other information that the command line tool must run 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.

System_CAPS_protmethodAddResponseFileCommands(CommandLineBuilderExtension^)

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

System_CAPS_protmethodCallHostObjectToExecute()

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.)

System_CAPS_pubmethodCancel()

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.)

System_CAPS_protmethodDeleteTempFile(String^)

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.)

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_pubmethodExecute()

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.)

System_CAPS_protmethodExecuteTool(String^, String^, String^)

Creates a temporoary response (.rsp) file and runs 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.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodGenerateCommandLineCommands()

This API supports the product infrastructure and is not intended to be used directly from your code. 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.(Overrides ToolTask::GenerateCommandLineCommands().)

System_CAPS_protmethodGenerateFullPathToTool()

Returns the fully qualified path to 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.)

System_CAPS_protmethodGenerateResponseFileCommands()

This API supports the product infrastructure and is not intended to be used directly from your code. 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.(Overrides ToolTask::GenerateResponseFileCommands().)

System_CAPS_protmethodGetBoolParameterWithDefault(String^, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetIntParameterWithDefault(String^, Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

System_CAPS_protmethodGetProcessStartInfo(String^, String^, String^)

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.)

System_CAPS_protmethodGetResponseFileSwitch(String^)

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.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodGetWorkingDirectory()

Returns the directory in which to run 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.)

System_CAPS_protmethodHandleTaskExecutionErrors()

Handles execution errors raised by 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.)

System_CAPS_protmethodInitializeHostObject()

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.)

System_CAPS_protmethodLogEventsFromTextOutput(String^, MessageImportance)

Parses a single line of text to identify any errors or warnings in canonical format.

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.)

System_CAPS_protmethodLogPathToTool(String^, String^)

Logs the tool name and path to all registered loggers.

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.)

System_CAPS_protmethodLogToolCommand(String^)

Logs the starting point of the run to all registered loggers.

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.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodResponseFileEscape(String^)

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.)

System_CAPS_protmethodSkipTaskExecution()

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.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_protmethodValidateParameters()

Indicates whether all task paratmeters are valid.

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.)

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

Return to top
Show:
© 2016 Microsoft