Catalyst File Transfer .NET

FileTransfer Members

FileTransfer overview

Public Static (Shared) Fields

filePortFTP A constant value which specifies the default port number for the File Transfer Protocol.
filePortFTPS A constant value which specifies the default port number for a secure FTP connection usiung the SSL or TLS protocols.
filePortHTTP A constant value which specifies the default port number for the Hypertext Transfer protocol.
filePortHTTPS A constant value which specifies the default port number for a secure HTTP connection using the SSL or TLS protocols.
filePortSFTP A constant value which specifies the default port number for a secure SSH connection using the SSH1 or SSH2 protocols.
fileTimeout A constant value which specifies the default timeout period.

Public Instance Constructors

FileTransfer Constructor Initializes a new instance of the FileTransfer class.

Public Instance Properties

Account Get or sets a value that specifies the account name for the current user.
ActivePorts Gets and sets the port numbers used for active mode file transfers.
CertificateExpires Get a value that specifies the date that the security certificate expires.
CertificateIssued Get a value that specifies the date that the security certificate was issued.
CertificateIssuer Get a value that provides information about the organization that issued the certificate.
CertificateName Gets and sets a value that specifies the name of the security certificate.
CertificateStatus Gets a value which indicates the status of the security certificate returned by the remote host.
CertificateStore Gets and sets a value that specifies the name of the local certificate store.
CertificateSubject Gets a value that provides information about the organization that the server certificate was issued to.
ChannelMode Set or return the security mode for the specified communications channel.
CipherStrength Gets a value that indicates the length of the key used by the encryption algorithm for a secure connection.
DirectoryFormat Gets and sets a value which specifies the current directory format type.
Features Gets and sets the features that are currently enabled for the current session.
FileType Gets and sets a value which specifies the type of file that is being transferred.
Handle Gets a value that specifies the client handle allocated for the current session.
HashStrength Gets a value which specifies the length of the message digest that was selected for a secure connection.
IsBlocked Gets a value which indicates if the current thread is performing a blocking client operation.
IsConnected Gets a value which indicates if a connection to the remote host has been established.
IsInitialized Gets a value which indicates if the current instance of the class has been initialized successfully.
KeepAlive Gets and sets a boolean value which specifies if the client should attempt to keep the server connection alive.
LastError Gets and sets a value which specifies the last error that has occurred.
LastErrorString Gets a value which describes the last error that has occurred.
LocalAddress Gets and sets the local Internet address that the client will be bound to.
LocalFile Gets and sets the name of the file on the local system.
Localize Gets and sets a value which specifies if time and dates should be adjusted for the current timezone.
LocalName Gets a value which specifies the host name for the local system.
Options Gets and sets a value which specifies one or more client options.
Passive Gets and sets a value which specifies if passive mode file transfers should be enabled.
Password Gets and sets the password used to authenticate the client session.
Priority Gets and sets a value which specifies the priority of file transfers.
ProtocolVersion Gets and sets a value which specifies the default protocol version.
ProxyPassword Gets and sets the password used to authenticate the connection to a proxy server.
ProxyPort Gets and sets a value that specifies the proxy server port number.
ProxyServer Gets and sets the hostname or IP address of a proxy server.
ProxyType Gets and sets the type of proxy server the client will use to establish a connection.
ProxyUser Gets and sets the username used to authenticate the connection to a proxy server.
RemoteFile Gets and sets a value which specifies a file name on the server.
ResultCode Gets a value which specifies the last result code returned by the server.
ResultString Gets a string value which describes the result of the previous command.
Secure Gets and sets a value which specifies if a secure connection is established.
SecureCipher Gets a value that specifies the encryption algorithm used for a secure connection.
SecureHash Gets a value that specifies the message digest algorithm used for a secure connection.
SecureKeyExchange Gets a value that specifies the key exchange algorithm used for a secure connection.
SecureProtocol Gets and sets a value which specifies the protocol used for a secure connection.
ServerDirectory Gets and sets a value which specifies the current working directory on the file server.
ServerName Gets and sets a value which specifies the host name used to establish a connection.
ServerPort Gets and sets a value which specifies the remote port number.
ServerType Gets and sets a value which specifies the type of file server the client is connecting to.
System Gets a string value which identifies the server.
ThreadModel Gets and sets a value which specifies the threading model for the class instance.
ThrowError Gets and sets a value which specifies if method calls should throw exceptions when an error occurs.
Timeout Gets and sets a value which specifies a timeout period in seconds.
TimeZone Gets and sets the current timezone offset in seconds.
Trace Gets and sets a value which indicates if network function tracing is enabled.
TraceFile Gets and sets a value which specifies the name of the client function tracing logfile.
TraceFlags Gets and sets a value which specifies the client function tracing flags.
TransferBytes Gets a value which specifies the number of bytes transferred to or from the remote server.
TransferTime Gets a value which specifies the number of milliseconds elapsed during a data transfer.
URL Gets and sets the current URL used to access a file on the server.
UserName Gets and sets the username used to authenticate the client session.
Version Gets a value which returns the current version of the FileTransfer class library.

Public Instance Methods

AddFileType Associate a file name extension with a specific file type.
AttachThread Attach an instance of the class to the current thread
Cancel Cancel the current blocking client operation.
ChangeDirectory Change the current working directory on the remote server.
CloseDirectory Close the directory that was previously opened with the OpenDirectory method.
Command Overloaded. Send a custom command to the server.
Connect Overloaded. Establish a connection with a file server.
DeleteFile Delete a file on the remote server.
Disconnect Terminate the connection with the remote server.
Dispose Overloaded. Releases all resources used by FileTransfer.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetData Overloaded. Transfers the contents of a file on the server and stores it in byte array.
GetDirectory Return the current working directory.
GetFile Overloaded. Download a file from the server to the local system.
GetFilePermissions Overloaded. Return the access permissions for a file on the remote system.
GetFileSize Overloaded. Returns the size of the specified file on the remote server.
GetFileStatus  
GetFileTime Overloaded. Returns the modification date and time for specified file on the remote server.
GetFirstFile Overloaded. Get information about the first file in a directory listing returned by the server.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetMultipleFiles Download multiple files from the server to the local system using a wildcard mask.
GetNextFile Overloaded. Get information about the next file in a directory listing returned by the server.
GetType (inherited from Object) Gets the Type of the current instance.
Initialize Overloaded. Initialize an instance of the FileTransfer class.
Login Overloaded. Login to the remote server.
Logout Log the current user off the server.
MakeDirectory Create a new directory on the server.
OpenDirectory Overloaded. Open the specified directory on the server.
PostFile Overloaded. Post the contents of the specified file to a script executed on the remote server.
PutData Overloaded. Transfers data from a byte array and stores it in a file on the remote server.
PutFile Overloaded. Upload a file from the local system to the server.
PutMultipleFiles Upload multiple files from the local system to the server using a wildcard mask.
RemoveDirectory Remove a directory on the server.
RenameFile Change the name of a file on the server.
Reset Reset the internal state of the object, resetting all properties to their default values.
SetFilePermissions Change the access permissions for a file on the server.
SetFileTime Changes the modification date and time for a file on the server.
ToString (inherited from Object) Returns a String that represents the current Object.
Uninitialize Uninitialize the class library and release any resources allocated for the current thread.
VerifyFile Verify that the contents of a file on the local system are the same as the specified file on the server.

Public Instance Events

OnCancel Occurs when a blocking client operation is canceled.
OnCommand Occurs when the client sends a command to the remote host and receives a reply indicating the result of that command.
OnError Occurs when an network operation fails.
OnGetFile Occurs when a file download has been initiated.
OnProgress Occurs as a data stream is being read or written to the server.
OnPutFile Occurs when a file upload is initiated.
OnTimeout Occurs when a blocking operation fails to complete before the timeout period elapses.

Protected Instance Methods

Dispose Overloaded. Releases the unmanaged resources allocated by the FileTransfer class and optionally releases the managed resources.
Finalize Destroys an instance of the class, releasing the resources allocated for the session and unloading the networking library.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

FileTransfer Class | SocketTools Namespace