ComponentPro UltimateSftp

      ComponentPro.Net.Sftp Methods

      See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
      For a list of all members of this type, see Sftp members.

      Public Methods

      NameDescription
      Public MethodsAuthenticateOverloaded. Authenticates the user to the SFTP server.
      Public MethodsAuthenticateAsyncOverloaded. Asynchronously authenticates to the server using GSSAPI.
      Public MethodsStatic MemberCalculateTimeDiffCalculates the time difference between the source and the dest file systems. (Inherited from FileSystem)
      Public MethodsCancelOverloaded. Overridden. Cancels the file transfer operation associated with the specified user-defined object.
      Public MethodsChangePasswordChanges the specified user's password on the SFTP server and authenticates.
      Public MethodsChangePasswordAsyncOverloaded. Asynchronous changes the specified user's password on the SFTP server and authenticates.
      Public MethodsCombinePathCombines two path strings. (Inherited from FileSystem)
      Public MethodsConnectOverloaded. Connects to the SFTP server.
      Public MethodsConnectAsyncOverloaded. Initiates an asynchronous operation to an FTP server.
      Public MethodsCopyFromCopies data in a stream to the specified destination file on this system. (Inherited from FileSystem)
      Public MethodsCopyFromAsyncAsynchronously copies data in a stream to the specified destination file on this system. (Inherited from FileSystem)
      Public MethodsStatic MemberCopyToCopies a file from this file system to another file system. (Inherited from FileSystem)
      Public MethodsStatic MemberCopyToAsyncAsynchronously copies a file from this file system to another file system. (Inherited from FileSystem)
      Public MethodsCreateDirectoryOverridden. Creates a directory on the SFTP server.
      Public MethodsCreateDirectoryAsyncBegins an asynchronous CreateDirectory operation. Creates an empty directory. (Inherited from FileSystem)
      Public MethodsCreateFileInfoOverloaded. Overridden. Creates a new SftpFileInfo.
      Public MethodsCreateSymlinkCreates a new symlink on the SFTP server.
      Public MethodsCreateSymlinkAsyncOverloaded. Asynchronously creates a new symlink on the SFTP server.
      Public MethodsDeleteDeletes files or directories and, if indicated, any subdirectories matching the specified search condition on the filesToDelete list. (Inherited from FileSystem)
      Public MethodsDeleteAsyncAsynchronously 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)
      Public MethodsDeleteDirectoryOverloaded. Overridden. Deletes an empty remote directory with the specified pathname. To delete a directory containing files and subdirectories, use the DeleteDirectory method.
      Public MethodsDeleteDirectoryAsyncAsynchronously deletes the specified directory and, if indicated, any subdirectories and files in the directory. (Inherited from FileSystem)
      Public MethodsDeleteFileOverloaded. Overridden. Deletes the specified file on the remote SFTP server.
      Public MethodsDeleteFileAsyncAsynchronously deletes the specified file. (Inherited from FileSystem)
      Public MethodsDirectoryExistsOverridden. Checks whether the specified directory exists on the server.
      Public MethodsDirectoryExistsAsyncAsynchronously detects whether the specified directory exists on the file system. (Inherited from FileSystem)
      Public MethodsDisconnectDisconnects from the SSH server.
      Public MethodsDisconnectAsyncOverloaded. Begins an asynchronous operation to inform the server that the connection is about to close and terminates the connection.
      Public MethodsDisposeReleases all used resources. (Inherited from FileSystem)
      Public MethodsDownloadOverloaded. Downloads the content of the specified remote file or directory to the destination directory using multiple threads.
      Public MethodsDownloadAsyncOverloaded. 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.
      Public MethodsDownloadFileOverloaded. Download a file from an the server, overriding it if it already exists.
      Public MethodsDownloadFileAsyncOverloaded. Downloads the remote file to the data stream.
      Public MethodsEnsuresDirectoryCreatedEnsures 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)
      Public MethodsFileExistsOverloaded. Overridden. Checks whether the specified file exists on the server.
      Public MethodsFileExistsAsyncAsynchronous detects whether the specified file exists on the file system. (Inherited from FileSystem)
      Public MethodsGetAbsolutePathReturns the absolute path of the specified path.
      Public MethodsStatic MemberGetCommonChecksumAlgorithmsGets checksum algorithms that both file system have in common. (Inherited from FileSystem)
      Public MethodsGetConnectionStateChecks to see if the current connection is still active and returns error if any.
      Public MethodsGetCurrentDirectoryOverridden. Retrieves the current working directory of the SFTP server.
      Public MethodsGetCurrentDirectoryAsyncAsynchronously gets the current working directory of the file system. (Inherited from FileSystem)
      Public MethodsGetDirectoryNameReturns the directory information for the specified path string. (Inherited from FileSystem)
      Public MethodsGetDirectorySizeReturns total size of the specified directories. (Inherited from FileSystem)
      Public MethodsGetDirectorySizeAsyncAsynchronously calculates total size of the specified directory. (Inherited from FileSystem)
      Public MethodsGetDownloadStreamOverloaded. Returns a Stream for reading data from the remote file.
      Public MethodsGetDownloadStreamAsyncOverloaded. Asynchronously returns a Stream for reading data from the remote file.
      Public MethodsGetFileLengthGets the size of the specified file. (Inherited from FileSystem)
      Public MethodsGetFileLengthAsyncAsynchronously retrieves the size of the specified file. (Inherited from FileSystem)
      Public MethodsGetFileNameReturns the file name and extension of the specified path string. (Inherited from FileSystem)
      Public MethodsGetFullPathReturns a full path of the specified path. (Inherited from FileSystem)
      Public MethodsGetItemInfoReturns a FileInfoBase object containing information of the specified file or directory. (Inherited from FileSystem)
      Public MethodsGetItemInfoAsyncAsynchronously retrieves a FileInfoBase containing the information about the specified file or directory. (Inherited from FileSystem)
      Public MethodsGetLastWriteTimeReturns the date and time the specified file or directory was last written to. (Inherited from FileSystem)
      Public MethodsGetLastWriteTimeAsyncAsynchronous retrieves the modification date and time of the specified file. (Inherited from FileSystem)
      Public MethodsGetServerTimeDifferenceReturns the time difference between the client and SFTP server.
      Public MethodsGetServerTimeDifferenceAsyncOverloaded. Initiates an asynchronous operation to get the time difference between the client and server. Not all FTP servers support this!
      Public MethodsGetStreamOverloaded. Returns a Stream for reading and writing data from the remote file.
      Public MethodsGetStreamAsyncOverloaded. Asynchronously returns a Stream for reading and writing data from the remote file.
      Public MethodsGetSupportedChecksumTypesOverridden. Returns the supported checksum types.
      Public MethodsGetSymlinkPathResolves the symlink and returns the real path.
      Public MethodsGetSymlinkPathAsyncOverloaded. Begins an asynchronous GetSymlinkPath operation. Resolves the symlink and returns the real path.
      Public MethodsGetUploadStreamOverloaded. Returns a Stream for writing data to the remote file.
      Public MethodsGetUploadStreamAsyncOverloaded. Begins an asynchronous operation to return a Stream for writing data to the remote file.
      Public MethodsIsCancelingReturns a boolean value indicating whether user has called the Cancel method. (Inherited from FileSystem)
      Public MethodsIsFatalErrorReturns a boolean value indicating whether the specified error indicates that the client should reconnect to the server.
      Public MethodsIsPathRootedGets a value indicating whether the specified path string contains absolute or relative path information. (Inherited from FileSystem)
      Public MethodsKeepAliveSends a data packet to the server to keep the connection alive.
      Public MethodsKeepAliveAsyncOverloaded. Begins an asynchronous operation to send a command or data packet to the server to keep the connection alive.
      Public MethodsListDirectoryOverloaded. Overridden. Retrieves the list of files and directories in the current remote directory.
      Public MethodsListDirectoryAsyncAsynchronously retrieves the list of files and directories in the specified directory. (Inherited from FileSystem)
      Public MethodsListNameOverloaded. Overridden. Gets the list of file and directory names in the current remote directory.
      Public MethodsListNameAsyncBegins an asynchronous ListName operation. Retrieves the list of file and directory names in the current directory. (Inherited from FileSystem)
      Public MethodsListRawNameOverloaded. Gets the raw list of files and directories in the current remote directory on the SFTP server.
      Public MethodsListRawNameAsyncOverloaded. Begins an asynchronous ListRawName operation. Retrieves the list of files and directories in the specified directory using a raw text format.
      Public MethodsMoveMoves 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)
      Public MethodsMoveAsyncAsynchronously 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)
      Public MethodsMultiPartDownloadOverloaded. Downloads a file on the server and writes to the specified local file using multiple threads.
      Public MethodsNormalizePathNormalizes 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)
      Public MethodsQuickSynchronizeSynchronizes the specified local directory with the specified source directory with the specified options. (Inherited from FileSystem)
      Public MethodsQuickSynchronizeAsyncInitiates an asynchronous operation to synchronize contents of a source directory and a local directory. (Inherited from FileSystem)
      Public MethodsRenameOverridden. Renames a file or directory on the SFTP server.
      Public MethodsRenameAsyncBegins an asynchronous Rename operation. Renames a file or directory on the file system. (Inherited from FileSystem)
      Public MethodsResumeDownloadFileOverloaded. Resumes download the content of the remote file to the previously interrupted local file.
      Public MethodsResumeDownloadFileAsyncOverloaded. Resumes download the content of the data stream to the previously interrupted remote file.
      Public MethodsResumeUploadFileOverloaded. Resumes uploading the content of the data stream to the previously interrupted remote file.
      Public MethodsResumeUploadFileAsyncOverloaded. Initiates an asynchronous operation to resume uploading the content of the data stream to the previously interrupted remote file.
      Public MethodsReuseConnectionOverloaded. Binds the Sftp object to an underlying SSH session. This makes it possible to run multiple SFTP sessions over a single SSH session. This can be used instead of Connect/Authenticate methods.
      Public MethodsReuseConnectionAsyncOverloaded. Asynchronously binds the Sftp object to an underlying SSH session. This makes it possible to run multiple SFTP sessions over a single SSH session. This can be used instead of Connect/Authenticate methods.
      Public MethodsSearchSearches for files and directories that match the specified search pattern, if specified, in the directoryPath. (Inherited from FileSystem)
      Public MethodsSearchAsyncSearches for files and directories that match the specified search conditions. (Inherited from FileSystem)
      Public MethodsSetCurrentDirectoryOverridden. Changes the current working directory on the server.
      Public MethodsSetCurrentDirectoryAsyncBegins an asynchronous SetCurrentDirectory operation. (Inherited from FileSystem)
      Public MethodsSetFileAttributesSets the attributes of the remote file.
      Public MethodsSetFileAttributesAsyncOverloaded. Begins an asynchronous SetFileAttributes operation.
      Public MethodsSetLastWriteTimeOverridden. Sets the modification date and time of the specified remote file.
      Public MethodsSetLastWriteTimeAsyncBegins an asynchronous SetLastWriteTime operation. Sets the modification date and time of the specified file. (Inherited from FileSystem)
      Public MethodsSetMultipleFilesAttributesOverloaded. Sets the attributes of the specified remote files.
      Public MethodsSetMultipleFilesAttributesAsyncOverloaded. Asynchronously sets the attributes of the specified remote files.
      Public MethodsSetSocketFactorySets the socket factory to be used to create communication sockets.
      Public MethodsToStringOverridden. Returns a string representation of this object.
      Public MethodsStatic MemberTransferFilesTransfers files from the specified source file system to the specified destination file system. (Inherited from FileSystem)
      Public MethodsStatic MemberTransferFilesAsyncAsynchronously transfers files from the specified source file system to the specified destination file system. (Inherited from FileSystem)
      Public MethodsUploadOverloaded. Uploads files from the specified source directory on the specified source file system to the specified remote directory using multiple threads.
      Public MethodsUploadAsyncOverloaded. 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.
      Public MethodsUploadFileOverloaded. Uploads from the current position in the specified source stream and writes to the destination file on the server.
      Public MethodsUploadFileAsyncOverloaded. Begins an asynchronous operation to upload the content of the data stream to the file on the server.
      Top

      Protected Methods

      NameDescription
      Protected MethodsDisposeOverridden. Releases the unmanaged resources used by the Sftp and optionally releases the managed resources.
      Protected MethodsFinalizeOverridden. Finalizer. Called by garbage collector during object destruction.
      Protected MethodsGetItemInfoPartsBeforeTransferringIndicates whether the file system should obtains information of the source files before transferring. (Inherited from FileSystem)
      Virtual Protected MethodsOnAuthenticateCompletedRaises the AuthenticateCompleted event.
      Virtual Protected MethodsOnBannerRaises the Banner event.
      Virtual Protected MethodsOnChangePasswordCompletedRaises the ChangePasswordCompleted event.
      Virtual Protected MethodsOnCommandResponseRaises the CommandResponse event.
      Virtual Protected MethodsOnConnectCompletedRaises the ConnectCompleted event.
      Protected MethodsOnCopyFromCompletedRaises the CopyFromCompleted event. (Inherited from FileSystem)
      Protected MethodsOnCopyToCompletedRaises the CopyToCompleted event. (Inherited from FileSystem)
      Protected MethodsOnCreateDirectoryCompletedRaises the CreateDirectoryCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnCreateSymlinkCompletedRaises the CreateSymlinkCompleted event.
      Protected MethodsOnDeleteCompletedRaises the DeleteCompleted event. (Inherited from FileSystem)
      Protected MethodsOnDeleteDirectoryCompletedRaises the DeleteDirectoryCompleted event. (Inherited from FileSystem)
      Protected MethodsOnDeleteFileCompletedRaises the DeleteFileCompleted event. (Inherited from FileSystem)
      Protected MethodsOnDirectoryExistsCompletedRaises the DirectoryExistsCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnDisconnectCompletedRaises the DisconnectCompleted event.
      Virtual Protected MethodsOnDownloadCompletedRaises the DownloadCompleted event.
      Virtual Protected MethodsOnDownloadFileCompletedRaises the DownloadFileCompleted event.
      Protected MethodsOnFileExistsCompletedRaises the FileExistsCompleted event. (Inherited from FileSystem)
      Protected MethodsOnGetCurrentDirectoryCompletedRaises the GetCurrentDirectoryCompleted event. (Inherited from FileSystem)
      Protected MethodsOnGetDirectorySizeCompletedRaises the GetDirectorySizeCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnGetDownloadStreamCompletedRaises the GetDownloadStreamCompleted event.
      Protected MethodsOnGetFileChecksumCompletedRaises the GetFileChecksumCompleted event. (Inherited from FileSystem)
      Protected MethodsOnGetFileLengthCompletedRaises the GetFileLengthCompleted event. (Inherited from FileSystem)
      Protected MethodsOnGetItemInfoCompletedRaises the GetItemInfoCompleted event. (Inherited from FileSystem)
      Protected MethodsOnGetLastWriteTimeCompletedRaises the GetLastWriteTimeCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnGetServerTimeDifferenceCompletedRaises the GetServerTimeDifferenceCompleted event.
      Virtual Protected MethodsOnGetStreamCompletedRaises the GetStreamCompleted event.
      Virtual Protected MethodsOnGetSymlinkPathCompletedRaises the GetSymlinkPathCompleted event.
      Virtual Protected MethodsOnGetUploadStreamCompletedRaises the GetUploadStreamCompleted event.
      Virtual Protected MethodsOnHostKeyVerifyingRaises the HostKeyVerifying event.
      Virtual Protected MethodsOnKeepAliveCompletedRaises the KeepAliveCompleted event.
      Virtual Protected MethodsOnKeyboardInteractiveAuthenticationRaises the KeyboardInteractiveAuthentication event.
      Protected MethodsOnListDirectoryCompletedRaises the ListDirectoryCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnListItemReceivedRaises the ListItemReceived event.
      Protected MethodsOnListNameCompletedRaises the ListNameCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnListRawNameCompletedRaises the ListRawNameCompleted event.
      Protected MethodsOnMoveFilesCompletedRaises the MoveCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnPasswordChangeRequestRaises the PasswordChangeRequest event.
      Protected MethodsOnProgressRaises the Progress event. (Inherited from FileSystem)
      Protected MethodsOnQuickSynchronizeCompletedRaises the QuickSynchronizeCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnReconnectedRaises the Reconnected event.
      Virtual Protected MethodsOnReconnectingRaises the Reconnecting event.
      Virtual Protected MethodsOnReconnectionErrorCheckingRaises the ReconnectionErrorChecking event.
      Protected MethodsOnRenameCompletedRaises the RenameCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnResumeDownloadFileCompletedRaises the ResumeDownloadFileCompleted event.
      Virtual Protected MethodsOnResumeUploadFileCompletedRaises the ResumeUploadFileCompleted event.
      Virtual Protected MethodsOnReuseConnectionCompletedRaises the ReuseConnectionCompleted event.
      Protected MethodsOnSearchCompletedRaises the SearchCompleted event. (Inherited from FileSystem)
      Protected MethodsOnSetCurrentDirectoryCompletedRaises the SetCurrentDirectoryCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnSetFileAttributesCompletedRaises the SetFileAttributesCompleted event.
      Protected MethodsOnSetLastWriteTimeCompletedRaises the SetLastWriteTimeCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnSetMultipleFilesAttributesCompletedRaises the SetMultipleFilesAttributesCompleted event.
      Virtual Protected MethodsOnStateChangedRaises the StateChanged event.
      Protected MethodsOnThreadStateChangedRaises the ThreadStateChanged event. (Inherited from FileSystem)
      Protected MethodsOnTransferConfirmOverridden. Raises the TransferConfirm event.
      Virtual Protected MethodsOnUploadCompletedRaises the UploadCompleted event.
      Virtual Protected MethodsOnUploadFileCompletedRaises the UploadFileCompleted event.
      Protected MethodsRenameSyncOverridden. Moves a specified file to a new location, providing the option to specify a new file name.
      Top

      See Also