ComponentPro UltimateSftp

IRemoteFileSystem Interface Members

See AlsoPropertyMethodEventMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
The following tables list the members exposed by IRemoteFileSystem.

Public Properties

NameDescription
Public PropertiesAsciiFileSearchConditionsGets or sets the list of ASCII file extensions.
Public PropertiesEncodingGets or sets the Encoding used to encode and decode command parameters and server responses.
Public PropertiesEncounteredFatalErrorGets a boolean value indicating whether the client object has encountered a fatal error.
Public PropertiesIsAuthenticatedGets a value indicating whether the session has already been authenticated.
Public PropertiesIsBusyGets a boolean value indicating whether the server is busy.
Public PropertiesIsConnectedGets a boolean value indicating whether the client is connected to the server.
Public PropertiesMaxDownloadSpeedGets or sets the maximum allowed download speed, in kilobytes. For unlimited speed, set this to zero.
Public PropertiesMaxUploadSpeedGets or sets the maximum allowed upload speed, in kilobytes. For unlimited speed, set this to zero.
Public PropertiesPathNormalizationGets or sets a boolean value indicating whether to normalize path before any file or directory operation.
Public PropertiesReconnectionFailureDelayGets or sets the delay in milliseconds between failed login attempts for reconnection during a multi-file operation.
Public PropertiesReconnectionMaxRetriesGets or sets the maximum number of retries for reconnection.
Public PropertiesServerNameGets the server name.
Public PropertiesServerPortGets the port number.
Public PropertiesStateGets the current state of the remote file system.
Public PropertiesTimeoutGets or sets a value, in milliseconds, indicating after what period an operation (sending commands, waiting for responses or time between data buffer transfers) should timeout.
Public PropertiesTransferTypeGets or sets the data transfer type.
Public PropertiesUserNameGets the user name.
Top

Public Methods

NameDescription
Public MethodsAuthenticateOverloaded. Authenticates the user to the remote server.
Public MethodsAuthenticateAsyncOverloaded. Begins an asynchronous operation to authenticate the user to the server.
Public MethodsConnectOverloaded. Connects to the remote server.
Public MethodsConnectAsyncOverloaded. Connects to a remote server asynchronously.
Public MethodsDisconnectDisconnects.
Public MethodsDisconnectAsyncOverloaded. Begins an asynchronous operation to inform the server that the connection is about to close and terminates the connection.
Public MethodsDownloadOverloaded. Downloads files from the specified remote directory that match the search condition specified in the options parameter to the destination directory using multiple threads.
Public MethodsDownloadAsyncOverloaded. Asynchronously downloads files from the specified remote directory that match the search condition specified in the options parameter to the destination directory.
Public MethodsDownloadFileOverloaded. Receives the specified file from the remote server into the specified Stream, starting from the specified offset.
Public MethodsDownloadFileAsyncOverloaded. Downloads the remote file to the data stream asynchronously.
Public MethodsGetAuthenticationParametersGets the current authentication parameters. For internal use only.
Public MethodsGetConnectionParametersGets the current connection parameters. For internal use only.
Public MethodsGetDownloadStreamRetrieves a direct access to the readonly data stream being received.
Public MethodsGetServerTimeDifferenceReturns the time difference between the client and server.
Public MethodsGetUploadStreamRetrieves a direct access to the write-only data stream to send to.
Public MethodsIsFatalErrorReturns a boolean value indicating whether the specified error indicates that the client should reconnect to the server.
Public MethodsKeepAliveLeep the connection alive.
Public MethodsKeepAliveAsyncOverloaded. Sends a command or data packet to the server asynchronously to keep the connection alive.
Public MethodsMultiPartDownloadOverloaded. Downloads a file on the server and writes to the specified local file using multiple threads.
Public MethodsResumeDownloadFileOverloaded. Resumes download the content of the remote file to the previously interrupted local file.
Public MethodsResumeUploadFileOverloaded. Resumes uploading the content of the data stream to the previously interrupted remote file.
Public MethodsUploadOverloaded. Uploads files from the specified source directory on the specified source file system that match the search condition specified in the options parameter to the specified remote directory.
Public MethodsUploadAsyncOverloaded. Asynchronously uploads files from the specified local directory to the specified remote directory.
Public MethodsUploadFileOverloaded. Uploads the data from the specified Stream to the server and stores it using the specified filename.
Public MethodsUploadFileAsyncOverloaded. Begins an asynchronous operation to upload the content of the data stream to the file on the server.
Top

Public Events

NameDescription
Public EventsAuthenticateCompletedOccurs when an asynchronous AuthenticateAsync operation completes.
Public EventsConnectCompletedOccurs when an asynchronous ConnectAsync operation completes.
Public EventsDisconnectCompletedOccurs when an asynchronous DisconnectAsync operation completes.
Public EventsDownloadCompletedOccurs when an asynchronous DownloadAsync operation completes.
Public EventsDownloadFileCompletedOccurs when an asynchronous DownloadFileAsync operation completes.
Public EventsKeepAliveCompletedOccurs when an asynchronous KeepAliveAsync operation completes.
Public EventsReconnectedOccurs when the file system has encountered an error and has reconnected to the server successfully.
Public EventsReconnectingOccurs when the file system has encountered an error and is reconnecting to the server.
Public EventsReconnectionErrorCheckingOccurs when the file system has encountered an error and needs to determine whether it should reconnect to the server.
Public EventsStateChangedOccurs when the state of the remote file system is changed.
Public EventsUploadCompletedOccurs when an asynchronous UploadAsync operation completes.
Public EventsUploadFileCompletedOccurs when an asynchronous UploadFileAsync operation completes.
Top

See Also