FtpClientConnection Class

Definition

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

public ref class FtpClientConnection sealed : Microsoft::SqlServer::Dts::Runtime::DtsObject, Microsoft::SqlServer::Dts::Runtime::IDTSPersist
public sealed class FtpClientConnection : Microsoft.SqlServer.Dts.Runtime.DtsObject, Microsoft.SqlServer.Dts.Runtime.IDTSPersist
type FtpClientConnection = class
    inherit DtsObject
    interface IDTSPersist
Public NotInheritable Class FtpClientConnection
Inherits DtsObject
Implements IDTSPersist
Inheritance
FtpClientConnection
Implements

Remarks

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

Constructors

FtpClientConnection(Object)

Initializes a new instance of the FtpClientConnection class.

Properties

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.

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.

ServerName

Gets or sets the name of the File Transfer Protocol (FTP) server.

ServerPassword

Sets the password for the server specified in the ServerName property. This property is write-only.

ServerPort

Gets or sets the port number on the server.

ServerUserName

Gets or sets the logon alias of the user.

Timeout

Gets or sets a value that indicates how long to attempt the connection before timing out.

UsePassiveMode

Gets or sets a Boolean that indicates whether the task sends and receives files in passive mode.

Methods

Close()

Closes the FTP connection.

Connect()

Opens the connection to the server and returns a value that indicates the result of the connection.

CreateRemoteDirectory(String)

Creates a remote directory.

DeleteFiles(String[])

Deletes the specified files from the File Transfer Protocol (FTP) server.

DeleteRemoteDirectory(String)

Deletes a remote directory.

Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
GetListing(String[], String[])

Lists the names of directories and files in the specified folder or directory from the FTP server.

GetWorkingDirectory()

Gets the current working directory on the File Transfer Protocol (FTP) server.

LoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.

ReceiveFiles(String[], String, Boolean, Boolean)

Receives files from the File Transfer Protocol (FTP) server.

SaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

SendFiles(String[], String, Boolean, Boolean)

Sends files to the File Transfer Protocol (FTP) server.

SetWorkingDirectory(String)

Sets the current working directory on the File Transfer Protocol (FTP) server.

Applies to