FtpClientConnection(Object) Constructor

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Initializes a new instance of the FtpClientConnection class.

public:
 FtpClientConnection(System::Object ^ unmanagedObject);

public FtpClientConnection (object unmanagedObject);

new Microsoft.SqlServer.Dts.Runtime.FtpClientConnection : obj -> Microsoft.SqlServer.Dts.Runtime.FtpClientConnection

Public Sub New (unmanagedObject As Object)

Parameters

unmanagedObject

Object

The unmanaged connection object to create as a managed FTP task.

Examples

The most common method of creating the FTP client connection is by using the ConnectionManager. The InnerObject contains the connection, and all properties of the specific connection contained by the ConnectionManager are accessible through the Properties collection. The following code example shows the creation of an FTP connection using the connection manager, and sets properties using the Properties collection.

using System;  
using System.Collections.Generic;  
using System.Text;  
using Microsoft.SqlServer.Dts.Runtime;  
using Microsoft.SqlServer.Dts.Tasks.FileSystemTask;  

namespace Microsoft.SqlServer.SSIS.Samples  
{  
    class mySqlServer_Sample  
    {  
        static void Main(string[] args)  
        {  
            Package pkg = new Package();  
            FtpClientConnection ftp = null;  
            Connections conns = pkg.Connections;  
            ConnectionManager cm = conns.Add("FTP");  

            // Display the default values of the FTP connection properties.  
            // Some properties are not shown as they are write-only.  
            Console.WriteLine("ChunkSize:      {0}", cm.Properties["ChunkSize"].GetValue(cm));  
            Console.WriteLine("Retries:        {0}", cm.Properties["Retries"].GetValue(cm));  
            Console.WriteLine("ServerName:     {0}", cm.Properties["ServerName"].GetValue(cm));  
            Console.WriteLine("ServerPort:     {0}", cm.Properties["ServerPort"].GetValue(cm));  
            Console.WriteLine("ServerUserName: {0}", cm.Properties["ServerUserName"].GetValue(cm));  
            Console.WriteLine("Timeout:        {0}", cm.Properties["Timeout"].GetValue(cm));  
            Console.WriteLine("UsePassiveMode: {0}",cm.Properties["UsePassiveMode"].GetValue(cm));  

            Console.WriteLine();  
        }  
    }  
}  

Imports System  
Imports System.Collections.Generic  
Imports System.Text  
Imports Microsoft.SqlServer.Dts.Runtime  
Imports Microsoft.SqlServer.Dts.Tasks.FileSystemTask  

Namespace Microsoft.SqlServer.SSIS.Samples  
    Class mySqlServer_Sample  
        Shared  Sub Main(ByVal args() As String)  
            Dim pkg As Package =  New Package()   
            Dim ftp As FtpClientConnection =  Nothing   
            Dim conns As Connections =  pkg.Connections   
            Dim cm As ConnectionManager =  conns.Add("FTP")   

            ' Display the default values of the FTP connection properties.  
            ' Some properties are not shown as they are write-only.  
            Console.WriteLine("ChunkSize:      {0}", cm.Properties("ChunkSize").GetValue(cm))  
            Console.WriteLine("Retries:        {0}", cm.Properties("Retries").GetValue(cm))  
            Console.WriteLine("ServerName:     {0}", cm.Properties("ServerName").GetValue(cm))  
            Console.WriteLine("ServerPort:     {0}", cm.Properties("ServerPort").GetValue(cm))  
            Console.WriteLine("ServerUserName: {0}", cm.Properties("ServerUserName").GetValue(cm))  
            Console.WriteLine("Timeout:        {0}", cm.Properties("Timeout").GetValue(cm))  
            Console.WriteLine("UsePassiveMode: {0}",cm.Properties("UsePassiveMode").GetValue(cm))  

            Console.WriteLine()  
        End Sub  
    End Class  
End Namespace  

Sample Output:

ChunkSize: 1

Retries: 5

ServerName:

ServerPort: 21

ServerUserName:

Timeout: 60

UsePassiveMode: False

Remarks

Creates a managed FTP task.