Reservierte und bekannte Eigenschaften für MSBuildMSBuild reserved and well-known properties

MSBuild stellt eine Reihe vordefinierter Eigenschaften zum Speichern von Informationen über die Projektdatei und die MSBuild-Binärdateien bereit.MSBuild provides a set of predefined properties that store information about the project file and the MSBuild binaries. Diese Eigenschaften werden auf dieselbe Weise ausgewertet wie andere MSBuild-Eigenschaften.These properties are evaluated in the same manner as other MSBuild properties. Zum Verwenden der MSBuildProjectFile-Eigenschaft geben Sie beispielsweise $(MSBuildProjectFile) ein.For example, to use the MSBuildProjectFile property, you type $(MSBuildProjectFile).

MSBuild verwendet die Werte in der folgenden Tabelle, um die reservierten und bekannten Eigenschaften vorzudefinieren.MSBuild uses the values in the following table to predefine reserved and well-known properties. Reservierte Eigenschaften können nicht überschrieben werden, aber bekannte Eigenschaften können überschrieben werden, indem identisch benannte Umgebungseigenschaften, globale Eigenschaften oder Eigenschaften verwendet werden, die in der Projektdatei deklariert sind.Reserved properties cannot be overridden, but well-known properties can be overridden by using identically named environment properties, global properties, or properties that are declared in the project file.

Reservierte und bekannte EigenschaftenReserved and well-known properties

In der folgenden Tabelle sind die vordefinierten MSBuild-Eigenschaften enthalten.The table in this section shows the MSBuild predefined properties. Die Beispielspalte in der Tabelle bezieht sich auf die folgende Beispielprojektdatei, von der angenommen wird, dass sie sich unter C:\Source\Repos\ConsoleApp1\ConsoleApp1 befindet. Sie enthält die Werte dieser Eigenschaften beim Zugriff in der Projektdatei, wenn MSBuild ohne spezielle Befehlszeilenoptionen aufgerufen wird. Dabei ist ein Vorschaubuild von Visual Studio 2019 Version 16.7 installiert.The example column in the table relates to the following example project file, assumed to be located at C:\Source\Repos\ConsoleApp1\ConsoleApp1, and shows the values of these properties have when accessed in the project file, when MSBuild is invoked with no special command-line options, with a preview build of Visual Studio 2019 version 16.7 installed.

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>
</Project>
EigenschaftProperty Reserviert oder bekanntReserved or well-known BeschreibungDescription BeispielExample
MSBuildBinPath ReserviertReserved Der absolute Pfad des Ordners, in dem sich die zurzeit verwendeten MSBuild-Binärdateien befinden (z. B. C:\Windows\Microsoft.Net\Framework\<versionNumber> ).The absolute path of the folder where the MSBuild binaries that are currently being used are located (for example, C:\Windows\Microsoft.Net\Framework\<versionNumber> ). Diese Eigenschaft ist nützlich, wenn Sie auf Dateien im MSBuild-Verzeichnis verweisen müssen.This property is useful if you have to refer to files in the MSBuild directory.

Schließen Sie nicht den abschließenden umgekehrten Schrägstrich in dieser Eigenschaft ein.Do not include the final backslash on this property.
C:\Program Files (x86)\Microsoft Visual Studio\2019\Preview\MSBuild\Current\Bin
MSBuildExtensionsPath BekanntWell-known Seit .NET Framework 4 gibt es keinen Unterschied zwischen den Standardwerten von MSBuildExtensionsPath und MSBuildExtensionsPath32.Introduced in the .NET Framework 4: there is no difference between the default values of MSBuildExtensionsPath and MSBuildExtensionsPath32. Sie können die Umgebungsvariable MSBUILDLEGACYEXTENSIONSPATH auf einen Wert ungleich NULL festlegen, um das Verhalten des Standardwerts von MSBuildExtensionsPath in früheren Versionen zu ermöglichen.You can set the environment variable MSBUILDLEGACYEXTENSIONSPATH to a non-null value to enable the behavior of the default value of MSBuildExtensionsPath in earlier versions.

In .NET Framework 3.5 und Vorgängerversionen verweist der Standardwert von MSBuildExtensionsPath auf den Pfad des MSBuild-Unterordners unter dem Ordner \Programme\ oder \Programme (x86) , je nach Bitanzahl des aktuellen Prozesses.In the .NET Framework 3.5 and earlier, the default value of MSBuildExtensionsPath points to the path of the MSBuild subfolder under the \Program Files\ or \Program Files (x86) folder, depending on the bitness of the current process. Bei einem 32-Bit-Prozess auf einem 64-Bit-Computer zeigt diese Eigenschaft beispielsweise auf den Ordner \Programme (x86) .For example, for a 32-bit process on a 64-bit machine, this property points to the \Program Files (x86) folder. Bei einem 64-Bit-Prozess auf einem 64-Bit-Computer zeigt diese Eigenschaft auf den Ordner \Programme.For a 64-bit process on a 64-bit machine, this property points to the \Program Files folder.

Schließen Sie nicht den abschließenden umgekehrten Schrägstrich in dieser Eigenschaft ein.Do not include the final backslash on this property.

Dieser Speicherort ist nützlich zum Ablegen benutzerdefinierter Zieldateien.This location is a useful place to put custom target files. Ihre Zieldateien können beispielsweise unter \Programme\MSBuild\MyFiles\Northwind.targets installiert sein und dann mithilfe des folgenden XML-Codes in Projektdateien importiert werden:For example, your target files could be installed at \Program Files\MSBuild\MyFiles\Northwind.targets and then imported in project files by using this XML code:

<Import Project="$(MSBuildExtensionsPath)\MyFiles\Northwind.targets"/>
C:\Program Files (x86)\Microsoft Visual Studio\2019\Preview\MSBuild
MSBuildExtensionsPath32 BekanntWell-known Der Pfad zu dem MSBuild-Unterordner unter dem Ordner \Programme oder \Programme (x86) .The path of the MSBuild subfolder under the \Program Files or \Program Files (x86) folder. Dieser Pfad führt stets zum 32-Bit-Ordner \Programme auf einem 32-Bit-Computer und zu \Programme (x86) auf einem 64-Bit-Computer.The path always points to the 32-bit \Program Files (x86) folder on a 32-bit machine and \Program Files on a 64-bit machine.". Siehe auch MSBuildExtensionsPath und MSBuildExtensionsPath64.See also MSBuildExtensionsPath and MSBuildExtensionsPath64.

Schließen Sie nicht den abschließenden umgekehrten Schrägstrich in dieser Eigenschaft ein.Do not include the final backslash on this property.
C:\Program Files (x86)\Microsoft Visual Studio\2019\Preview\MSBuild
MSBuildExtensionsPath64 BekanntWell-known Der Pfad des MSBuild-Unterordners im Ordner \Programme.The path of the MSBuild subfolder under the \Program Files folder. Bei einem 64-Bit-Computer zeigt dieser Pfad immer auf den Ordner \Programme.For a 64-bit machine, this path always points to the \Program Files folder. Bei einem 32-Bit-Computer ist dieser Pfad leer.For a 32-bit machine, this path is blank. Siehe auch MSBuildExtensionsPath und MSBuildExtensionsPath32.See also MSBuildExtensionsPath and MSBuildExtensionsPath32.

Schließen Sie nicht den abschließenden umgekehrten Schrägstrich in dieser Eigenschaft ein.Do not include the final backslash on this property.
C:\Program Files\MSBuild
MSBuildInteractive ReserviertReserved Der Wert dieser Eigenschaft ist true, wenn MSBuild interaktiv ausgeführt wird, wodurch Benutzereingaben zugelassen werden.true if MSBuild is running interactively, allowing user input. Diese Einstellung wird von der Befehlszeilenoption -interactive gesteuert.This setting is controlled by the -interactive command-line option. false
MSBuildLastTaskResult ReserviertReserved true, wenn die vorherige Aufgabe ohne Fehler (auch wenn Warnungen auftraten) abgeschlossen wurde, oder false, wenn bei der vorherigen Aufgabe Fehler aufgetreten sind.true if the previous task completed without any errors (even if there were warnings), or false if the previous task had errors. Wenn ein Fehler in einer Aufgabe auftritt, ist das Auftreten des Fehlers in der Regel das letzte Ereignis in dem jeweiligen Projekt.Typically, when an error occurs in a task, the error is the last thing that happens in that project. Daher ist der Wert dieser Eigenschaft niemals false, außer in diesen Szenarien:Therefore, the value of this property is never false, except in these scenarios:

– Wenn für das ContinueOnError-Attribut des Aufgabenelements (MSBuild)WarnAndContinue (oder true) bzw. ErrorAndContinue festgelegt wird.- When the ContinueOnError attribute of the Task element (MSBuild) is set to WarnAndContinue (or true) or ErrorAndContinue.

– Wenn Target über ein OnError-Element (MSBuild) als untergeordnetes Element verfügt.- When the Target has an OnError element (MSBuild) as a child element.
true
MSBuildNodeCount ReserviertReserved Die maximale Anzahl nebenläufiger Prozesse, die beim Erstellen verwendet werden.The maximum number of concurrent processes that are used when building. Dies ist der Wert, den Sie in der Befehlszeile für -maxcpucount angegeben haben.This is the value that you specified for -maxcpucount on the command line. Wenn Sie -maxcpucount ohne einen Wert angegeben haben, wird die Anzahl der Prozessoren im Computer durch MSBuildNodeCount angegeben.If you specified -maxcpucount without specifying a value, then MSBuildNodeCount specifies the number of processors in the computer. Weitere Informationen finden Sie unter MSBuild-Befehlszeilenreferenz sowie unter Paralleles Erstellen von mehreren Projekten mit MSBuild.For more information, see Command-line reference and Build multiple projects in parallel. 11
MSBuildProgramFiles32 ReserviertReserved Der Speicherort des Ordners für 32-Bit-Programme, beispielsweise C:\Programme (x86) .The location of the 32-bit program folder; for example, C:\Program Files (x86).

Schließen Sie nicht den abschließenden umgekehrten Schrägstrich in dieser Eigenschaft ein.Do not include the final backslash on this property.
C:\Program Files (x86)
MSBuildProjectDefaultTargets ReserviertReserved Die vollständige Liste der Ziele, die im DefaultTargets-Attribut des Project-Elements angegeben sind.The complete list of targets that are specified in the DefaultTargets attribute of the Project element. Das folgende Project-Element würde beispielsweise über einen MSBuildDefaultTargets-Eigenschaftswert von A;B;C verfügen:For example, the following Project element would have an MSBuildDefaultTargets property value of A;B;C:

<Project DefaultTargets="A;B;C" >
Build
MSBuildProjectDirectory ReserviertReserved Der absolute Pfad des Verzeichnisses, in dem sich die Projektdatei befindet, beispielsweise C:\MyCompany\MyProduct.The absolute path of the directory where the project file is located, for example C:\MyCompany\MyProduct.

Schließen Sie nicht den abschließenden umgekehrten Schrägstrich in dieser Eigenschaft ein.Do not include the final backslash on this property.
C:\Source\Repos\ConsoleApp1\ConsoleApp1
MSBuildProjectDirectoryNoRoot ReserviertReserved Der Wert der MSBuildProjectDirectory-Eigenschaft, ausschließlich des Stammlaufwerks.The value of the MSBuildProjectDirectory property, excluding the root drive.

Schließen Sie nicht den abschließenden umgekehrten Schrägstrich in dieser Eigenschaft ein.Do not include the final backslash on this property.
Source\Repos\ConsoleApp1\ConsoleApp1
MSBuildProjectExtension ReserviertReserved Die Erweiterung der Projektdatei, einschließlich des Punkts, z.B. .proj.The file name extension of the project file, including the period; for example, .proj. .csproj
MSBuildProjectFile ReserviertReserved Der vollständige Dateiname der Projektdatei, einschließlich der Erweiterung, z.B. MyApp.proj.The complete file name of the project file, including the file name extension; for example, MyApp.proj. ConsoleApp1.csproj
MSBuildProjectFullPath ReserviertReserved Der absolute Pfad und der vollständige Dateiname der Projektdatei, einschließlich der Erweiterung, beispielsweise C:\MyCompany\MyProduct\MyApp.proj.The absolute path and complete file name of the project file, including the file name extension; for example, C:\MyCompany\MyProduct\MyApp.proj. c:\Source\Repos\ConsoleApp1\ConsoleApp1\ConsoleApp1.csproj
MSBuildProjectName ReserviertReserved Der Dateiname der Projektdatei ohne die Erweiterung, z.B. MyApp.The file name of the project file without the file name extension; for example, MyApp. ConsoleApp1
MSBuildRuntimeType ReserviertReserved Der Typ der Laufzeit, der derzeit ausgeführt wird.The type of the runtime that is currently executing. Eingeführt in MSBuild 15.Introduced in MSBuild 15. Der Wert ist möglicherweise nicht definiert (vor MSBuild 15). Full gibt an, dass MSBuild auf dem Desktop .NET Framework ausgeführt wird, Core, dass MSBuild unter .NET Core ausgeführt wird (z. B. in dotnet build) und Mono, dass MSBuild unter Mono ausgeführt wird.Value may be undefined (prior to MSBuild 15), Full indicating that MSBuild is running on the desktop .NET Framework, Core indicating that MSBuild is running on .NET Core (for example in dotnet build), or Mono indicating that MSBuild is running on Mono. Full
MSBuildStartupDirectory ReserviertReserved Der absolute Pfad des Ordners, in dem MSBuild aufgerufen wird.The absolute path of the folder where MSBuild is called. Wenn Sie diese Eigenschaft verwenden, können Sie alles unterhalb eines bestimmten Punkts in einer Projektstruktur erstellen, ohne <dirs>.proj -Dateien in jedem Verzeichnis zu erstellen.By using this property, you can build everything below a specific point in a project tree without creating <dirs>.proj files in every directory. Stattdessen haben Sie wie hier gezeigt nur ein Projekt, beispielsweise C:\traversal.proj :Instead, you have just one project—for example, c:\traversal.proj , as shown here:

<Project ...> <ItemGroup> <ProjectFiles Include="$ (MSBuildStartupDirectory) **\*.csproj"/> </ItemGroup> <Target Name="build"> <MSBuild Projects="@(ProjectFiles)"/> </Target> </Project>

Geben Sie für die Erstellung an einem beliebigen Punkt in der Struktur Folgendes ein:To build at any point in the tree, type:

msbuild c:\traversal.proj

Schließen Sie nicht den abschließenden umgekehrten Schrägstrich in dieser Eigenschaft ein.Do not include the final backslash on this property.
c:\Source\Repos\ConsoleApp1
MSBuildThisFile ReserviertReserved Der Teil von MSBuildThisFileFullPath, der den Dateinamen und die Dateierweiterung angibt.The file name and file extension portion of MSBuildThisFileFullPath. ConsoleApp1.csproj
MSBuildThisFileDirectory ReserviertReserved Der Teil von MSBuildThisFileFullPath, der das Verzeichnis angibt.The directory portion of MSBuildThisFileFullPath.

Schließen Sie den abschließenden umgekehrten Schrägstrich in den Pfad ein.Include the final backslash in the path.
c:\Source\Repos\ConsoleApp1\ConsoleApp1\
MSBuildThisFileDirectoryNoRoot ReserviertReserved Der Teil von MSBuildThisFileFullPath, der das Verzeichnis angibt, ausschließlich des Stammlaufwerks.The directory portion of MSBuildThisFileFullPath, excluding the root drive.

Schließen Sie den abschließenden umgekehrten Schrägstrich in den Pfad ein.Include the final backslash in the path.
Source\Repos\ConsoleApp1\ConsoleApp1\
MSBuildThisFileExtension ReserviertReserved Der Teil von MSBuildThisFileFullPath, der die Dateinamenerweiterung angibt.The file name extension portion of MSBuildThisFileFullPath. .csproj
MSBuildThisFileFullPath ReserviertReserved Der absolute Pfad des Projekts oder der TARGETS-Datei, die das gerade ausgeführte Ziel enthält.The absolute path of the project or targets file that contains the target that is running.

Tipp: Sie können einen relativen Pfad in einer TARGETS-Datei angegeben, der relativ zur TARGETS-Datei und nicht relativ zur ursprünglichen Projektdatei ist.Tip: You can specify a relative path in a targets file that's relative to the targets file and not relative to the original project file.
c:\Source\Repos\ConsoleApp1\ConsoleApp1\ConsoleApp1.csproj
MSBuildThisFileName ReserviertReserved Der Teil von MSBuildThisFileFullPath, der den Dateinamen angibt, jedoch ohne die Dateinamenerweiterung.The file name portion of MSBuildThisFileFullPath, without the file name extension. ConsoleApp1
MSBuildToolsPath ReserviertReserved Der Installationspfad der MSBuild-Version, die mit dem Wert von MSBuildToolsVersion verknüpft ist.The installation path of the MSBuild version that's associated with the value of MSBuildToolsVersion.

Schließen Sie den abschließenden umgekehrten Schrägstrich nicht in den Pfad ein.Do not include the final backslash in the path.

Diese Eigenschaft kann nicht überschrieben werden.This property cannot be overridden.
C:\Program Files (x86)\Microsoft Visual Studio\2019\Preview\MSBuild\Current\Bin
MSBuildToolsVersion ReserviertReserved Die Version des MSBuild-Toolsets, das zum Erstellen des Projekts verwendet wird.The version of the MSBuild Toolset that is used to build the project.

Hinweis: Ein MSBuild-Toolset besteht aus Aufgaben, Zielen und Tools, die zum Erstellen einer Anwendung verwendet werden.Note: An MSBuild Toolset consists of tasks, targets, and tools that are used to build an application. Zu den Tools zählen Compiler wie csc.exe und vbc.exe.The tools include compilers such as csc.exe and vbc.exe. Weitere Informationen finden Sie unter MSBuild-Toolset (ToolsVersion) sowie unter Standardmäßige und benutzerdefinierte Toolsetkonfigurationen.For more information, see Toolset (ToolsVersion), and Standard and custom Toolset configurations.
Current
MSBuildVersion ReserviertReserved Die Version von MSBuild, die zum Erstellen des Projekts verwendet wird.The version of MSBuild used to build the project.

Diese Eigenschaft kann nicht überschrieben werden. Andernfalls wird die Fehlermeldung MSB4004 - The 'MSBuildVersion' property is reserved, and can not be modified. zurückgegeben.This property can't be overridden, otherwise the error message MSB4004 - The 'MSBuildVersion' property is reserved, and can not be modified. is returned.
16.7.016.7.0

Namen, die Konflikte mit MSBuild-Elementen auslösenNames that conflict with MSBuild elements

Zusätzlich zu den oben genannten können MSBuild-Sprachelemente entsprechende Namen nicht für benutzerdefinierte Eigenschaften, Elemente oder Elementmetadaten verwendet werden:In addition to the above, names corresponding to MSBuild language elements cannot be used for user-defined properties, items, or item metadata:

  • VisualStudioProjectVisualStudioProject
  • TargetTarget
  • PropertyGroupPropertyGroup
  • OutputOutput
  • ItemGroupItemGroup
  • UsingTaskUsingTask
  • ProjectExtensionsProjectExtensions
  • OnErrorOnError
  • ImportGroupImportGroup
  • ChooseChoose
  • WhenWhen
  • OtherwiseOtherwise

Siehe auchSee also