ToolTaskExtension ToolTaskExtension ToolTaskExtension ToolTaskExtension Class

Definition

Comprises extended utility methods for constructing a task that wraps a command line tool.

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

public ref class ToolTaskExtension abstract : Microsoft::Build::Utilities::ToolTask
public abstract class ToolTaskExtension : Microsoft.Build.Utilities.ToolTask
type ToolTaskExtension = class
    inherit ToolTask
Public MustInherit Class ToolTaskExtension
Inherits ToolTask
Inheritance
ToolTaskExtensionToolTaskExtensionToolTaskExtensionToolTaskExtension
Derived

Properties

Bag Bag Bag Bag

Gets the collection of parameters used by the derived task class.

BuildEngine BuildEngine BuildEngine BuildEngine

Gets or sets the instance of the IBuildEngine object used by the task.

(Inherited from Task)
BuildEngine2 BuildEngine2 BuildEngine2 BuildEngine2

Gets the instance of the IBuildEngine2 object used by the task.

(Inherited from Task)
BuildEngine3 BuildEngine3 BuildEngine3 BuildEngine3

Gets the instance of the IBuildEngine3 object used by the task.

(Inherited from Task)
BuildEngine4 BuildEngine4 BuildEngine4 BuildEngine4

Gets the instance of the IBuildEngine4 object used by the task.

(Inherited from Task)
EchoOff EchoOff EchoOff EchoOff

Gets or sets a value that indicates whether command line echoing is turned off.

(Inherited from ToolTask)
EnvironmentOverride EnvironmentOverride EnvironmentOverride EnvironmentOverride

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 EnvironmentVariables EnvironmentVariables 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 ExitCode ExitCode ExitCode

Gets the returned exit code of the executable file.

(Inherited from ToolTask)
HasLoggedErrors HasLoggedErrors HasLoggedErrors HasLoggedErrors

Returns whether this ToolTask has logged any errors.

HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix

Gets or sets the prefix used to compose Help keywords from resource names.

(Inherited from Task)
HostObject HostObject HostObject HostObject

Gets or sets the host object associated with the task.

(Inherited from Task)
Log Log Log Log

Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

LogStandardErrorAsError LogStandardErrorAsError LogStandardErrorAsError LogStandardErrorAsError

Should ALL messages received on the standard error stream be logged as errors.

(Inherited from ToolTask)
ResponseFileEncoding ResponseFileEncoding ResponseFileEncoding ResponseFileEncoding

Gets the Encoding of the response file.

(Inherited from ToolTask)
StandardErrorEncoding StandardErrorEncoding StandardErrorEncoding StandardErrorEncoding

Gets the Encoding of the standard error stream of the task.

(Inherited from ToolTask)
StandardErrorImportance StandardErrorImportance StandardErrorImportance StandardErrorImportance

Task Parameter: Importance with which to log text from the standard error stream.

(Inherited from ToolTask)
StandardErrorImportanceToUse StandardErrorImportanceToUse StandardErrorImportanceToUse StandardErrorImportanceToUse

Gets the actual importance at which standard error messages will be logged.

(Inherited from ToolTask)
StandardErrorLoggingImportance StandardErrorLoggingImportance StandardErrorLoggingImportance StandardErrorLoggingImportance

Gets the MessageImportance with which to log errors.

(Inherited from ToolTask)
StandardOutputEncoding StandardOutputEncoding StandardOutputEncoding StandardOutputEncoding

Gets the Encoding of the standard output stream of the task.

(Inherited from ToolTask)
StandardOutputImportance StandardOutputImportance StandardOutputImportance StandardOutputImportance

Task Parameter: Importance with which to log text from the standard out stream.

(Inherited from ToolTask)
StandardOutputImportanceToUse StandardOutputImportanceToUse StandardOutputImportanceToUse StandardOutputImportanceToUse

Gets the actual importance at which standard out messages will be logged.

(Inherited from ToolTask)
StandardOutputLoggingImportance StandardOutputLoggingImportance StandardOutputLoggingImportance StandardOutputLoggingImportance

Gets the MessageImportance with which to log errors.

(Inherited from ToolTask)
TaskProcessTerminationTimeout TaskProcessTerminationTimeout TaskProcessTerminationTimeout TaskProcessTerminationTimeout

A timeout to wait for a task to terminate before killing it. In milliseconds.

(Inherited from ToolTask)
TaskResources TaskResources TaskResources TaskResources

Gets or sets the culture-specific resources associated with the task.

(Inherited from Task)
Timeout Timeout Timeout Timeout

Gets or sets the amount of time after which the task executable is terminated.

(Inherited from ToolTask)
ToolCanceled ToolCanceled ToolCanceled ToolCanceled

Used to signal when a tool has been cancelled.

(Inherited from ToolTask)
ToolExe ToolExe ToolExe ToolExe

Projects may set this to override a task's ToolName. Tasks may override this to prevent that.

(Inherited from ToolTask)
ToolName ToolName ToolName ToolName

Gets the name of the executable file to run.

(Inherited from ToolTask)
ToolPath ToolPath ToolPath ToolPath

Gets or sets the path of the executable file to run.

(Inherited from ToolTask)
UseCommandProcessor UseCommandProcessor UseCommandProcessor UseCommandProcessor

Gets or sets a value that indicates 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)
YieldDuringToolExecution YieldDuringToolExecution YieldDuringToolExecution YieldDuringToolExecution

Gets or sets a value that indicates whether the task will yield the node during tool execution.

(Inherited from ToolTask)

Methods

AddCommandLineCommands(CommandLineBuilderExtension) AddCommandLineCommands(CommandLineBuilderExtension) AddCommandLineCommands(CommandLineBuilderExtension) AddCommandLineCommands(CommandLineBuilderExtension)

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.

AddResponseFileCommands(CommandLineBuilderExtension) AddResponseFileCommands(CommandLineBuilderExtension) AddResponseFileCommands(CommandLineBuilderExtension) AddResponseFileCommands(CommandLineBuilderExtension)

Fills the specified CommandLineBuilderExtension with the switches and other information that the command line tool can run from a response file.

CallHostObjectToExecute() CallHostObjectToExecute() CallHostObjectToExecute() CallHostObjectToExecute()

Calls the host object to perform the work of the task.

(Inherited from ToolTask)
Cancel() Cancel() Cancel() Cancel()

Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination.

(Inherited from ToolTask)
DeleteTempFile(String) DeleteTempFile(String) DeleteTempFile(String) DeleteTempFile(String)

Deletes the specified temporary file.

(Inherited from ToolTask)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Execute() Execute() Execute() Execute()

Runs the executable file with the specified task parameters.

(Inherited from ToolTask)
ExecuteTool(String, String, String) ExecuteTool(String, String, String) ExecuteTool(String, String, String) ExecuteTool(String, String, String)

Creates a temporary response (.rsp) file and runs the executable file.

(Inherited from ToolTask)
GenerateCommandLineCommands() GenerateCommandLineCommands() GenerateCommandLineCommands() GenerateCommandLineCommands()

Gets the switches and other information that the command line tool must run directly from the command line and not from a response file.

GenerateFullPathToTool() GenerateFullPathToTool() GenerateFullPathToTool() GenerateFullPathToTool()

Returns the fully qualified path to the executable file.

(Inherited from ToolTask)
GenerateResponseFileCommands() GenerateResponseFileCommands() GenerateResponseFileCommands() GenerateResponseFileCommands()

Gets the switch used by the command line tool to specify the response file.

GetBoolParameterWithDefault(String, Boolean) GetBoolParameterWithDefault(String, Boolean) GetBoolParameterWithDefault(String, Boolean) GetBoolParameterWithDefault(String, Boolean)

Gets the value of the specified Boolean parameter.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetIntParameterWithDefault(String, Int32) GetIntParameterWithDefault(String, Int32) GetIntParameterWithDefault(String, Int32) GetIntParameterWithDefault(String, Int32)

Gets the value of the specified integer parameter.

GetProcessStartInfo(String, String, String) GetProcessStartInfo(String, String, String) GetProcessStartInfo(String, String, String) GetProcessStartInfo(String, String, String)

Initializes the information required to spawn the process executing the tool.

(Inherited from ToolTask)
GetResponseFileSwitch(String) GetResponseFileSwitch(String) GetResponseFileSwitch(String) GetResponseFileSwitch(String)

Returns the command line switch used by the executable file to specify a response (.rsp) file.

(Inherited from ToolTask)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetWorkingDirectory() GetWorkingDirectory() GetWorkingDirectory() GetWorkingDirectory()

Returns the directory in which to run the executable file.

(Inherited from ToolTask)
HandleTaskExecutionErrors() HandleTaskExecutionErrors() HandleTaskExecutionErrors() HandleTaskExecutionErrors()

Handles execution errors raised by the executable file.

(Inherited from ToolTask)
InitializeHostObject() InitializeHostObject() InitializeHostObject() InitializeHostObject()

Initializes the host object of the task.

(Inherited from ToolTask)
LogEventsFromTextOutput(String, MessageImportance) LogEventsFromTextOutput(String, MessageImportance) LogEventsFromTextOutput(String, MessageImportance) LogEventsFromTextOutput(String, MessageImportance)

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

(Inherited from ToolTask)
LogPathToTool(String, String) LogPathToTool(String, String) LogPathToTool(String, String) LogPathToTool(String, String)

Logs the tool name and path to all registered loggers.

(Inherited from ToolTask)
LogToolCommand(String) LogToolCommand(String) LogToolCommand(String) LogToolCommand(String)

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

(Inherited from ToolTask)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ResponseFileEscape(String) ResponseFileEscape(String) ResponseFileEscape(String) ResponseFileEscape(String)

Overridable method to escape the content of the response file.

(Inherited from ToolTask)
SkipTaskExecution() SkipTaskExecution() SkipTaskExecution() SkipTaskExecution()

Indicates whether task execution should be skipped.

(Inherited from ToolTask)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
ValidateParameters() ValidateParameters() ValidateParameters() ValidateParameters()

Indicates whether all task parameters are valid.

(Inherited from ToolTask)

Applies to