Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

FtpClientConnection Class

 

Applies To: SQL Server 2016 Preview

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

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

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

public sealed class FtpClientConnection : DtsObject, IDTSPersist

NameDescription
System_CAPS_pubmethodFtpClientConnection(Object)

Initializes a new instance of the FtpClientConnection class.

NameDescription
System_CAPS_pubpropertyChunkSize

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.

System_CAPS_pubpropertyRetries

Gets or sets the number of times the task attempts an operation. A value of 0 indicates that there is no limit on attempts.

System_CAPS_pubpropertyServerName

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

System_CAPS_pubpropertyServerPassword

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

System_CAPS_pubpropertyServerPort

Gets or sets the port number on the server.

System_CAPS_pubpropertyServerUserName

Gets or sets the logon alias of the user.

System_CAPS_pubpropertyTimeout

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

System_CAPS_pubpropertyUsePassiveMode

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

NameDescription
System_CAPS_pubmethodClose()

Closes the FTP connection.

System_CAPS_pubmethodConnect()

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

System_CAPS_pubmethodCreateRemoteDirectory(String)

Creates a remote directory.

System_CAPS_pubmethodDeleteFiles(String[])

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

System_CAPS_pubmethodDeleteRemoteDirectory(String)

Deletes a remote directory.

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetListing(String[], String[])

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

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGetWorkingDirectory()

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

System_CAPS_pubmethodLoadFromXML(XmlNode, IDTSEvents)

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

System_CAPS_pubmethodReceiveFiles(String[], String, Boolean, Boolean)

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

System_CAPS_pubmethodSaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSendFiles(String[], String, Boolean, Boolean)

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

System_CAPS_pubmethodSetWorkingDirectory(String)

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

System_CAPS_pubmethodToString()

(Inherited from Object.)

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

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

Return to top

Community Additions

Show:
© 2015 Microsoft