• Article

FtpClientConnection Class

Downloads and uploads data files and manages directories on servers. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.FtpClientConnection

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

Syntax

'Declaration
Public NotInheritable Class FtpClientConnection _
    Inherits DtsObject _
    Implements IDTSPersist
'Usage
Dim instance As FtpClientConnection

public sealed class FtpClientConnection : DtsObject, 
    IDTSPersist

public ref class FtpClientConnection sealed : public DtsObject, 
    IDTSPersist

[<SealedAttribute>]
type FtpClientConnection =  
    class
        inherit DtsObject
        interface IDTSPersist
    end

public final class FtpClientConnection extends DtsObject implements IDTSPersist

The FtpClientConnection type exposes the following members.

Constructors

  Name Description
Public method FtpClientConnection Initializes a new instance of the FtpClientConnection class.

Top

Properties

  Name Description
Public property ChunkSize 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.
Public property Retries Gets or sets the number of times the task attempts an operation. A value of 0 indicates that there is no limit on attempts.
Public property ServerName Gets or sets the name of the File Transfer Protocol (FTP) server.
Public property ServerPassword Sets the password for the server specified in the ServerName property. This property is write-only.
Public property ServerPort Gets or sets the port number on the server.
Public property ServerUserName Gets or sets the logon alias of the user.
Public property Timeout Gets or sets a value that indicates how long to attempt the connection before timing out.
Public property UsePassiveMode Gets or sets a Boolean that indicates whether the task sends and receives files in passive mode.

Top

Methods

  Name Description
Public method Close Closes the FTP connection.
Public method Connect Opens the connection to the server and returns a value that indicates the result of the connection.
Public method CreateRemoteDirectory Creates a remote directory.
Public method DeleteFiles Deletes the specified files from the File Transfer Protocol (FTP) server.
Public method DeleteRemoteDirectory Deletes a remote directory.
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetListing Lists the names of directories and files in the specified folder or directory from the FTP server.
Public method GetType (Inherited from Object.)
Public method GetWorkingDirectory Gets the current working directory on the File Transfer Protocol (FTP) server.
Public method LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected method MemberwiseClone (Inherited from Object.)
Public method ReceiveFiles Receives files from the File Transfer Protocol (FTP) server.
Public method SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public method SendFiles Sends files to the File Transfer Protocol (FTP) server.
Public method SetWorkingDirectory Sets the current working directory on the File Transfer Protocol (FTP) server.
Public method ToString (Inherited from Object.)

Top

Remarks

For more information about the FTP task, see FTP Connection Manager.

Thread Safety

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