The FileTransferClient type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
  | FileTransferClient |
Creates new instance of FileTransferClient class.
|
Methods
| Name | Description | |
|---|---|---|
| Abort |
Abort pending operations.
|
| Connect(String, FileTransferMode) |
Connects to the server using chosen protocol.
|
| Connect(String, Int32, FileTransferMode) |
Connects to the server using chosen protocol.
|
| CreateDirectory |
Creates a directory on the server.
|
| Delete(FileSet) |
Deletes specified files and/or directories on the server.
|
| Delete(String, TraversalMode) |
Deletes specified files and/or directories on the server. Accepts wildcards.
|
| DeleteFile |
Deletes a file on the server.
|
| DirectoryExists |
Detects whether the specified directory exists on the server.
|
| Disconnect |
Informs the server that the connection is about to close and
terminates the connection.
|
| Dispose |
Disposes the object. After calling this the inner instance will be disposed as well and Inner will be set to null.
|
| Download(String, String) |
Downloads the specified file or directory hierarchy from the server to the local directory. Accepts wildcards.
|
| Download(FileSet, String) |
Downloads the specified files and/or directories from the server to the local directory.
|
| Download(String, String, TraversalMode) |
Downloads the specified file or directory hierarchy from the server to the local directory. Accepts wildcards.
|
| Download(FileSet, String, TransferMethod, ActionOnExistingFiles) |
Downloads the specified files and/or directories from the server to the local directory.
|
| Download(String, String, TraversalMode, TransferMethod, ActionOnExistingFiles) |
Downloads the specified file or directory hierarchy from the server to the local directory. Accepts wildcards.
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FileExists |
Detects whether the specified file exists on the server.
|
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetCurrentDirectory |
Gets the absolute path of the current working directory on the remote server.
|
| GetDownloadStream(String) |
Returns a Stream for reading data from the remote file.
|
| GetDownloadStream(String, SeekOrigin, Int64) |
Returns a Stream for reading data from the remote file.
|
| GetFile(String, Stream) |
Downloads the remote file to the data stream.
|
| GetFile(String, String) |
Downloads the remote file to the local file, overriding it if it already exists.
|
| GetFile(String, Stream, Int64) |
Downloads the specified part of the remote file to the data stream.
|
| GetFile(String, String, Int64, Int64) |
Downloads the specified part of the remote file to the specified offset of the local file.
|
| GetFileDateTime |
Retrieves the modification date and time of the specified remote file.
|
| GetFileLength |
Retrieves the size of the specified remote file.
|
| GetHashCode | Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetChecksum(String, ChecksumAlgorithm) |
Returns the checksum of the specified file on the server.
|
| GetChecksum(String, ChecksumAlgorithm, Int64, Int64) |
Returns the checksum of the specified file on the server.
|
| GetInfo |
Retrieves a FileSystemItem containing the information about the specified remote file or directory.
|
| GetItems(String) |
Retrieves the list of files and directories. Matching directories are searched recursively.
|
| GetItems(FileSet) |
Retrieves the list of files and directories specified by the set.
|
| GetItems(String, TraversalMode) |
Retrieves the list of files and directories.
|
| GetList()()()() |
Retrieves the list of files and directories in the current server directory.
|
| GetList(String) |
Retrieves the list of files and directories in the current server directory.
|
| GetNameList()()()() |
Retrieves the list of file and directory names in the current remote directory.
|
| GetNameList(String) |
Retrieves the list of file and directory names.
|
| GetRawList()()()() |
Retrieves the raw list of files and directories in the current remote directory using a raw text format.
|
| GetRawList(String) |
Retrieves the raw list of files and directories using a raw text format.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUploadStream(String) |
Returns a Stream for writing data to the remote file.
|
| GetUploadStream(String, SeekOrigin, Int64) |
Returns a Stream for writing data to the remote file.
|
| ChangeDirectory |
Changes the current working directory on the server.
|
| CheckConnectionState |
Checks whether the session is still connected. Throws an exception on error.
|
| KeepAlive |
Sends a command to the server to keep the connection alive.
|
| Login(SshGssApiCredentials) |
Authenticates to the server using GSSAPI. Kerberos (not on .NET CF) and NTLM methods are supported.
This method cannot be used with FTP protocol.
|
| Login(String, SshPrivateKey) |
Authenticates the user to the server using his private key and initializes the SFTP session.
|
| Login(String, String) |
Authenticates the user to the server.
|
| Login(String, String, SshPrivateKey) |
Authenticates the user to the server using a combination of password and public key and initializes the SFTP session.
This method cannot be used with FTP protocol.
|
| Login(String, String, String) |
Authenticates the user to the FTP server. This method cannot be used with SFTP protocol.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PutFile(Stream, String) |
Uploads the content of the data stream to the file on the server, overriding it if it already exists.
|
| PutFile(String, String) |
Uploads the content of the local file to the file on the server, overriding it if it already exists.
|
| PutFile(Stream, String, Int64, Int64) |
Uploads the content of the data stream to the specified offset of the file on the server.
|
| PutFile(String, String, Int64, Int64, Int64) |
Uploads the specified part of the local file to the specified offset of the file on the server.
|
| RemoveDirectory |
Deletes an empty remote directory with the specified pathname.
|
| Rename |
Renames or moves a file or directory on the server.
|
| SetFileDateTime |
Sets the modification date and time of the specified remote file.
|
| SetSocketFactory |
Sets the socket factory to be used to create communication sockets.
|
| ToString | Returns a String that represents the current Object. (Inherited from Object.) |
| Upload(String, String) |
Uploads the specified file or directory hierarchy to the directory on the server. Accepts wildcards.
|
| Upload(FileSet, String) |
Uploads the specified local files and/or directories to the directory to the server.
|
| Upload(String, String, TraversalMode) |
Uploads the specified file or directory hierarchy to the directory on the server. Accepts wildcards.
|
| Upload(FileSet, String, TransferMethod, ActionOnExistingFiles) |
Uploads the specified local files and/or directories to the directory to the server.
|
| Upload(String, String, TraversalMode, TransferMethod, ActionOnExistingFiles) |
Uploads the specified file or directory hierarchy to the directory on the server. Accepts wildcards.
|
Properties
| Name | Description | |
|---|---|---|
 | Encoding |
Gets or sets the Encoding to use to encode and decode command parameters and server responses.
|
| Fingerprint |
Gets the server public key fingerprint (for SFTP) or the server certificate thumbprint (for FTP/SSL).
|
| FtpPassiveMode |
Gets or sets a value which specifies the way data transfers are made. This is used only when FTP protocol is used.
|
| FtpTransferMode |
Gets or sets the data transfer mode. This is used only when FTP protocol is used.
|
| Inner | |
 | InstanceId |
Gets instance ID (intended for logging purposes).
(Inherited from NetworkSession.) |
| IsAuthenticated |
Gets a value indicating whether the session is authenticated.
(Overrides NetworkSession..::..IsAuthenticated.) |
| IsBusy |
Gets a value indicating whether there any operation (method) in progress. This is used only when FTP protocol is used.
|
| IsConnected |
Gets a value indicating whether the session is connected.
(Overrides NetworkSession..::..IsConnected.) |
| IsSecured |
Gets the value indicating whether the control connection is secured.
|
| LocalEndPoint |
Gets the local client EndPoint.
|
| LogWriter |
Gets or sets the LogWriter used by this object.
(Inherited from NetworkSession.) |
| MaxDownloadSpeed |
Gets or sets the maximum allowed download speed, in kilobytes. For unlimited speed, set this to zero.
|
| MaxUploadSpeed |
Gets or sets the maximum allowed upload speed, in kilobytes. For unlimited speed, set this to zero.
|
| Passive | Obsolete. |
| Proxy |
Gets or sets the network proxy to use to access a remote server.
|
| RemoteEndPoint |
Gets the remote server EndPoint.
|
| SecureTransfers | Obsolete. |
| ServerName |
Gets the server name, if available.
(Overrides NetworkSession..::..ServerName.) |
| ServerPort |
Gets the server port, if available.
(Overrides NetworkSession..::..ServerPort.) |
| Session | Obsolete. |
| Settings |
Gets the options set used by this object.
|
| SshSession |
Gets the SSH session used by the SFTP part of the client.
|
| Timeout |
Gets or sets the length of time in milliseconds before the operation times out (specify -1 or 0 to indicate that the request does not time out).
|
| TransferMode | Obsolete. |
| TransferType |
Gets or sets the data transfer type.
|
| UserName |
Gets the authenticated user name, if available.
(Overrides NetworkSession..::..UserName.) |
Events
| Name | Description | |
|---|---|---|
 | DeleteProgressChanged |
Occurs when a significant action occurs in Delete(String, TraversalMode) method.
Notifies the client about currently processing directory, currently deleting file and progress of the delete.
|
| FingerprintCheck |
Occurs when a fingerprint is received from the server and needs to be validated.
|
| ListItemReceived |
Occurs when a file and directory listing item is received by the GetList()()()(), GetRawList()()()(), GetNameList()()()() or GetItems(String) methods.
Notifies the client about currently processed item.
|
| ProblemDetected |
Occurs when a problem is detected in Download(String, String), Upload(String, String), Delete(String, TraversalMode) or GetItems(String) methods,
making it possible for the handler to choose a desired reaction.
|
| TransferProgressChanged |
Occurs when a significant action occurs in Download(String, String), Upload(String, String) methods.
Notifies the client about currently processing directory, currently transferring file and progress of the transfer.
|
| Traversing |
Occurs when a significant action occurs in Download(String, String), Upload(String, String), Delete(String, TraversalMode) or GetItems(String) methods.
Notifies the client about traversing hierarchy structure.
|
| ValidatingCertificate |
Occurs when an FTP/SSL server certificate needs to be validated.
|
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
  | IFtp..::..Settings |
See Also
