CommandLineBuilderExtension CommandLineBuilderExtension CommandLineBuilderExtension CommandLineBuilderExtension Class

Definition

Comprises extended utility methods for constructing a command line.

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

public ref class CommandLineBuilderExtension : Microsoft::Build::Utilities::CommandLineBuilder
public class CommandLineBuilderExtension : Microsoft.Build.Utilities.CommandLineBuilder
type CommandLineBuilderExtension = class
    inherit CommandLineBuilder
Public Class CommandLineBuilderExtension
Inherits CommandLineBuilder
Inheritance
CommandLineBuilderExtensionCommandLineBuilderExtensionCommandLineBuilderExtensionCommandLineBuilderExtension

Constructors

CommandLineBuilderExtension() CommandLineBuilderExtension() CommandLineBuilderExtension() CommandLineBuilderExtension()

Initializes a new instance of the CommandLineBuilderExtension class.

Methods

AppendFileNameIfNotNull(ITaskItem) AppendFileNameIfNotNull(ITaskItem) AppendFileNameIfNotNull(ITaskItem) AppendFileNameIfNotNull(ITaskItem)

Appends the command line with the file name of the specified ITaskItem object.

(Inherited from CommandLineBuilder)
AppendFileNameIfNotNull(String) AppendFileNameIfNotNull(String) AppendFileNameIfNotNull(String) AppendFileNameIfNotNull(String)

Appends the command line with file name represented by the parameter, inserting quotation marks if necessary.

(Inherited from CommandLineBuilder)
AppendFileNamesIfNotNull(ITaskItem[], String) AppendFileNamesIfNotNull(ITaskItem[], String) AppendFileNamesIfNotNull(ITaskItem[], String) AppendFileNamesIfNotNull(ITaskItem[], String)

Appends the command line with the list of file names in the specified ITaskItem array, separated by the specified delimiter.

(Inherited from CommandLineBuilder)
AppendFileNamesIfNotNull(String[], String) AppendFileNamesIfNotNull(String[], String) AppendFileNamesIfNotNull(String[], String) AppendFileNamesIfNotNull(String[], String)

Appends the command line with the list of file names in the specified string array, separated by the specified delimiter.

(Inherited from CommandLineBuilder)
AppendFileNameWithQuoting(String) AppendFileNameWithQuoting(String) AppendFileNameWithQuoting(String) AppendFileNameWithQuoting(String)

Appends the command line with a file name, and surrounds the file name with quotation marks as necessary.

(Inherited from CommandLineBuilder)
AppendQuotedTextToBuffer(StringBuilder, String) AppendQuotedTextToBuffer(StringBuilder, String) AppendQuotedTextToBuffer(StringBuilder, String) AppendQuotedTextToBuffer(StringBuilder, String)

Appends given text to the buffer after first quoting the text if necessary.

(Inherited from CommandLineBuilder)
AppendSpaceIfNotEmpty() AppendSpaceIfNotEmpty() AppendSpaceIfNotEmpty() AppendSpaceIfNotEmpty()

Adds a space to the specified string, given the string is not empty.

(Inherited from CommandLineBuilder)
AppendSwitch(String) AppendSwitch(String) AppendSwitch(String) AppendSwitch(String)

Appends the command line with the specified switch.

(Inherited from CommandLineBuilder)
AppendSwitchIfNotNull(String, ITaskItem) AppendSwitchIfNotNull(String, ITaskItem) AppendSwitchIfNotNull(String, ITaskItem) AppendSwitchIfNotNull(String, ITaskItem)

Appends the command line with a switch that takes a task item specification that acts a single string parameter.

(Inherited from CommandLineBuilder)
AppendSwitchIfNotNull(String, ITaskItem[], String) AppendSwitchIfNotNull(String, ITaskItem[], String) AppendSwitchIfNotNull(String, ITaskItem[], String) AppendSwitchIfNotNull(String, ITaskItem[], String)

Appends the command line with a switch that takes an array of task item specifications that act as string parameters.

(Inherited from CommandLineBuilder)
AppendSwitchIfNotNull(String, String) AppendSwitchIfNotNull(String, String) AppendSwitchIfNotNull(String, String) AppendSwitchIfNotNull(String, String)

Appends the command line with a switch that takes a single string parameter.

(Inherited from CommandLineBuilder)
AppendSwitchIfNotNull(String, String[], String) AppendSwitchIfNotNull(String, String[], String) AppendSwitchIfNotNull(String, String[], String) AppendSwitchIfNotNull(String, String[], String)

Appends the command line with a switch that takes an array of string parameters.

(Inherited from CommandLineBuilder)
AppendSwitchUnquotedIfNotNull(String, ITaskItem) AppendSwitchUnquotedIfNotNull(String, ITaskItem) AppendSwitchUnquotedIfNotNull(String, ITaskItem) AppendSwitchUnquotedIfNotNull(String, ITaskItem)

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.

(Inherited from CommandLineBuilder)
AppendSwitchUnquotedIfNotNull(String, ITaskItem[], String) AppendSwitchUnquotedIfNotNull(String, ITaskItem[], String) AppendSwitchUnquotedIfNotNull(String, ITaskItem[], String) AppendSwitchUnquotedIfNotNull(String, ITaskItem[], String)

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.

(Inherited from CommandLineBuilder)
AppendSwitchUnquotedIfNotNull(String, String) AppendSwitchUnquotedIfNotNull(String, String) AppendSwitchUnquotedIfNotNull(String, String) AppendSwitchUnquotedIfNotNull(String, String)

Appends the command line with a switch that takes a single string parameter, without attempting to encapsulate the switch parameter with quotation marks.

(Inherited from CommandLineBuilder)
AppendSwitchUnquotedIfNotNull(String, String[], String) AppendSwitchUnquotedIfNotNull(String, String[], String) AppendSwitchUnquotedIfNotNull(String, String[], String) AppendSwitchUnquotedIfNotNull(String, String[], String)

Appends the command line with a switch that takes an array of string parameters, without attempting to encapsulate switch parameters with quotation marks.

(Inherited from CommandLineBuilder)
AppendTextUnquoted(String) AppendTextUnquoted(String) AppendTextUnquoted(String) AppendTextUnquoted(String)

Appends the command line with string, without attempting to encapsulate the string with quotation marks.

(Inherited from CommandLineBuilder)
AppendTextWithQuoting(String) AppendTextWithQuoting(String) AppendTextWithQuoting(String) AppendTextWithQuoting(String)

Appends the command line with string, and surrounds the string with quotations marks as necessary.

(Inherited from CommandLineBuilder)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

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

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetQuotedText(String) GetQuotedText(String) GetQuotedText(String) GetQuotedText(String)

Returns a quoted string appropriate for appending to a command line.

GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
IsQuotingRequired(String) IsQuotingRequired(String) IsQuotingRequired(String) IsQuotingRequired(String)

Determines whether the specified string parameter should be surrounded with quotation marks because it contains white space.

(Inherited from CommandLineBuilder)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns the command line as a string.

(Inherited from CommandLineBuilder)
VerifyThrowNoEmbeddedDoubleQuotes(String, String) VerifyThrowNoEmbeddedDoubleQuotes(String, String) VerifyThrowNoEmbeddedDoubleQuotes(String, String) VerifyThrowNoEmbeddedDoubleQuotes(String, String)

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.

(Inherited from CommandLineBuilder)

Properties

CommandLine CommandLine CommandLine CommandLine

Gets the StringBuilder instance representing the command line for inheriting classes.

(Inherited from CommandLineBuilder)
Length Length Length Length

Represents the length of the command line.

(Inherited from CommandLineBuilder)

Applies to