InstallManager.DownloadInstallerFile(InstallerContext, String) Method

Definition

Namespace:

Microsoft.Web.PlatformInstaller

Assembly:

Microsoft.Web.PlatformInstaller.dll

Downloads the installer file using the current installer context.

public:
 bool DownloadInstallerFile(Microsoft::Web::PlatformInstaller::InstallerContext ^ currentInstall, [Runtime::InteropServices::Out] System::String ^ % failureReason);

public bool DownloadInstallerFile(Microsoft.Web.PlatformInstaller.InstallerContext currentInstall, out string failureReason);

member this.DownloadInstallerFile : Microsoft.Web.PlatformInstaller.InstallerContext *  -> bool

Public Function DownloadInstallerFile (currentInstall As InstallerContext, ByRef failureReason As String) As Boolean

Parameters

currentInstall

InstallerContext

An InstallerContext instance that contains information about the installation file to download and associated context.

failureReason

String

Upon failure, this value contains a description of the reason for the download failure.

Returns

Boolean

true if the download completed successfully, otherwise false. Additionally, if this method returns false, the failureReason parameter contains a description of the reason for the failure.

Exceptions

ArgumentNullException

currentInstall is null (Nothing in Visual Basic)

InvalidOperationException

currentInstall.Installer or currentInstall.Installer.InstallerFile is null (Nothing in Visual Basic)