ToolTaskExtension 基类
很多任务从 ToolTaskExtension 类继承,该类从 ToolTask 类继承,而后者本身又从 Task 类继承。 此继承链给任务添加几个派生自它们的参数。 此本文档中列出了这些参数。
参数
下表描述了基类的参数。
Parameter |
说明 |
---|---|
可选 IBuildEngine 参数。 指定任务可用的生成引擎接口。 生成引擎自动设置此参数,以允许任务回调此生成引擎。 |
|
可选 IBuildEngine2 参数。 指定任务可用的生成引擎接口。 生成引擎自动设置此参数,以允许任务回调此生成引擎。 这是一个便捷属性,以便从该类进行继承的任务作者不必将该值从 IBuildEngine 强制转换为 IBuildEngine2。 |
|
可选 IBuildEngine3 参数。 指定由主机提供的生成引擎接口。 |
|
可选 bool 参数。 如果设置为 true,则此任务将 /Q 传递给 cmd.exe 命令行,以使该命令行不会复制到 stdout。 |
|
可选 String 数组参数。 等号分隔的环境变量对的数组。 除了将这些变量传递到生成的可执行文件,还有选择地重写常规环境块。 |
|
可选 Int32 只读输出参数。 指定由执行的命令提供的退出代码。 如果该任务记录了任何错误,但是该进程有退出代码 0(成功),则这将设置为 -1。 |
|
可选 ITaskHost 参数。 指定主机对象实例(可以为 null)。 如果宿主 IDE 已将某个宿主对象与该特定任务关联,则由生成引擎设置此属性。 |
|
可选 TaskLoggingHelper 只读参数。 获取包含任务记录方法的 TaskLoggingHelperExtension 类的实例。 |
|
选项 bool 参数。 如果为 true,则应将在标准错误流中收到的所有消息作为错误来记录。 |
|
可选 String 参数。 关于记录标准输出流的文本的重要性。 |
|
可选 String 参数。 关于记录标准输出流的文本的重要性。 |
|
可选虚拟 Int32 参数。 指定在多少毫秒后终止任务可执行文件。 默认值为 Int.MaxValue,这表示没有超时期限。超时以毫秒为单位。 |
|
可选虚拟 string 参数 项目可以实现此值以重写 ToolName。 任务可以重写此项以保留 ToolName。 |
|
可选 string 参数。 指定任务将从什么位置加载基础可执行文件。 如果未指定此参数,任务将使用与运行 MSBuild 的 Framework 版本对应的 SDK 安装路径。 |
|
可选 bool 参数。 如果设置为 true,则此任务创建一个命令行批处理文件,并使用命令处理器(而不直接执行命令)来执行它。 |
|
可选 bool 参数。 设置为 true 时,此任务会生成节点(如果其任务正在执行)。 |