HttpClientConnection.DownloadFile Method

Article
12/03/2008

Downloads data from the resource specified by ServerURL property to a local file.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Sub DownloadFile ( _
    fileName As String, _
    OverwriteDestination As Boolean _
)

public void DownloadFile (
    string fileName,
    bool OverwriteDestination
)

public:
void DownloadFile (
    String^ fileName, 
    bool OverwriteDestination
)

public void DownloadFile (
    String fileName, 
    boolean OverwriteDestination
)

public function DownloadFile (
    fileName : String, 
    OverwriteDestination : boolean
)

Parameters

fileName
The name of the local file into which the downloaded data is stored.

OverwriteDestination
A Boolean that indicates whether to overwrite an existing file, if found. A value of true will overwrite the existing file.

Example

The following code example shows the creation of an HttpClientConnection, sets appropriate values for the download, then calls DownloadFile. The value of the properties require replacment with values that are valid for your application.

const string svcName = "Test_WebService";
string wsdlFile = Directory.GetCurrentDirectory() + @"\WebSvceTask_wsdl.wsdl";

//create HTTP connection
ConnectionManager httpConn = pkg.Connections.Add("HTTP");
HttpClientConnection clientConn = new HttpClientConnection(httpConn.AcquireConnection(null));
clientConn.UseProxy = true;
clientConn.ProxyURL = @"http://yourproxy";
clientConn.BypassProxyOnLocal = true;
clientConn.ServerURL = yourURL;

TaskHost th = (TaskHost)pkg.Executables.Add ("STOCK:WebServiceTask");
WebServiceTask task = (WebServiceTask)th.InnerObject ;

task.Connection = httpConn.Name;
task.ServiceName = svcName;
task.OutputType = DTSOutputType.Variable;
task.OutputLocation = "output";

clientConn.DownloadFile(wsdlFile, false);
task.WsdlFile = wsdlFile;

const String svcName = "Test_WebService"
Dim wsdlFile As String =  Directory.GetCurrentDirectory() + "\WebSvceTask_wsdl.wsdl" 
 
'create HTTP connection
Dim httpConn As ConnectionManager =  pkg.Connections.Add("HTTP") 
Dim clientConn As HttpClientConnection =  New HttpClientConnection(httpConn.AcquireConnection(Nothing)) 
clientConn.UseProxy = True
clientConn.ProxyURL = "http://yourproxy"
clientConn.BypassProxyOnLocal = True
clientConn.ServerURL = yourURL
 
Dim th As TaskHost = CType(pkg.Executables.Add("STOCK:WebServiceTask"), TaskHost)
Dim task As WebServiceTask = CType(th.InnerObject, WebServiceTask)
 
task.Connection = httpConn.Name
task.ServiceName = svcName
task.OutputType = DTSOutputType.Variable
task.OutputLocation = "output"
 
clientConn.DownloadFile(wsdlFile, False)
task.WsdlFile = wsdlFile

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms