This documentation is archived and is not being maintained.

ToolTask Members

When overridden in a derived form, provides functionality for a task that wraps a command line tool.

The following tables list the members exposed by the ToolTask type.

  Name Description
Protected method ToolTask Overloaded. Initializes a new instance of the ToolTask class.
Top

(see also Protected Properties )
  Name Description
Public property BuildEngine  Gets or sets the instance of the IBuildEngine object used by the task.(Inherited from Task.)
Public property ExitCode Gets the returned exit code of the executable file.
Public property HostObject  Gets or sets the host object associated with the task.(Inherited from Task.)
Public property Log  Gets an instance of a TaskLoggingHelper class containing task logging methods.(Inherited from Task.)
Public property Timeout Gets or sets the amount of time after which the task executable is terminated.
Public property ToolPath Gets or sets the path of the executable file to run.
Top

  Name Description
Protected property EnvironmentOverride Gets the override value of the PATH environment variable.
Protected property HelpKeywordPrefix  Gets or sets the prefix used to compose Help keywords from resource names.(Inherited from Task.)
Protected property ResponseFileEncoding Gets the Encoding of the response file.
Protected property StandardErrorEncoding Gets the Encoding of the standard error stream of the task.
Protected property StandardErrorLoggingImportance Gets the MessageImportance with which to log errors.
Protected property StandardOutputEncoding Gets the Encoding of the standard output stream of the task.
Protected property StandardOutputLoggingImportance Gets the MessageImportance with which to log errors.
Protected property TaskResources  Gets or sets the culture-specific resources associated with the task.(Inherited from Task.)
Protected property ToolName Gets the name of the executable file to run.
Top

(see also Protected Methods )
  Name Description
Public method Equals  Overloaded. Determines whether two Object instances are equal. (Inherited from Object.)
Public method Execute Overridden. Runs the exectuable file with the specified task parameters.
Public method GetHashCode  Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.)
Public method GetType  Gets the Type of the current instance. (Inherited from Object.)
Public method Static ReferenceEquals  Determines whether the specified Object instances are the same instance. (Inherited from Object.)
Public method ToString  Returns a String that represents the current Object. (Inherited from Object.)
Top

  Name Description
Protected method CallHostObjectToExecute Calls the host object to perform the work of the task.
Protected method ExecuteTool Creates a temporoary response (.rsp) file and runs the executable file.
Protected method Finalize  Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Protected method GenerateCommandLineCommands Returns a string value containing the command line arguments to pass directly to the executable file.
Protected method GenerateFullPathToTool Returns the fully qualified path to the executable file.
Protected method GenerateResponseFileCommands Returns a string value containing the command line arguments to add to the response (.rsp) file before running the executable file.
Protected method GetResponseFileSwitch Returns the command line switch used by the executable file to specifiy a response (.rsp) file.
Protected method GetWorkingDirectory Returns the directory in which to run the executable file.
Protected method HandleTaskExecutionErrors Handles execution errors raised by the executable file.
Protected method InitializeHostObject Initializes the host object of the task.
Protected method LogEventsFromTextOutput Parses a single line of text to identify any errors or warnings in canonical format.
Protected method LogPathToTool Logs the tool name and path to all registered loggers.
Protected method LogToolCommand Logs the starting point of the run to all registered loggers.
Protected method MemberwiseClone  Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method SkipTaskExecution Indicates whether task execution should be skipped.
Protected method ValidateParameters Indicates whether all task paratmeters are valid.
Top
Show: