DownloadFile 类

定义

表示可下载文件的任务。Represents a task that can download a file.

public ref class DownloadFile sealed : Microsoft::Build::Tasks::TaskExtension, Microsoft::Build::Framework::ICancelableTask
public sealed class DownloadFile : Microsoft.Build.Tasks.TaskExtension, Microsoft.Build.Framework.ICancelableTask
type DownloadFile = class
    inherit TaskExtension
    interface ICancelableTask
    interface ITask
Public NotInheritable Class DownloadFile
Inherits TaskExtension
Implements ICancelableTask
继承
DownloadFile
实现

构造函数

DownloadFile()

属性

BuildEngine

生成引擎自动设置此属性,以允许任务回调到其中。The build engine automatically sets this property to allow tasks to call back into it.

(继承自 Task)
BuildEngine2

生成引擎自动设置此属性,以允许任务回调到其中。The build engine automatically sets this property to allow tasks to call back into it. 这是一个便捷属性,因此从此类继承的任务作者不必将值从 IBuildEngine 强制转换为 IBuildEngine2。This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

(继承自 Task)
BuildEngine3

检索主机提供的生成引擎接口的 IBuildEngine3 版本。Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

(继承自 Task)
BuildEngine4

检索主机提供的生成引擎接口的 IBuildEngine4 版本。Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

(继承自 Task)
BuildEngine5

检索主机提供的生成引擎接口的 IBuildEngine5 版本。Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

(继承自 Task)
BuildEngine6

检索主机提供的生成引擎接口的 IBuildEngine6 版本。Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

(继承自 Task)
BuildEngine7

获取主机提供的生成引擎接口的版本。Gets the version of the build engine interface provided by the host.

(继承自 Task)
DestinationFileName

获取或设置目标文件的可选文件名。Gets or sets an optional filename for the destination file. 默认情况下,文件名派生自 SourceUrl(如果可能)。By default, the filename is derived from the SourceUrl if possible.

DestinationFolder

获取或设置一个 ITaskItem,用于指定文件要下载到的目标文件夹。Gets or sets a ITaskItem that specifies the destination folder to download the file to.

DownloadedFile

获取或设置一个 ITaskItem,其中包含有关已下载文件的详细信息。Gets or sets a ITaskItem that contains details about the downloaded file.

HelpKeywordPrefix

获取或设置前缀,该前缀用于通过字符串资源名称组成 help 关键字。Gets or sets the prefix used to compose help keywords from string resource names. 如果任务没有与消息关联的 help 关键字,则可以忽略此属性或将其设置为 null。If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. 如果前缀设置为空字符串,则字符串资源名称将逐字用作 help 关键字。If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. 有关如何使用此前缀的示例,请参阅 TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) 方法。For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

(继承自 Task)
HostObject

如果主机 IDE 具有与此特定任务关联的主机对象,则生成引擎会设置此属性。The build engine sets this property if the host IDE has associated a host object with this particular task.

(继承自 Task)
Log

此 API 支持产品基础结构,不能在代码中直接使用。

获取包含任务日志记录方法的 TaskLoggingHelperExtension 类的实例。Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

(继承自 TaskExtension)
Retries

获取或设置可选的重试次数(如果可能)。Gets or sets an optional number of times to retry if possible.

RetryDelayMilliseconds

获取或设置在重试之前等待的毫秒数。Gets or sets the number of milliseconds to wait before retrying.

SkipUnchangedFiles

获取或设置一个可选值,用于指示在文件处于最新状态时,是否应跳过下载。Gets or sets an optional value indicating whether or not the download should be skipped if the file is up-to-date.

SourceUrl

获取或设置要下载的 URL。Gets or sets the URL to download.

TaskResources

获取或设置任务的区域性特定资源。Gets or sets the task's culture-specific resources. 派生类应在构造期间注册资源,如果它们有本地化字符串,则可以通过此属性注册。Derived classes should register their resources either during construction, or via this property, if they have localized strings.

(继承自 Task)

方法

Cancel()
Equals(Object)

确定指定对象是否等于当前对象。Determines whether the specified object is equal to the current object.

(继承自 Object)
Execute()
GetHashCode()

作为默认哈希函数。Serves as the default hash function.

(继承自 Object)
GetType()

获取当前实例的 TypeGets the Type of the current instance.

(继承自 Object)
MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(继承自 Object)
ToString()

返回表示当前对象的字符串。Returns a string that represents the current object.

(继承自 Object)

适用于