- Licensing and How to Order
- Installation Instruction
- Overview and how to use Ultimate Ftp in Visual Studio
- Connect to an FTP server
- Authentication
- Upload and download a single file
- Upload and download multiple files
- Manage a single remote file
- Manage multiple remote files and directories
- Upload and download a directory
- Directory synchronization
- Manage a remote directory
- Other FTP features
- Control bandwidth and speed optimization
- Events
- Logging
- Use path utility methods
ComponentPro UltimateFtp
ComponentPro.Net.Ftp Methods
See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
For a list of all members of this type, see Ftp members.
Top
Public Methods
| Name | Description | |
|---|---|---|
 | AppendFile | Overloaded. Appends the content of the specified data stream to the file on the remote FTP server. |
| AppendFileAsync | Overloaded. Appends the content of the data stream to the file on the server. |
| Authenticate | Overloaded. Authenticates the user to the FTP server to which it is connected using the specified username and password. |
| AuthenticateAsync | Overloaded. Begins an asynchronous operation to authenticate the user to the FTP server. |
 | CalculateTimeDiff | Calculates the time difference between the source and the dest file systems. (Inherited from FileSystem) |
| Cancel | Overloaded. Overridden. Cancels the current operation. |
| ClearCommandChannel | Clears the command channel after login to facilitate firewall NAT when connecting using a secure data channel. This method reverts the protected control connection back to plaintext connection. |
| ClearCommandChannelAsync | Overloaded. Begins an asynchronous operation to send CCC command to the server. Reverts the protected control connection back to plaintext connection. |
| CombinePath | Combines two path strings. (Inherited from FileSystem) |
| Connect | Overloaded. Connects to the FTP server. |
| ConnectAsync | Overloaded. Initiates an asynchronous operation to an FTP server. |
| CopyFrom | Copies data in a stream to the specified destination file on this system. (Inherited from FileSystem) |
| CopyFromAsync | Asynchronously copies data in a stream to the specified destination file on this system. (Inherited from FileSystem) |
| CopyTo | Copies a file from this file system to another file system. (Inherited from FileSystem) |
| CopyToAsync | Asynchronously copies a file from this file system to another file system. (Inherited from FileSystem) |
| CreateDirectory | Overridden. Create a directory on the FTP server. |
| CreateDirectoryAsync | Begins an asynchronous CreateDirectory operation. Creates an empty directory. (Inherited from FileSystem) |
| CreateFileInfo | Overloaded. Overridden. Creates a new instance of the FtpFileInfo class and set appropriate file information. |
| Delete | Deletes files or directories and, if indicated, any subdirectories matching the specified search condition on the filesToDelete list. (Inherited from FileSystem) |
| DeleteAsync | Asynchronously deletes files or directories and, if indicated, any subdirectories matching the specified search condition on the filesToDelete list. This method only deletes the items in the specified directory if the baseDirectoryPath parameter does not end with a directory separator (e.g. '/' or '\'). To remove the whole directory, you should add a directory separator character at the end of that parameter. (Inherited from FileSystem) |
| DeleteDirectory | Overloaded. Overridden. Deletes an empty directory from the FTP server. To delete a directory containing files and subdirectories, use the DeleteDirectory method. |
| DeleteDirectoryAsync | Asynchronously deletes the specified directory and, if indicated, any subdirectories and files in the directory. (Inherited from FileSystem) |
| DeleteFile | Overloaded. Overridden. Deletes the specified file on the remote FTP server. |
| DeleteFileAsync | Asynchronously deletes the specified file. (Inherited from FileSystem) |
| DirectoryExists | Overridden. Checks whether the specified directory exists on the server. Not all FTP servers support this! |
| DirectoryExistsAsync | Asynchronously detects whether the specified directory exists on the file system. (Inherited from FileSystem) |
| Disconnect | Disconnects the FTP client from the FTP server to which it is connected. |
| DisconnectAsync | Overloaded. Begins an asynchronous operation to inform the server that the connection is about to close and terminates the connection. |
| Dispose | Releases all used resources. (Inherited from FileSystem) |
| Download | Overloaded. Downloads the content of the specified remote file or directory to the destination directory using multiple threads. |
| DownloadAsync | Overloaded. Asynchronously downloads files from the specified remote directory to the local directory. This method only downloads the items in the specified directory if the remotePath parameter does not end with a directory separator (e.g. '/'). To also create the directory in the destination, add a directory separator character at the end of that parameter. |
| DownloadFile | Overloaded. Download a file from an the server, overriding it if it already exists. |
| DownloadFileAsync | Overloaded. Downloads the remote file to the data stream. |
| EnsuresDirectoryCreated | Ensures the specified directory exists on the file system. If the specified directory does not exist, a new one is to be created. (Inherited from FileSystem) |
| FileExists | Overloaded. Overridden. Checks whether the specified file exists on the server. |
| FileExistsAsync | Asynchronous detects whether the specified file exists on the file system. (Inherited from FileSystem) |
| Flush | Reads and returns control connection data, if available. |
| FlushAsync | Overloaded. Begins an asynchronous operation to reads and returns control connection data, if available. |
| GetCommonChecksumAlgorithms | Gets checksum algorithms that both file system have in common. (Inherited from FileSystem) |
| GetConnectionState | Checks to see if the current connection is still active and returns error if any. |
| GetCurrentDirectory | Overridden. Retrieves the current working directory of the FTP server. |
| GetCurrentDirectoryAsync | Asynchronously gets the current working directory of the file system. (Inherited from FileSystem) |
| GetDirectoryName | Returns the directory information for the specified path string. (Inherited from FileSystem) |
| GetDirectorySize | Returns total size of the specified directories. (Inherited from FileSystem) |
| GetDirectorySizeAsync | Asynchronously calculates total size of the specified directory. (Inherited from FileSystem) |
| GetDownloadStream | Overloaded. Retrieves a direct access to the read-only data stream being received. |
| GetDownloadStreamAsync | Overloaded. Asynchronously returns a Stream for reading data from the remote file. |
| GetFileChecksum | Returns the checksum of the specified file. (Inherited from FileSystem) |
| GetFileChecksumAsync | Begins an asynchronous GetFileChecksum operation. Retrieves the checksum of the specified file. (Inherited from FileSystem) |
| GetFileLength | Overridden. Gets the size of the specified remote file. |
| GetFileLengthAsync | Asynchronously retrieves the size of the specified file. (Inherited from FileSystem) |
| GetFileName | Returns the file name and extension of the specified path string. (Inherited from FileSystem) |
| GetFullPath | Returns a full path of the specified path. (Inherited from FileSystem) |
| GetItemInfo | Overridden. Returns an FtpFileInfo object containing information of the specified file. |
| GetItemInfoAsync | Asynchronously retrieves a FileInfoBase containing the information about the specified file or directory. (Inherited from FileSystem) |
| GetLastWriteTime | Overridden. Returns the date and time the specified remote file or directory was last written to. Some servers return times in their local time zones, some use GMT and some do not support this feature. |
| GetLastWriteTimeAsync | Asynchronous retrieves the modification date and time of the specified file. (Inherited from FileSystem) |
| GetServerTimeDifference | Returns the time difference between the client and server. |
| GetServerTimeDifferenceAsync | Overloaded. Initiates an asynchronous operation to get the time difference between the client and server. Not all FTP servers support this! |
| GetSupportedChecksumTypes | Overridden. Returns checksum types supported by the server. |
| GetSystemName | Returns the name of the remote OS. |
| GetSystemNameAsync | Overloaded. Returns the name of the remote OS. |
| GetUploadStream | Overloaded. Retrieves a direct access to the write-only data stream to send to. |
| GetUploadStreamAsync | Overloaded. Begins an asynchronous operation to return a Stream for writing data to the remote file. |
| IsCanceling | Returns a boolean value indicating whether user has called the Cancel method. (Inherited from FileSystem) |
| IsFatalError | Returns a boolean value indicating whether the specified error indicates that the client should reconnect to the server. |
| IsPathRooted | Gets a value indicating whether the specified path string contains absolute or relative path information. (Inherited from FileSystem) |
| KeepAlive | Sends a NOOP command to the server to keep the connection alive. Some servers ignore the NOOP command. |
| KeepAliveAsync | Overloaded. Begins an asynchronous operation to send a command or data packet to the server to keep the connection alive. |
| ListDirectory | Overloaded. Overridden. Lists all files and subdirectories in the current working directory. |
| ListDirectoryAsync | Asynchronously retrieves the list of files and directories in the specified directory. (Inherited from FileSystem) |
| ListName | Overloaded. Overridden. Returns a list of file and directory names in the current working directory. Using ListDirectory is a better choice in most cases. |
| ListNameAsync | Begins an asynchronous ListName operation. Retrieves the list of file and directory names in the current directory. (Inherited from FileSystem) |
| ListRawName | Overloaded. Retrieves an unprocessed, clear text list representing the entire contents of the current working directory as sent by the FTP server. Using ListDirectory is a better choice in most cases. |
| ListRawNameAsync | Overloaded. Begins an asynchronous ListRawName operation. Retrieves the list of files and directories in the specified directory using a raw text format. |
| Move | Moves files that match the search condition specified in the options parameter from the specified directory to the destination directory using multiple threads. This method only moves the items of the specified directory if the sourcePath parameter does not end with a directory separator (e.g. '/' or '\'). To move the whole directory, use the Rename method instead. (Inherited from FileSystem) |
| MoveAsync | Asynchronously moves files that match the search condition specified in the options parameter from the specified directory to the destination directory on this file system. This method only moves the items of the specified directory if the sourcePath parameter does not end with a directory separator (e.g. '/' or '\'). To move the whole directory, use the Rename method instead. (Inherited from FileSystem) |
| MultiPartDownload | Overloaded. Downloads a file on the server and writes to the specified local file using multiple threads. |
| NormalizePath | Normalizes a path. This method normalizes path like "\my folder\\my sub folder/sub folder/\my file" to "/my folder/my sub folder/sub folder/my file" if directory separator character is '/'. (Inherited from FileSystem) |
| QuickSynchronize | Synchronizes the specified local directory with the specified source directory with the specified options. (Inherited from FileSystem) |
| QuickSynchronizeAsync | Initiates an asynchronous operation to synchronize contents of a source directory and a local directory. (Inherited from FileSystem) |
| ReadResponse | Returns the response of the FTP server to the command that was sent previously. |
| ReadResponseAsync | Overloaded. Begins an asynchronous operation to return the server response. |
| Reinitialize | Terminates the USER session and purge all account information. The session will be reset to the default settings and the connection is left open. |
| ReinitializeAsync | Overloaded. Initiates an asynchronous operation to terminate the USER session and purge all account information. The session will be reset to the default settings and the connection is left open. |
| RemoteCopy | Copies a file on this FTP server to another server specified in the destinationFtpServer parameter using direct server-to-server transfer, also known as FXP. |
| RemoteCopyAsync | Overloaded. Starts an asynchronous copy a file on this FTP server to another server specified in the destinationFtpServer parameter using direct server-to-server transfer, also known as FXP. |
| Rename | Overridden. Renames a file or directory on the FTP server. |
| RenameAsync | Begins an asynchronous Rename operation. Renames a file or directory on the file system. (Inherited from FileSystem) |
| ResumeDownloadFile | Overloaded. Resumes download the content of the remote file to the previously interrupted local file. |
| ResumeDownloadFileAsync | Overloaded. Resumes download the content of the data stream to the previously interrupted remote file. |
| ResumeUploadFile | Overloaded. Resumes uploading the content of the data stream to the previously interrupted remote file. |
| ResumeUploadFileAsync | Overloaded. Initiates an asynchronous operation to resume uploading the content of the data stream to the previously interrupted remote file. |
| Search | Searches for files and directories that match the specified search pattern, if specified, in the directoryPath. (Inherited from FileSystem) |
| SearchAsync | Searches for files and directories that match the specified search conditions. (Inherited from FileSystem) |
| SendCommand | Sends a custom command to the FTP server. |
| SendCommandAsync | Overloaded. Begins an asynchronous operation to execute a command on the FTP server. |
| SetActiveTransferType | Sets active transfer type. |
| SetCurrentDirectory | Overridden. Changes the current folder of the FTP server. |
| SetCurrentDirectoryAsync | Begins an asynchronous SetCurrentDirectory operation. (Inherited from FileSystem) |
| SetFilePermissions | Overloaded. Sets the permissions of the specified remote file. Not all FTP servers support this operation. |
| SetFilePermissionsAsync | Overloaded. Initiates an asynchronous operation to set the permissions of the specified remote file. Not all FTP servers support this! |
| SetLastWriteTime | Overridden. Sets the date and time at which the specified file was last written.Some servers do not support this feature. |
| SetLastWriteTimeAsync | Begins an asynchronous SetLastWriteTime operation. Sets the modification date and time of the specified file. (Inherited from FileSystem) |
| SetMultipleFilesPermissions | Overloaded. Sets the permissions of the specified remote files. Not all FTP servers support this operation. |
| SetMultipleFilesPermissionsAsync | Overloaded. Initiates an asynchronous operation to set the permissions of the specified remote files. Not all FTP servers support this! |
| SetSocketFactory | Sets the socket factory to be used to create communication sockets. |
| Site | Executes site-specific command and returns the response. |
| SiteAsync | Overloaded. Executes site-specific command and returns the response. |
| ToString | Overridden. Returns a string representation of this object. |
| TransferFiles | Transfers files from the specified source file system to the specified destination file system. (Inherited from FileSystem) |
| TransferFilesAsync | Asynchronously transfers files from the specified source file system to the specified destination file system. (Inherited from FileSystem) |
| UpgradeConnection | Secures the connection with TLS/SSL. |
| UpgradeConnectionAsync | Overloaded. Begins an asynchronous operation to secures the connection with TLS/SSL using the specified upgrade request type and security parameters. |
| Upload | Overloaded. Uploads files from the specified source directory on the specified source file system to the specified remote directory using multiple threads. |
| UploadAsync | Overloaded. Asynchronously uploads files from the specified local directory to the remote directory. This method only uploads the items in the specified directory if the localPath parameter does not end with a directory separator (e.g. '\' or '/'). To also create the directory in the destination, add a directory separator character at the end of that parameter. |
| UploadFile | Overloaded. Uploads from the current position in the specified source stream and writes to the destination file on the server. |
| UploadFileAsync | Overloaded. Begins an asynchronous operation to upload the content of the data stream to the file on the server. |
| UploadUniqueFile | Overloaded. Uploads the data from the specified Stream to the FTP server and stores it using a unique filename. Many servers do not support this feature, and many servers support this incorrectly, such as MS FTP. |
| UploadUniqueFileAsync | Overloaded. Begins an asynchronous operation to upload the content of the data stream to the file with unique pathname on the server. |
Protected Methods
Top
