Get 任务

更新:2007 年 11 月

Get 任务通过使用指定的选项来检索工作区中文件和文件夹的只读副本。

参数

参数

说明

BuildUri

指定生成 URI。

Workspace

指定工作区名称。

Version

指定文件 versionspec。默认情况下,所使用的 versionspec 是 T 或最新版本。若要获取其他版本,请在 TFSBuild.proj 文件中设置 GetVersion 属性。此行为对应于 tf.exe get 命令的 /version 选项。有关更多信息,请参见 Get 命令

Filespec

指定工作区中的项。默认情况下,Team Foundation Build 将获取由 WorkspaceName 属性指定的工作区中的所有项。若要指定某个特定的 Itemspec,请重写 TFSBuild.proj 文件中的 GetFileSpec 属性。这对应于 tf.exe get 命令的 Itemspec 参数。

PopulateOutput

默认情况下,Team Foundation Build 不会返回检索、替换或删除的项列表,也不会返回由 Get 任务生成的警告。若要使这些列表可用,请将 TFSBuld.proj 文件中的 GetPopulateOutput 属性设置为 true。将 GetPopulateOutput 设置为 true 之后,系统将返回下列信息:

  • 位于 Gets 项组中的检索到的项

  • 位于 Replaces 项组中的被替换的项

  • 位于 Deletes 项组中的已删除的项

  • 位于 GetWarnings 项组中的警告

Preview

指定是否在不实际执行 Get 操作的情况下显示将发生的情况。若要预览 Get 操作,请将 TFSBuild.proj 文件中的 PreviewGet 属性设置为 true。这对应于 tf.exe get 命令的 /preview 选项。

Recursive

指定是否以递归方式检索文件。若要在 Team Foundation Build 项目中执行非递归获取 (Get) 任务,请将 TfsBuild.proj 文件中的 RecursiveGet 属性设置为 false。这对应于 tf.exe get 命令的 /recursive 选项。

Force

指定是否以渐进方式检索文件。若要在 Team Foundation Build 定义中执行渐进式获取 (Get) 任务,请将 TfsBuild.proj 文件中的 ForceGet 属性设置为 false。这对应于 tf.exe get 命令的 /force 选项。

Gets

输出参数。指定通过 Get 任务检索到的项列表。

Replaces

输出参数。指定通过 Get 任务替换的项列表。

Deletes

输出参数。指定通过 Get 任务删除的项列表。

Warnings

输出参数。指定由 Get 任务生成的警告列表。

备注

Get 任务在 Microsoft.TeamFoundation.Build.Tasks.VersionControl.dll 中定义。Microsoft.TeamFoundation.Build.targets 文件包含 Get 任务的一个实例,Team Foundation Build 使用该实例作为 CoreGet 目标的默认实现。

Team Foundation Build 计算机上的 <根>:\Program Files\MSBuild\Microsoft\VisualStudio\TeamBuild 文件夹包含 Microsoft.TeamFoundation.Build.targets 文件。

示例

以下示例显示 Microsoft.TeamFoundation.Build.targets 文件中定义的默认 Get 任务实例。

<Get 
    BuildUri="$(BuildURI)"
    Workspace="$(WorkspaceName)"
    Version="$(GetVersion)"
    Filespec="$(GetFilespec)"
    PopulateOutput="$(GetPopulateOutput)" 
    Preview="$(PreviewGet)"
    Recursive="$(RecursiveGet)"
    Force="$(ForceGet)">
  <Output TaskParameter="Gets" ItemName="Gets" />
  <Output TaskParameter="Replaces" ItemName="Replaces" />
  <Output TaskParameter="Deletes" ItemName="Deletes" />
  <Output TaskParameter="Warnings" ItemName="GetWarnings" />
</Get>

请参见

任务

如何:自定义内部版本号

概念

Team Foundation Build 任务

参考

Get 命令

其他资源

自定义 Team Foundation Build

Team Foundation Build 目标、任务和属性