This documentation is archived and is not being maintained.

CommandLineBuilderExtension Class

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

Comprises extended utility methods for constructing a command line.

System.Object
  Microsoft.Build.Utilities.CommandLineBuilder
    Microsoft.Build.Tasks.CommandLineBuilderExtension

Namespace:  Microsoft.Build.Tasks
Assembly:  Microsoft.Build.Tasks.v4.0 (in Microsoft.Build.Tasks.v4.0.dll)

public class CommandLineBuilderExtension : CommandLineBuilder

The CommandLineBuilderExtension type exposes the following members.

  NameDescription
Public methodCommandLineBuilderExtensionInfrastructure. Initializes a new instance of the CommandLineBuilderExtension class.
Top

  NameDescription
Protected propertyCommandLineGets the StringBuilder instance representing the command line for inheriting classes. (Inherited from CommandLineBuilder.)
Public propertyLengthRepresents the length of the command line. (Inherited from CommandLineBuilder.)
Top

  NameDescription
Public methodAppendFileNameIfNotNull(ITaskItem)Appends the command line with the file name of the specified ITaskItem object. (Inherited from CommandLineBuilder.)
Public methodAppendFileNameIfNotNull(String)Appends the command line with file name represented by the parameter, inserting quotation marks if necessary. (Inherited from CommandLineBuilder.)
Public methodAppendFileNamesIfNotNull(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.)
Public methodAppendFileNamesIfNotNull(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.)
Protected methodAppendFileNameWithQuotingAppends the command line with a file name, and surrounds the file name with quotation marks as necessary. (Inherited from CommandLineBuilder.)
Protected methodAppendQuotedTextToBufferAppends given text to the buffer after first quoting the text if necessary. (Inherited from CommandLineBuilder.)
Protected methodAppendSpaceIfNotEmptyAdds a space to the specified string, given the string is not empty. (Inherited from CommandLineBuilder.)
Public methodAppendSwitchAppends the command line with the specified switch. (Inherited from CommandLineBuilder.)
Public methodAppendSwitchIfNotNull(String, ITaskItem)Appends the command line with a switch that takes a task item specification that acts a single string parameter. (Inherited from CommandLineBuilder.)
Public methodAppendSwitchIfNotNull(String, String)Appends the command line with a switch that takes a single string parameter. (Inherited from CommandLineBuilder.)
Public methodAppendSwitchIfNotNull(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.)
Public methodAppendSwitchIfNotNull(String, String[], String)Appends the command line with a switch that takes an array of string parameters. (Inherited from CommandLineBuilder.)
Public methodAppendSwitchUnquotedIfNotNull(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.)
Public methodAppendSwitchUnquotedIfNotNull(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.)
Public methodAppendSwitchUnquotedIfNotNull(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.)
Public methodAppendSwitchUnquotedIfNotNull(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.)
Public methodAppendTextUnquotedAppends the command line with string, without attempting to encapsulate the string with quotation marks. (Inherited from CommandLineBuilder.)
Protected methodAppendTextWithQuotingAppends the command line with string, and surrounds the string with quotations marks as necessary. (Inherited from CommandLineBuilder.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetQuotedTextInfrastructure. Returns a quoted string appropriate for appending to a command line.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodIsQuotingRequiredDetermines whether the specified string parameter should be surrounded with quotation marks because it contains white space. (Inherited from CommandLineBuilder.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns the command line as a string. (Inherited from CommandLineBuilder.)
Protected methodVerifyThrowNoEmbeddedDoubleQuotesReturns 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.)
Top

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: