DownloadFile Class

Definition

Namespace:

Microsoft.Build.Tasks

Assembly:

Microsoft.Build.Tasks.Core.dll

Package:

Microsoft.Build.Tasks.Core v17.11.4

Source:

DownloadFile.cs

Represents a task that can download a file.

public ref class DownloadFile sealed : Microsoft::Build::Tasks::TaskExtension, Microsoft::Build::Framework::ICancelableTask, Microsoft::Build::Framework::IIncrementalTask

public sealed class DownloadFile : Microsoft.Build.Tasks.TaskExtension, Microsoft.Build.Framework.ICancelableTask, Microsoft.Build.Framework.IIncrementalTask

type DownloadFile = class
    inherit TaskExtension
    interface ICancelableTask
    interface ITask
    interface IIncrementalTask

Public NotInheritable Class DownloadFile
Inherits TaskExtension
Implements ICancelableTask, IIncrementalTask

Inheritance

Object

Task

TaskExtension

DownloadFile

Implements

ICancelableTask ITask IIncrementalTask

Constructors

DownloadFile()

Properties

BuildEngine	The build engine automatically sets this property to allow tasks to call back into it. (Inherited from Task)
BuildEngine2	The build engine automatically sets this property to allow tasks to call back into it. This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2. (Inherited from Task)
BuildEngine3	Retrieves the IBuildEngine3 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine4	Retrieves the IBuildEngine4 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine5	Retrieves the IBuildEngine5 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine6	Retrieves the IBuildEngine6 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine7	Retrieves the IBuildEngine7 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine8	Retrieves the IBuildEngine8 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine9	Retrieves the IBuildEngine9 version of the build engine interface provided by the host. (Inherited from Task)
DestinationFileName	Gets or sets an optional filename for the destination file. By default, the filename is derived from the SourceUrl if possible.
DestinationFolder	Gets or sets a ITaskItem that specifies the destination folder to download the file to.
DownloadedFile	Gets or sets a ITaskItem that contains details about the downloaded file.
FailIfNotIncremental
HelpKeywordPrefix	Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method. (Inherited from Task)
HostObject	The build engine sets this property if the host IDE has associated a host object with this particular task. (Inherited from Task)
Log	This API supports the product infrastructure and is not intended to be used directly from your code. Gets an instance of a TaskLoggingHelperExtension class containing task logging methods. (Inherited from 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	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. (Inherited from Task)
Timeout	Gets or sets the number of milliseconds to wait before the request times out.

Methods

Cancel()	Instructs the task to exit as soon as possible, or to immediately exit if Execute is invoked after this method.
Execute()	This method is called by the build engine to begin task execution. A task uses the return value to indicate whether it was successful. If a task throws an exception out of this method, the engine will automatically assume that the task has failed.