ToolTaskExtension Class

Definition

A small intermediate class between ToolTask and classes using it in XMakeTasks, implementing functionality that we didn't want to expose in Utilities

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
ToolTaskExtension
Derived

Remarks

This class has to be public because the tasks that derive from it are public. Ideally we would like this class to be internal, but C# does not allow a base class to be less accessible than its derived classes.

Properties

Bag

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.

BuildEngine

The build engine automatically sets this property to allow tasks to call back into it.

(Inherited from Task)
BuildEngine2

The build engine automatically sets this property to allow tasks to call back into it. This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

(Inherited from Task)
BuildEngine3

Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine4

Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine5

Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine6

Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine7

Retrieves the IBuildEngine7 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine8

Retrieves the IBuildEngine8 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine9

Retrieves the IBuildEngine9 version of the build engine interface provided by the host.

(Inherited from Task)
EchoOff

When set to true, it passes /Q to the cmd.exe command line such that the command line does not get echo-ed on stdout

(Inherited from ToolTask)
EnvironmentOverride
Obsolete.

Gets the Path override value.

(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

The return code of the spawned process. If the task logged any errors, but the process had an exit code of 0 (success), this will be set to -1.

(Inherited from ToolTask)
HasLoggedErrors

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

Whether this ToolTaskExtension has logged any errors

HasLoggedErrors

Whether this ToolTask has logged any errors

(Inherited from ToolTask)
HelpKeywordPrefix

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

(Inherited from Task)
HostObject

The build engine sets this property if the host IDE has associated a host object with this particular task.

(Inherited from Task)
Log

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.

LogStandardErrorAsError

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

(Inherited from ToolTask)
ResponseFileEncoding

Overridable property specifying the encoding of the response file, UTF8 by default

(Inherited from ToolTask)
StandardErrorEncoding

Overridable property specifying the encoding of the captured task standard error stream

(Inherited from ToolTask)
StandardErrorImportance

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

(Inherited from ToolTask)
StandardErrorImportanceToUse

The actual importance at which standard error messages will be logged.

(Inherited from ToolTask)
StandardErrorLoggingImportance

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

(Inherited from ToolTask)
StandardOutputEncoding

Overridable property specifying the encoding of the captured task standard output stream

(Inherited from ToolTask)
StandardOutputImportance

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

(Inherited from ToolTask)
StandardOutputImportanceToUse

The actual importance at which standard out messages will be logged.

(Inherited from ToolTask)
StandardOutputLoggingImportance

Importance with which to log text from in the standard out stream.

(Inherited from ToolTask)
TaskProcessTerminationTimeout

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

(Inherited from ToolTask)
TaskResources

Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings.

(Inherited from Task)
Timeout

Project visible property that allows the user to specify an 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

Implemented by the derived class. Returns a string which is the name of the underlying .EXE to run e.g. "resgen.exe" Only used by the ToolExe getter.

(Inherited from ToolTask)
ToolPath

Project-visible property allows the user to override the path to the executable.

(Inherited from ToolTask)
UseCommandProcessor

When set to true, 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)
UseNewLineSeparatorInResponseFile

When set to true, the response file will use new lines instead of spaces to separate arguments.

UseUtf8Encoding

Whether or not to use UTF8 encoding for the cmd file and console window. Values: Always, Never, Detect If set to Detect, the current code page will be used unless it cannot represent the Command string. In that case, UTF-8 is used.

(Inherited from ToolTask)
YieldDuringToolExecution

When set to true, this task will yield the node when its task is executing.

(Inherited from ToolTask)

Methods

AddCommandLineCommands(CommandLineBuilderExtension)

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

Fills the provided CommandLineBuilderExtension with those switches and other information that can't go into a response file and must go directly onto the command line.

AddResponseFileCommands(CommandLineBuilderExtension)

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

Fills the provided CommandLineBuilderExtension with those switches and other information that can go into a response file.

AdjustCommandsForOperatingSystem(String)

Replace backslashes with OS-specific path separators, except when likely that the backslash is intentional.

(Inherited from ToolTask)
CallHostObjectToExecute()

We expect the tasks to override this method, if they support host objects. The implementation should call into the host object to perform the real work of the task. For example, for compiler tasks like Csc and Vbc, this method would call Compile() on the host object.

(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(String)

Delete temporary file. If the delete fails for some reason (e.g. file locked by anti-virus) then the call will not throw an exception. Instead a warning will be logged, but the build will not fail.

(Inherited from ToolTask)
Execute()

This method invokes the tool with the given parameters.

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

Writes out a temporary response file and shell-executes the tool requested. Enables concurrent logging of the output of the tool.

(Inherited from ToolTask)
GenerateCommandLineCommands()

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

Returns a string with those switches and other information that can't go into a response file and must go directly onto the command line. Called after ValidateParameters and SkipTaskExecution

GenerateFullPathToTool()

Gets the fully qualified tool name. Should return ToolExe if ToolTask should search for the tool in the system path. If ToolPath is set, this is ignored.

(Inherited from ToolTask)
GenerateResponseFileCommands()

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

Returns the command line switch used by the tool executable to specify the response file Will only be called if the task returned a non empty string from GetResponseFileCommands Called after ValidateParameters, SkipTaskExecution and GetResponseFileCommands

GetBoolParameterWithDefault(String, Boolean)

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

Get a bool parameter and return a default if its not present in the hash table.

GetIntParameterWithDefault(String, Int32)

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

Get an int parameter and return a default if its not present in the hash table.

GetProcessStartInfo(String, String, String)

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

(Inherited from ToolTask)
GetResponseFileSwitch(String)

Returns the command line switch used by the tool executable to specify the response file. Will only be called if the task returned a non empty string from GetResponseFileCommands Called after ValidateParameters, SkipTaskExecution and GetResponseFileCommands

(Inherited from ToolTask)
GetWorkingDirectory()

Gets the working directory to use for the process. Should return null if ToolTask should use the current directory.

(Inherited from ToolTask)
HandleTaskExecutionErrors()

Allows tool to handle the return code. This method will only be called with non-zero exitCode.

(Inherited from ToolTask)
InitializeHostObject()

We expect tasks to override this method if they support host objects. The implementation should make sure that the host object is ready to perform the real work of the task.

(Inherited from ToolTask)
LogEventsFromTextOutput(String, MessageImportance)

Calls a method on the TaskLoggingHelper to parse a single line of text to see if there are any errors or warnings in canonical format. This can be overridden by the derived class if necessary.

(Inherited from ToolTask)
LogPathToTool(String, String)

Logs the tool name and the path from where it is being run.

(Inherited from ToolTask)
LogToolCommand(String)

Logs the actual command line about to be executed (or what the task wants the log to show)

(Inherited from ToolTask)
ProcessStarted()

Overridable function called after Start() in ExecuteTool(String, String, String)

(Inherited from ToolTask)
ResponseFileEscape(String)

Overridable method to escape content of the response file

(Inherited from ToolTask)
SkipTaskExecution()

Returns true if task execution is not necessary. Executed after ValidateParameters

(Inherited from ToolTask)
ValidateParameters()

Implemented in the derived class

(Inherited from ToolTask)

Applies to