Microsoft.Build.Utilities
Provides the same functionality as , but also derives from so that it can be instantiated in its own app domain.
Initializes a new instance of the class.
Initializes a new instance of the class and allows derived classes to register their resources.
The task resources.
Initializes a new instance of the class and allows derived classes to register their resources, as well as provide a prefix for composing help keywords from string resource names.
The task resources.
The Help keyword prefix.
Gets or sets the build engine interface that is available to tasks.
The that is available to tasks.
2
Runs the task.
true if successful; otherwise, false.
Gets or sets the prefix that is used to compose Help keywords from string resource names.
A that is used to compose Help keywords. This value can be null.
Gets or sets a host object instance that is associated with the derived .
The host object instance that is associated with the derived . This value can be null.
2
When overridden in a derived class, gives tasks infinite lease time.
null to specify an infinite lifetime.
2
Gets an instance of a task logging helper object that contains task logging methods.
A that contains task logging methods.
Gets or sets culture-specific resources of the derived .
A that is a culture-specific resource of the derived . This value can be null.
Comprises utility methods for constructing a command line.
Initializes a new instance of the class.
Appends the command line with the file name of the specified object.
The task item specification to append to the command line. If it is null, then this method has no effect.
Appends the command line with file name represented by the parameter, inserting quotation marks if necessary.
The file name to append. If it is null, then this method has no effect.
Appends the command line with the list of file names in the specified array, separated by the specified delimiter.
The task item specifications to append. If the array is null, then this method has no effect.
The delimiter to put between task item specifications in the command line.
Appends the command line with the list of file names in the specified string array, separated by the specified delimiter.
The file names to append. If the array is null, then this method has no effect.
The delimiter to put between file names in the command line.
Appends the command line with a file name, and surrounds the file name with quotation marks as necessary.
The file name to append.
Adds a space to the specified string, given the string is not empty.
Appends the command line with the specified switch.
The name of the switch to append to the command line. This value cannot be null.
Appends the command line with a switch that takes a task item specification that acts a single string parameter.
The name of the switch to append to the command line. This value cannot be null.
The switch parameter to append to the command line. Quotation marks will be added as necessary. If this value is null, then this method has no effect.
Appends the command line with a switch that takes an array of task item specifications that act as string parameters.
The name of the switch to append to the command line. This value cannot be null.
An array of switch parameters to append to the command line. Quotation marks will be added as necessary. If the array is null, then this method has no effect.
The delimiter that separates individual parameters. This value can be empty, but it cannot be null.
Appends the command line with a switch that takes a single string parameter.
The name of the switch to append to the command line. This value cannot be null.
The switch parameter to append to the command line. Quotation marks will be added as necessary. If this value is null, then this method has no effect.
Appends the command line with a switch that takes an array of string parameters.
The name of the switch to append to the command line. This value cannot be null.
An array of switch parameters to append to the command line. Quotation marks will be added as necessary. If the array is null, then this method has no effect.
The delimiter that separates individual parameters. This value can be empty, but it cannot be null.
Appends the command line with a switch that takes a task item specification as a single string parameter, without attempting to encapsulate the switch parameter with quotation marks.
The name of the switch to append to the command line. This value cannot be null.
The switch parameter to append to the command line. Quotation marks will not be added. If this value is null, then this method has no effect.
Appends the command line with a switch that takes an array of task item specifications that act as string parameters, without attempting to encapsulate them with quotation marks.
The name of the switch to append to the command line. This value cannot be null.
An array of switch parameters to append to the command line. Quotation marks will not be added. If the array is null, then this method has no effect.
The delimiter that separates individual parameters. This value can be empty, but it cannot be null.
Appends the command line with a switch that takes a single string parameter, without attempting to encapsulate the switch parameter with quotation marks.
The name of the switch to append to the command line. This value cannot be null.
The switch parameter to append to the command line. Quotation marks will not be added. If this value is null, then this method has no effect.
Appends the command line with a switch that takes an array of string parameters, without attempting to encapsulate switch parameters with quotation marks.
The name of the switch to append to the command line. This value cannot be null.
An array of switch parameters to append to the command line. Quotation marks will not be added. If the array is null, then this method has no effect.
The delimiter that separates individual parameters. This value can be empty, but it cannot be null.
Appends the command line with string, without attempting to encapsulate the string with quotation marks.
The string to append to the command line.
Appends the command line with string, and surrounds the string with quotations marks as necessary.
The string to append to the command line.
Gets the instance representing the command line for inheriting classes.
A for inheriting classes.
Determines whether the specified string parameter should be surrounded with quotation marks because it contains white space.
true, if the switch parameter should be surrounded with quotation marks; otherwise, false.
The string to examine for characters that require quotation marks.
Returns the command line as a string.
A that represents the command line.
Returns an error if the command line parameter contains a double-quote (") character. Because double quotes are illegal in command line parameters, this method helps prevent parameter injection attacks.
A string representing the switch name for the error message.
A string representing the switch parameter to scan for double-quotes.
Defines the next action for after an attempt to initialize the host object.
Indicates that an appropriate host object for this task exists, which can support all of the parameters passed in and should be invoked to do the real work of the task.
Indicates that either a host object is not available, or that the host object is not capable of supporting all of the features required for this build. Therefore, should fallback to an alternate means of doing the build, such as invoking the command-line tool.
Indicates that the host object is up to date, and that no further action is necessary.
Indicates that some of the parameters being passed into the task are invalid, and that the task should fail immediately.
When overridden in a derived form, provides functionality for loggers that handle events raised by the MSBuild engine.
Initializes a new instance of the class.
Generates an error message that is in the default format, from a object.
A that represents an error message in canonical format.
The arguments of the error event.
Generates a warning message that is in the default format, from a object.
A that represents a warning message in canonical format.
The arguments of the warning event.
When overridden in a derived class, subscribes the logger to specific events.
The available events that a logger can subscribe to.
Determines whether the current setting is at least the value that is passed in.
true if the current logger verbosity setting is at least the value that is passed in; otherwise, false.
The logger verbosity setting passed in.
Gets or sets the user-defined parameters of the logger.
The logger parameters. This value can be null.
When overridden in a derived class, releases the resources allocated to the logger at the time of initialization or during the build.
Gets or sets the level of detail to show in the event log.
One of the enumeration values. The default is .
Specifies the version of the .NET Framework to use with the methods in .
Specifies .NET Framework version 1.1.
Specifies .NET Framework version 2.0.
Specifies the most recent released version of the .NET Framework.
When overridden in a derived form, provides functionality for tasks.
Initializes a new instance of the class.
Initializes a new instance of the class with the specified .
The task resources.
Initializes a new instance of the class with the specified and .
The task resources.
The prefix to append to string resources to create Help keywords.
Gets or sets the instance of the object used by the task.
The available to tasks.
When overridden in a derived class, executes the task.
true if the task successfully executed; otherwise, false.
Gets or sets the prefix used to compose Help keywords from resource names.
The prefix used to compose Help keywords from resource names.
Gets or sets the host object associated with the task.
The host object associated with the task. This value can be null.
Gets an instance of a class containing task logging methods.
The logging helper object.
Gets or sets the culture-specific resources associated with the task.
The culture-specific resources associated with the task. This value can be null.
Defines a single item of the project as it is passed into a task.
Initializes a new instance of the class.
Initializes a new instance of the class using the specified source .
The item to copy.
Initializes a new instance of the class using the specified item-specification string.
The item specification.
Initializes a new instance of the class using the specified item-specification string and its metadata.
The item specification.
The custom metadata for the item specification.
Clones the collection of custom metadata for the item specification.
An that represents a clone of the custom metadata.
2
Copies the item-specification metadata to the specified destination task item.
The item that this method will copy metadata to.
2
Retrieves the specified metadata on the item.
A that represents the metadata value.
The name of the metadata to retrieve.
When overridden in a derived class, gives task items infinite lease time.
null to specify an infinite lifetime.
2
Gets or sets the item specification.
A that represents the item specification.
Gets the number of metadata set on the item.
An that represents the count of metadata set on the item.
Gets the names of all the metadata on the item.
An of metadata names.
Allows an explicit type cast from a to a , and returns the for that item.
The for the item.
The item to operate on.
2
Removes the specified metadata on the item.
The name of metadata to remove.
Sets or modifies the value of the specified metadata on the item.
The name of metadata to set or modify.
The new value of metadata.
Gets the item specification.
A that represents the item specification.
Provides helper logging methods used by tasks.
Initializes a new instance of the class and associates it with the specified task instance.
The task containing an instance of this task.
Gets the build engine that is associated with the task.
An that represents the instance of the build engine that is associated with the task.
Extracts the message code prefix from the given full message string.
The message code prefix that is extracted from the full message string, or null if there is no message code.
The full message to parse that includes code prefix.
The message with the code prefix removed.
is null.
Loads the specified resource string and optionally formats it using the given arguments.
The formatted string.
The name of the string resource to load.
Optional arguments for formatting the loaded string.
is null.
The string resource indicated by does not exist.
The property of the owner task is not set.
Formats the given string using the given arguments.
The formatted string.
The string to format.
Arguments for formatting.
is null.
Gets a value that indicates whether the task has logged any errors through this logging helper object.
true if the task has logged any errors through this logging helper object; otherwise, false.
Gets or sets the prefix used to compose Help keywords from resource names.
The prefix used to compose Help keywords from resource names.
Logs the command line for an underlying tool, executable file, or shell command of a task using the specified importance level.
One of the values of that indicates the importance level of the command line.
The command line string.
Logs the command line for an underlying tool, executable file, or shell command of a task.
The command line string.
Logs an error with the specified message.
The message.
Optional arguments for formatting the message string.
is null.
Logs an error using the specified message and other error details.
The description of the error type.
The error code.
The Help keyword to associate with the error.
The path to the file containing the error.
The line in the file where the error occurs.
The column in the file where the error occurs.
The end line in the file where the error occurs.
The end column in the file where the error occurs.
The message.
Optional arguments for formatting the message string.
is null.
Logs an error using the message from the given exception.
The exception to log.
is null.
2
Logs an error using the message, and optionally the stack trace, from the given exception.
The exception to log
true to include the stack trace in the log; otherwise, false.
is null.
2
Logs an error using the specified resource string.
The name of the string resource to load.
The arguments for formatting the loaded string.
is null.
2
Logs an error using the specified resource string and other error details.
The name of the string resource that describes the error type.
The error code.
The Help keyword to associate with the error.
The path to the file containing the error.
The line in the file where the error occurs.
The column in the file where the error occurs.
The end line in the file where the error occurs.
The end column in the file where the error occurs.
The name of the string resource to load.
The arguments for formatting the loaded string.
is null.
2
Logs an error with an error code using the specified resource string.
The name of the string resource to load.
The arguments for formatting the loaded string.
is null.
2
Logs an error using the specified resource string and other error details.
The name of the string resource that describes the error type.
The path to the file containing the error.
The line in the file where the error occurs.
The column in the file where the error occurs.
The end line in the file where the error occurs.
The end column in the file where the error occurs.
The name of the string resource to load.
The arguments for formatting the loaded string.
is null.
2
Helps log the custom build event.
The text message.
The help keyword.
The name of the project.
true to indicate that project was built successfully; otherwise, false.
2
Helps log the custom build event.
The text message.
The help keyword.
The name of the project.
The targets to build. An empty string indicates default targets.
2
Logs a message with the specified string and importance.
One of the enumeration values that specifies the importance of the message.
The message.
The arguments for formatting the message.
is null.
Logs a message with the specified string.
The message.
The arguments for formatting the message.
is null.
Logs a message with the specified resource string and importance.
One of the enumeration values that specifies the importance of the message.
The name of the string resource to load.
The arguments for formatting the loaded string.
is null.
2
Logs a message with the specified resource string.
The name of the string resource to load.
The arguments for formatting the loaded string.
is null.
2
Logs an error message or warning from the given line of text.
true if an error was logged; otherwise, false.
The line of text to log from.
One of the values of that indicates the importance level of the command line.
is null.
2
Logs errors, warnings, and messages for each line of text in the given file.
true to indicate at least one error was logged; otherwise, false.
The name of the file to log messages from.
is null.
2
Logs errors, warnings, and messages for each line of text in the given file. Also logs the importance of messages.
true to indicate at least one error was logged; otherwise, false.
The name of the file to log messages from.
One of the enumeration values that specifies the importance of logged messages.
2
Logs an error message or warning from the given stream.
true if an error was logged; otherwise, false.
A that reads the stream to log from.
One of the values of that indicates the importance level of the command line.
is null.
2
Logs a warning with the specified message.
The message.
Optional arguments for formatting the message string.
is null.
Logs a warning using the specified message and other warning details.
The description of the warning type.
The warning code.
The Help keyword to associate with the warning.
The path to the file containing the warning.
The line in the file where the warning occurs.
The column in the file where the warning occurs.
The end line in the file where the warning occurs.
The end column in the file where the warning occurs.
The message.
Optional arguments for formatting the message string.
is null.
Logs a warning using the message from the specified exception.
The exception to log.
is null.
2
Logs a warning using the message, and optionally the stack trace, from the given exception.
The exception to log
true to include the stack trace in the log; otherwise, false.
is null.
2
Logs a warning using the specified resource string.
The name of the string resource to load.
The arguments for formatting the loaded string.
is null.
2
Logs a warning using the specified resource string and other warning details.
The name of the string resource that describes the warning type.
The warning code.
The Help keyword to associate with the warning.
The path to the file containing the warning.
The line in the file where the warning occurs.
The column in the file where the warning occurs.
The end line in the file where the warning occurs.
The end column in the file where the warning occurs.
The name of the string resource to load.
The arguments for formatting the loaded string.
is null.
2
Logs a warning with a warning code using the specified resource string.
The name of the string resource to load.
The arguments for formatting the loaded string.
is null.
2
Logs a warning with a warning code using the specified resource string and other warning details.
The name of the string resource that describes the warning type.
The path to the file containing the warning.
The line in the file where the warning occurs.
The column in the file where the warning occurs.
The end line in the file where the warning occurs.
The end column in the file where the warning occurs.
The name of the string resource to load.
The arguments for formatting the loaded string.
is null.
2
Gets the name of the parent task.
The name of the parent task.
Gets or sets the culture-specific resources used by the logging methods.
A that represents the culture-specific resources used by the logging methods. This value can be null.
2
Provides utility methods for locating .NET Framework and .NET Framework SDK files and directories.
Gets the full name of the .NET Framework root registry key.
A string containing the full name of the .NET Framework root registry key.
The version of the .NET Framework to target.
Gets the value of the that contains the .NET Framework SDK installation path.
A string containing the value of the .NET Framework SDK installation path, or a null reference (Nothing in Visual Basic) if the targeted version of the .NET Framework is not installed.
The version of the .NET Framework to target.
Gets the prefix of the .NET Framework folder.
A string containing the prefix of the .NET Framework folder, or a null reference (Nothing in Visual Basic) if the targeted version of the .NET Framework is not installed.
The version of the .NET Framework to target.
Gets a fully qualified path to the .NET Framework root directory.
A string containing the fully qualified path to the .NET Framework root directory, or a null reference (Nothing in Visual Basic) if the targeted version of the .NET Framework is not installed.
The version of the .NET Framework to target.
Gets a fully qualified path to a file in the .NET Framework directory.
A string containing the fully qualified path to the specified file, or a null reference (Nothing in Visual Basic) if the targeted version of the .NET Framework is not installed.
The file to locate in the .NET Framework directory.
The version of the .NET Framework to target.
Gets the fully qualified path to the \bin directory of the .NET Framework SDK.
A string containing the fully qualified path to the \bin directory of the .NET Framework SDK, or a null reference (Nothing in Visual Basic) if the targeted version of the .NET Framework SDK is not installed.
The version of the .NET Framework to target.
Gets the fully qualified path to a file in the .NET Framework SDK.
A string containing the fully qualified path to the \bin directory of the .NET Framework SDK, or a null reference (Nothing in Visual Basic) if the targeted version of the .NET Framework SDK is not installed.
The file to locate in the .NET Framework SDK.
The version of the .NET Framework to target.
Gets a fully qualified path to a file in the system directory.
A string containing the fully qualified path to the the file in the system directory.
The file to locate in the .NET Framework SDK.
2
Gets the fully qualified path of the system directory.
A string containing a directory path to the system directory.
2
When overridden in a derived form, provides functionality for a task that wraps a command line tool.
Initializes a new instance of the class.
Initializes a new instance of the class with the specified .
The for task resources.
Initializes a new instance of the class with the specified and Help keyword prefix.
The for task resources.
The Help keyword to use for messages raised by the task.
Calls the host object to perform the work of the task.
true if the method was successfule; otherwise, false.
Gets the override value of the PATH environment variable.
The override value of the PATH environment variable.
Runs the exectuable file with the specified task parameters.
true if the task runs successfully; otherwise, false.
Creates a temporoary response (.rsp) file and runs the executable file.
The returned exit code of the executable file. If the task logged errors, but the executable returned an exit code of 0, this method returns -1.
The path to the executable file.
The command line arguments to place in the .rsp file.
The command line arguments to pass directly to the executable file.
Gets the returned exit code of the executable file.
The returned exit code of the executable file. If the task logged errors, but the executable returned an exit code of 0, this method returns -1.
Returns a string value containing the command line arguments to pass directly to the executable file.
A string value containing the command line arguments to pass directly to the executable file.
Returns the fully qualified path to the executable file.
The fully qualified path to the executable file.
Returns a string value containing the command line arguments to add to the response (.rsp) file before running the executable file.
a string value containing the command line arguments to add to the response (.rsp) file before running the executable file.
Returns the command line switch used by the executable file to specifiy a response (.rsp) file.
The command line switch used by the executable file to specifiy a response (.rsp) file.
The full path to the temporary .rsp file.
Returns the directory in which to run the executable file.
The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.
Handles execution errors raised by the executable file.
true if the method runs successfully; otherwise, false.
Initializes the host object of the task.
The of the host object.
Parses a single line of text to identify any errors or warnings in canonical format.
A single line of text for the method to parse.
A value of that indicates the importance level with which to log the message.
Logs the tool name and path to all registered loggers.
The executable file name.
The path to the executable file.
Logs the starting point of the run to all registered loggers.
A descriptive message to provide loggers, usually the command line and switches.
Gets the of the response file.
The of the response file.
Indicates whether task execution should be skipped.
true to skip task execution; otherwise, false.
Gets the of the standard error stream of the task.
The of the response file.
Gets the with which to log errors.
The with which to log errors.
Gets the of the standard output stream of the task.
The of the response file.
Gets the with which to log errors.
The with which to log errors.
Gets or sets the amount of time after which the task executable is terminated.
The time-out length, in milliseconds.
Gets the name of the executable file to run.
The name of the executable file to run.
Gets or sets the path of the executable file to run.
The path of the file to run.
Indicates whether all task paratmeters are valid.
true if all task parameters are valid; otherwise, false.
Deletes the specified temporary file.
The name of the temporary file to delete.