Share via

  • Article

FtpClientConnection.ChunkSize Property

Gets or sets the value that indicates the minimum number of bytes to retrieve from or send to the server during a File Transfer Protocol (FTP) read/write operation.

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

Syntax

'Declaration
Public Property ChunkSize As Integer
    Get
    Set
'Usage
Dim instance As FtpClientConnection
Dim value As Integer

value = instance.ChunkSize

instance.ChunkSize = value

public int ChunkSize { get; set; }

public:
property int ChunkSize {
    int get ();
    void set (int value);
}

member ChunkSize : int with get, set

function get ChunkSize () : int
function set ChunkSize (value : int)

Property Value

Type: System.Int32
An Integer that contains the minimum number of bytes to retrieve or send.

Remarks

Reading or writing in small chunks causes a less optimized round trip to the server because a full packet is not received or sent. The default value is 1 KB. The maximum value is 1000 KB (1 MB).

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