MSBuild 保留属性和已知属性

  • 项目

MSBuild 提供了一组预定义的属性，这些属性存储有关项目文件和 MSBuild 二进制文件的信息。 这些属性的计算方式与其他 MSBuild 属性相同。 例如，要使用 MSBuildProjectFile 属性，应键入 $(MSBuildProjectFile)。

MSBuild 使用下表中的值预定义保留的属性和已知的属性。 无法重写保留的属性，但可以使用名称相同的环境属性、全局属性或已在项目文件中声明的属性重写已知的属性。

保留的属性和已知的属性

下表介绍了 MSBuild 预定义的属性。

属性

描述

保留或已知

MSBuildBinPath

当前正在使用的 MSBuild 二进制文件所在文件夹的绝对路径（例如，C:\Windows\Microsoft.Net\Framework\versionNumber）。 如果你必须引用 MSBuild 目录中的文件，此属性将非常有用。

不要在此属性上添加最终反斜杠。

保留

MSBuildExtensionsPath

在 .NET Framework 4 中引入：MSBuildExtensionsPath 和 MSBuildExtensionsPath32 的默认值之间没有差异。 你可以设置环境变量 MSBUILDLEGACYEXTENSIONSPATH 为非 null 值，以启用早期版本中的 MSBuildExtensionsPath的默认值的行为。

在 .NET Framework 3.5 和较早的版本中，MSBuildExtensionsPath 的默认值指向位于 \Program Files 或 \Program Files (x86) 文件夹下的 MSBuild 子文件夹路径，取决于当前进程的位数。 例如，对于在 64 位计算机上的 32 位进程，此属性指向 \Program Files (x86) 文件夹。 对于在 64 位计算机上的 64 位进程，此属性指向 \Program Files 文件夹。

不要在此属性上添加最终反斜杠。

此位置用于存放自定义目标文件。 例如，你的目标文件可能安装在 \Program Files\MSBuild\MyFiles\Northwind.targets 中，然后使用此 XML 代码导入到项目文件中：

<Import Project="$(MSBuildExtensionsPath)\MyFiles\Northwind.targets"/>

已知

MSBuildExtensionsPath32

位于 \Program Files 或 \Program Files (x86) 文件夹下的 MSBuild 子文件夹的路径。 此路径始终指向 32 位计算机上的 32 位 \Program Files 文件夹和 64 位计算机上的 \Program Files (x86)。 另请参见 MSBuildExtensionsPath 和 MSBuildExtensionsPath64。

不要在此属性上添加最终反斜杠。

已知

MSBuildExtensionsPath64

位于 \Program Files 文件夹下的 MSBuild 子文件夹的路径。 对于 64 位计算机，此路径始终指向 \Program Files 文件夹。 对于 32 位计算机，此路径为空。 另请参见 MSBuildExtensionsPath 和 MSBuildExtensionsPath32。

不要在此属性上添加最终反斜杠。

已知

MSBuildLastTaskResult

true，如果前一项任务完成没有出现任何错误（即使有警告）；否则如果前一项任务出现错误，则为 false。 通常，当任务中出现错误时，错误会发生在项目的最后。 因此，此属性的值决不会是 false，但以下情况除外：

保留

MSBuildNodeCount

生成过程中使用的并发进程的最大数目。 这是你在命令行处为 /maxcpucount 指定的值。 如果在没有指定值的情况下指定了 /maxcpucount，则 MSBuildNodeCount 将指定计算机中的处理器数量。 有关详细信息，请参阅MSBuild 命令行参考和用 MSBuild 并行生成多个项目。

保留

MSBuildProgramFiles32

32 位程序文件夹的位置；例如 C:\Program Files (x86)。

不要在此属性上添加最终反斜杠。

保留

MSBuildProjectDefaultTargets

DefaultTargets 元素的 Project 特性中指定的目标的完整列表。 例如，下面的 Project 元素的 MSBuildDefaultTargets 属性值为 A;B;C：

<Project DefaultTargets="A;B;C" >

保留

MSBuildProjectDirectory

项目文件所在目录的绝对路径，例如 C:\MyCompany\MyProduct。

不要在此属性上添加最终反斜杠。

保留

MSBuildProjectDirectoryNoRoot

MSBuildProjectDirectory 属性的值，但不包括根驱动器。

不要在此属性上添加最终反斜杠。

保留

MSBuildProjectExtension

项目文件的文件扩展名（包括点号）；例如，.proj。

保留

MSBuildProjectFile

项目文件的完整文件名（包括文件扩展名）；例如，MyApp.proj。

保留

MSBuildProjectFullPath

项目文件的绝对路径和完整文件名（包括文件名扩展），例如，C:\MyCompany\MyProduct\MyApp.proj。

保留

MSBuildProjectName

项目文件的文件名（不包括文件扩展名）；例如，MyApp。

保留

MSBuildStartupDirectory

在其中调用 MSBuild 的文件夹的绝对路径。 通过使用此属性，你无需在每个目录中都创建 dirs.proj 文件就可以在项目树中的某个特定点下生成所有内容。 而你只有一个项目，例如 c:\traversal.proj（如此处所示）：

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

若要在该树中的任意一点生成，请键入：

msbuild c:\traversal.proj

不要在此属性上添加最终反斜杠。

保留

MSBuildThisFile

MSBuildThisFileFullPath 的文件名和文件扩展名部分。

保留

MSBuildThisFileDirectory

MSBuildThisFileFullPath 的目录部分。

将最终反斜杠包括在路径中。

保留

MSBuildThisFileDirectoryNoRoot

MSBuildThisFileFullPath 的目录部分不包括根驱动器。

将最终反斜杠包括在路径中。

保留

MSBuildThisFileExtension

MSBuildThisFileFullPath的文件扩展名部分。

保留

MSBuildThisFileFullPath

项目或包含正在运行目标的目标文件的绝对路径。

提示

你可指定在相对于目标文件而不是相对于原始项目文件的目标文件中的相对路径。

保留

MSBuildThisFileName

MSBuildThisFileFullPath 的文件名部分，不包含文件扩展名。

保留

MSBuildToolsPath

与 MSBuildToolsVersion的值相关联的 MSBuild 版本的安装路径。

不要将最终的反斜杠包含在路径中。

不能重写此属性。

保留

MSBuildToolsVersion

用于生成项目的 MSBuild 工具集版本。

备注

包含用于生成应用程序的任务、目标和工具的 MSBuild 工具集。工具包括编译器例如 csc.exe 和 vbc.exe。有关详细信息，请参阅 MSBuild 工具集 (ToolsVersion) 和标准和自定义工具集配置。

保留

请参见

概念

MSBuild 属性

其他资源

MSBuild 参考