Partilhar via


CommandLineToolSwitchType Enum

Definition

This enumeration specifies the different types for each switch in a tool The types are used in the documentation

public enum class CommandLineToolSwitchType
public enum CommandLineToolSwitchType
type CommandLineToolSwitchType = 
Public Enum CommandLineToolSwitchType
Inheritance
CommandLineToolSwitchType

Fields

Name Value Description
Boolean 0

The boolean type has a boolean value, and there are types: one that can have a flag appended on the end and one that can't e.g. GlobalOptimizations = "true" would be /Og, and GlobalOptimizations="false" would be /Og-, but WarnAsError = "true" would be /WX, while WarnAsError = "false" would be nothing.

Integer 1

The integer switch is used for properties that have several different integer values, and depending on the value the property is set to, appends an integer to the end of a certain switch e.g. WarningLevel = "0" is /W0, WarningLevel = "2" is /W2

String 2

The string switch is used for two kinds of properties. The first is the kind that has multiple values, and has a different switch for each value e.g. Optimization="disabled" is /Od, "Full" is /Ox The second is the kind that has a literal string appended to the end of a switch. This type is similar to the File type, but in this case, will never get quoted.

StringArray 3

The stringarray switch is used for properties that may have more than one string appended to the end of the switch e.g. InjectPrecompiledHeaderReference = myfile is /Ylmyfile

ITaskItemArray 4

The ITaskItemArray type is used for properties that pass multiple files, but want to keep the metadata. Otherwise, it is used in the same way as a StringArray type.

Applies to