The Sftp type exposes the following members.

Constructors

  NameDescription
Public methodSupported by the .NET Compact FrameworkSftp
Initializes a new instance of the Sftp class.

Methods

  NameDescription
Public methodSupported by the .NET Compact FrameworkAbortTransfer()()()()
Aborts all pending file transfers (either file transfer or directory listing).
Public methodSupported by the .NET Compact FrameworkAbortTransfer(Object)
Aborts pending transfers (either file transfer or directory listing) identified by the specified user-provided state object.
Public methodSupported by the .NET Compact FrameworkBeginBind
Begins asynchronous Bind operation. 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(String)/Login(String, String) methods.
Public methodSupported by the .NET Compact FrameworkBeginConnect(String, AsyncCallback, Object)
Begins asynchronous Connect operation. Connects to the SFTP server.
Public methodSupported by the .NET Compact FrameworkBeginConnect(String, Int32, AsyncCallback, Object)
Begins asynchronous Connect operation. Connects to the SFTP server.
Public methodSupported by the .NET Compact FrameworkBeginConnect(String, Int32, SshParameters, AsyncCallback, Object) Obsolete.
Public methodSupported by the .NET Compact FrameworkBeginCreateDirectory
Begins asynchronous CreateDirectory operation. Creates a directory on the server.
Public methodSupported by the .NET Compact FrameworkBeginCreateLink
Begins asynchronous CreateLink operation. Creates a symbolic link or hard link on the server.
Public methodSupported by the .NET Compact FrameworkBeginCreateSymlink
Begins asynchronous CreateSymlink operation. Creates a symbolic link on the server.
Public methodSupported by the .NET Compact FrameworkBeginDelete(FileSet, AsyncCallback, Object)
Begins asynchronous Delete operation. Deletes specified files and/or directories on the server.
Public methodSupported by the .NET Compact FrameworkBeginDelete(String, TraversalMode, AsyncCallback, Object)
Begins asynchronous Delete operation. Deletes specified files and/or directories on the server. Accepts wildcards.
Public methodSupported by the .NET Compact FrameworkBeginDeleteFile
Begins asynchronous DeleteFile operation. Deletes a file on the server.
Public methodSupported by the .NET Compact FrameworkBeginDirectoryExists
Begins asynchronous DirectoryExists operation. Detects whether the specified directory exists on the server.
Public methodSupported by the .NET Compact FrameworkBeginDisconnect
Begins asynchronous Disconnect operation. Informs the server that the connection is about to close and terminates the connection.
Public methodSupported by the .NET Compact FrameworkBeginDownload(FileSet, String, TransferMethod, ActionOnExistingFiles, AsyncCallback, Object)
Begins asynchronous Download operation. Downloads the specified files and/or directories from the SFTP server to the local directory.
Public methodSupported by the .NET Compact FrameworkBeginDownload(String, String, TraversalMode, TransferMethod, ActionOnExistingFiles, AsyncCallback, Object)
Begins asynchronous Download operation. Downloads the specified file or directory hierarchy from the SFTP server to the local directory. Accepts wildcards.
Public methodSupported by the .NET Compact FrameworkBeginFileExists
Begins asynchronous FileExists operation. Detects whether the specified file exists on the server.
Public methodSupported by the .NET Compact FrameworkBeginGetFile(String, Stream, AsyncCallback, Object)
Begins asynchronous GetFile operation. Downloads the remote file to the data stream.
Public methodSupported by the .NET Compact FrameworkBeginGetFile(String, String, AsyncCallback, Object)
Begins asynchronous GetFile operation. Downloads the remote file to the local file, overriding it if it already exists.
Public methodSupported by the .NET Compact FrameworkBeginGetFile(String, Stream, Int64, Int64, AsyncCallback, Object)
Begins asynchronous GetFile operation. Downloads the specified part of the remote file to the data stream.
Public methodSupported by the .NET Compact FrameworkBeginGetFile(String, String, Int64, Int64, Int64, AsyncCallback, Object)
Begins asynchronous GetFile operation. Downloads the specified part of the remote file to the specified offset of the local file.
Public methodSupported by the .NET Compact FrameworkBeginGetFileDateTime
Begins asynchronous GetFileDateTime operation. Retrieves the modification date and time of the specified remote file.
Public methodSupported by the .NET Compact FrameworkBeginGetFileLength
Begins asynchronous GetFileLength operation. Retrieves the size of the specified remote file.
Public methodSupported by the .NET Compact FrameworkBeginGetFiles Obsolete.
Public methodSupported by the .NET Compact FrameworkBeginGetFileSystemInfo
Begins asynchronous GetFileSystemInfo operation. Gets drive information (such as free disk space) for the specified path.
Public methodSupported by the .NET Compact FrameworkBeginGetChecksum(String, ChecksumAlgorithm, AsyncCallback, Object)
Begins asynchronous GetChecksum operation. Returns the checksum of the specified file on the server. Only works on servers that support the
 Copy imageCopy Code
check-file
extension.
Public methodSupported by the .NET Compact FrameworkBeginGetChecksum(String, ChecksumAlgorithm, Int64, Int64, AsyncCallback, Object)
Begins asynchronous GetChecksum operation. Returns the checksum of the specified file on the server. Only works on servers that support the
 Copy imageCopy Code
check-file
extension.
Public methodSupported by the .NET Compact FrameworkBeginGetInfo
Begins asynchronous GetInfo operation. Retrieves a SftpItem containing the information about the specified remote file or directory.
Public methodSupported by the .NET Compact FrameworkBeginGetItems(FileSet, AsyncCallback, Object)
Begins asynchronous GetItems operation. Retrieves the list of files and directories specified by the set.
Public methodSupported by the .NET Compact FrameworkBeginGetItems(String, TraversalMode, AsyncCallback, Object)
Begins asynchronous GetItems operation. Retrieves the list of files and directories.
Public methodSupported by the .NET Compact FrameworkBeginGetList(AsyncCallback, Object)
Begins asynchronous GetList operation. Retrieves the list of files and directories in the current remote directory.
Public methodSupported by the .NET Compact FrameworkBeginGetList(String, AsyncCallback, Object)
Begins asynchronous GetList operation. Retrieves the list of files and directories in the specified remote directory, or a list of files matching the specified mask.
Public methodSupported by the .NET Compact FrameworkBeginGetNameList(AsyncCallback, Object)
Begins asynchronous GetNameList operation. Retrieves the list of file and directory names in the current remote directory.
Public methodSupported by the .NET Compact FrameworkBeginGetNameList(String, AsyncCallback, Object)
Begins asynchronous GetNameList operation. Retrieves the list of file and directory names in the specified remote directory, or a list of names matching the specified mask.
Public methodSupported by the .NET Compact FrameworkBeginGetRawList(AsyncCallback, Object)
Begins asynchronous GetRawList operation. Retrieves the list of files and directories in the current remote directory using a raw text format.
Public methodSupported by the .NET Compact FrameworkBeginGetRawList(String, AsyncCallback, Object)
Begins asynchronous GetRawList operation. Retrieves the list of files and directories in the specified remote directory (or a list of files matching the specified mask) using a raw text format.
Public methodSupported by the .NET Compact FrameworkBeginGetStream(String, FileMode, AsyncCallback, Object)
Begins asynchronous GetStream operation. Returns a Stream for reading and writing data from the remote file.
Public methodSupported by the .NET Compact FrameworkBeginGetStream(String, FileMode, FileAccess, AsyncCallback, Object)
Begins asynchronous GetStream operation. Returns a Stream for reading data from the remote file.
Public methodSupported by the .NET Compact FrameworkBeginChangeDirectory
Begins asynchronous ChangeDirectory operation. Changes the current working directory on the server.
Public methodSupported by the .NET Compact FrameworkBeginKeepAlive
Begins asynchronous KeepAlive operation. Sends an SSH 'ignore' packet to the server. This can be used to keep firewalls or routers that don't like inactive connection from closing idle session.
Public methodSupported by the .NET Compact FrameworkBeginLogin(AsyncCallback, Object)
Begins asynchronous Login operation. Authenticates the user to the server interactively and initializes the SFTP session. Uses AuthenticationRequest event to request credentials.
Public methodSupported by the .NET Compact FrameworkBeginLogin(String, AsyncCallback, Object)
Begins asynchronous Login operation. Authenticates the user to the server interactively and initializes the SFTP session. Uses AuthenticationRequest event to request credentials.
Public methodSupported by the .NET Compact FrameworkBeginLogin(SshGssApiCredentials, AsyncCallback, Object)
Begins asynchronous Login operation. Authenticates to the server using GSSAPI. Kerberos is only supported on Mono. NTLM is supported on Windows and partially on Mono.
Public methodSupported by the .NET Compact FrameworkBeginLogin(String, SshPrivateKey, AsyncCallback, Object)
Begins asynchronous Login operation. Authenticates the user to the server using his private key and initializes the SFTP session.
Public methodSupported by the .NET Compact FrameworkBeginLogin(String, String, AsyncCallback, Object)
Begins asynchronous Login operation. Authenticates the user to the server and initializes the SFTP session.
Public methodSupported by the .NET Compact FrameworkBeginLogin(String, String, SshPrivateKey, AsyncCallback, Object)
Begins asynchronous Login operation. Authenticates the user to the server using a combination of password and public key and initializes the SFTP session.
Public methodSupported by the .NET Compact FrameworkBeginPutFile(Stream, String, AsyncCallback, Object)
Begins asynchronous PutFile operation. Uploads the content of the data stream to the file on the server, overriding it if it already exists.
Public methodSupported by the .NET Compact FrameworkBeginPutFile(String, String, AsyncCallback, Object)
Begins asynchronous PutFile operation. Uploads the content of the local file to the file on the server, overriding it if it already exists.
Public methodSupported by the .NET Compact FrameworkBeginPutFile(Stream, String, Int64, Int64, AsyncCallback, Object)
Begins asynchronous PutFile operation. Uploads the content of the data stream to the specified offset of the file on the SFTP server.
Public methodSupported by the .NET Compact FrameworkBeginPutFile(String, String, Int64, Int64, Int64, AsyncCallback, Object)
Begins asynchronous PutFile operation. Uploads the specified part of the local file to the specified offset of the file on the SFTP server.
Public methodSupported by the .NET Compact FrameworkBeginPutFiles Obsolete.
Public methodSupported by the .NET Compact FrameworkBeginRemoveDirectory
Begins asynchronous RemoveDirectory operation. Deletes an empty remote directory with the specified pathname.
Public methodSupported by the .NET Compact FrameworkBeginRename
Begins asynchronous Rename operation. Renames or moves a file or directory on the server.
Public methodSupported by the .NET Compact FrameworkBeginResolveSymlink
Begins asynchronous ResolveSymlink operation. Resolves the symlink and returns the real path.
Public methodSupported by the .NET Compact FrameworkBeginSetAttributes
Begins asynchronous SetAttributes operation. Sets the attributes of the remote file.
Public methodSupported by the .NET Compact FrameworkBeginSetFileDateTime
Begins asynchronous SetFileDateTime operation. Sets the modification date and time of the specified remote file.
Public methodSupported by the .NET Compact FrameworkBeginUpload(FileSet, String, TransferMethod, ActionOnExistingFiles, AsyncCallback, Object)
Begins asynchronous Upload operation. Uploads the specified local files and/or directories to the directory to the SFTP server.
Public methodSupported by the .NET Compact FrameworkBeginUpload(String, String, TraversalMode, TransferMethod, ActionOnExistingFiles, AsyncCallback, Object)
Begins asynchronous Upload operation. Uploads the specified local file or directory hierarchy to the directory to the SFTP server. Accepts wildcards.
Public methodSupported by the .NET Compact FrameworkBind(ISocket)
Binds the Sftp object to an underlying stream socket. This method is experimental and intended for advanced users.
Public methodSupported by the .NET Compact FrameworkBind(SshSession)
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(String)/Login(String, String) methods.
Public methodSupported by the .NET Compact FrameworkConnect(String)
Connects to the SFTP server.
Public methodSupported by the .NET Compact FrameworkConnect(String, Int32)
Connects to the SFTP server.
Public methodSupported by the .NET Compact FrameworkConnect(String, Int32, SshParameters) Obsolete.
Public methodSupported by the .NET Compact FrameworkCreateDirectory
Creates a directory on the server.
Public methodSupported by the .NET Compact FrameworkCreateLink
Creates a symbolic link or hard link on the server.
Public methodSupported by the .NET Compact FrameworkCreateSymlink
Creates a symbolic link on the server.
Public methodSupported by the .NET Compact FrameworkDelete(FileSet)
Deletes specified files and/or directories on the server.
Public methodSupported by the .NET Compact FrameworkDelete(String, TraversalMode)
Deletes specified files and/or directories on the server. Accepts wildcards.
Public methodSupported by the .NET Compact FrameworkDeleteFile
Deletes a file on the server.
Public methodSupported by the .NET Compact FrameworkDirectoryExists
Detects whether the specified directory exists on the server.
Public methodSupported by the .NET Compact FrameworkDisconnect
Informs the server that the connection is about to close and terminates the connection.
Public methodSupported by the .NET Compact FrameworkDispose()()()()
Disposes the Sftp object and the underlying SSH object.
Protected methodSupported by the .NET Compact FrameworkDispose(Boolean)
Releases the unmanaged resources used by the Sftp and optionally releases the managed resources.
Public methodSupported by the .NET Compact FrameworkDownload(String, String)
Downloads the specified file or directory hierarchy from the SFTP server to the local directory. Accepts wildcards.
Public methodSupported by the .NET Compact FrameworkDownload(FileSet, String)
Downloads the specified files and/or directories from the SFTP server to the local directory.
Public methodSupported by the .NET Compact FrameworkDownload(String, String, TraversalMode)
Downloads the specified file or directory hierarchy from the SFTP server to the local directory. Accepts wildcards.
Public methodSupported by the .NET Compact FrameworkDownload(FileSet, String, TransferMethod, ActionOnExistingFiles)
Downloads the specified files and/or directories from the SFTP server to the local directory.
Public methodSupported by the .NET Compact FrameworkDownload(String, String, TraversalMode, TransferMethod, ActionOnExistingFiles)
Downloads the specified file or directory hierarchy from the SFTP server to the local directory. Accepts wildcards.
Public methodSupported by the .NET Compact FrameworkEndBind
Ends an asynchronous BeginBind operation.
Public methodSupported by the .NET Compact FrameworkEndConnect
Ends an asynchronous BeginConnect operation.
Public methodSupported by the .NET Compact FrameworkEndCreateDirectory
Ends an asynchronous BeginCreateDirectory operation.
Public methodSupported by the .NET Compact FrameworkEndCreateLink
Ends an asynchronous BeginCreateLink operation.
Public methodSupported by the .NET Compact FrameworkEndCreateSymlink
Ends an asynchronous BeginCreateSymlink operation.
Public methodSupported by the .NET Compact FrameworkEndDelete
Ends an asynchronous BeginDelete operation.
Public methodSupported by the .NET Compact FrameworkEndDeleteFile
Ends an asynchronous BeginDeleteFile operation.
Public methodSupported by the .NET Compact FrameworkEndDirectoryExists
Ends an asynchronous BeginDirectoryExists operation.
Public methodSupported by the .NET Compact FrameworkEndDisconnect
Ends an asynchronous BeginDisconnect operation.
Public methodSupported by the .NET Compact FrameworkEndDownload
Ends an asynchronous BeginDownload operation.
Public methodSupported by the .NET Compact FrameworkEndFileExists
Ends an asynchronous BeginFileExists operation.
Public methodSupported by the .NET Compact FrameworkEndGetFile
Ends an asynchronous BeginGetFile operation.
Public methodSupported by the .NET Compact FrameworkEndGetFileDateTime
Ends an asynchronous BeginGetFileDateTime operation.
Public methodSupported by the .NET Compact FrameworkEndGetFileLength
Ends an asynchronous BeginGetFileLength operation.
Public methodSupported by the .NET Compact FrameworkEndGetFiles Obsolete.
Public methodSupported by the .NET Compact FrameworkEndGetFileSystemInfo
Ends an asynchronous BeginGetFileSystemInfo operation.
Public methodSupported by the .NET Compact FrameworkEndGetChecksum
Ends an asynchronous BeginGetChecksum operation.
Public methodSupported by the .NET Compact FrameworkEndGetInfo
Ends an asynchronous BeginGetInfo operation.
Public methodSupported by the .NET Compact FrameworkEndGetItems
Ends an asynchronous BeginGetItems operation.
Public methodSupported by the .NET Compact FrameworkEndGetList
Ends an asynchronous BeginGetList operation.
Public methodSupported by the .NET Compact FrameworkEndGetNameList
Ends an asynchronous BeginGetNameList operation.
Public methodSupported by the .NET Compact FrameworkEndGetRawList
Ends an asynchronous BeginGetRawList operation.
Public methodSupported by the .NET Compact FrameworkEndGetStream
Ends an asynchronous BeginGetStream operation.
Public methodSupported by the .NET Compact FrameworkEndChangeDirectory
Ends an asynchronous BeginChangeDirectory operation.
Public methodSupported by the .NET Compact FrameworkEndKeepAlive
Ends an asynchronous BeginKeepAlive operation.
Public methodSupported by the .NET Compact FrameworkEndLogin
Ends an asynchronous BeginLogin operation.
Public methodSupported by the .NET Compact FrameworkEndPutFile
Ends an asynchronous BeginPutFile operation.
Public methodSupported by the .NET Compact FrameworkEndPutFiles Obsolete.
Public methodSupported by the .NET Compact FrameworkEndRemoveDirectory
Ends an asynchronous BeginRemoveDirectory operation.
Public methodSupported by the .NET Compact FrameworkEndRename
Ends an asynchronous BeginRename operation.
Public methodSupported by the .NET Compact FrameworkEndResolveSymlink
Ends an asynchronous BeginResolveSymlink operation.
Public methodSupported by the .NET Compact FrameworkEndSetAttributes
Ends an asynchronous BeginSetAttributes operation.
Public methodSupported by the .NET Compact FrameworkEndSetFileDateTime
Ends an asynchronous BeginSetFileDateTime operation.
Public methodSupported by the .NET Compact FrameworkEndUpload
Ends an asynchronous BeginUpload operation.
Public methodSupported by the .NET Compact FrameworkEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodSupported by the .NET Compact FrameworkFileExists
Detects whether the specified file exists on the server.
Protected methodSupported by the .NET Compact FrameworkFinalize
Finalizer. Called by garbage collector during object destruction.
(Overrides Object..::..Finalize()()()().)
Public methodSupported by the .NET Compact FrameworkGetConnectionState
Checks whether the SFTP session is still connected and returns its state.
Public methodSupported by the .NET Compact FrameworkGetCurrentDirectory
Gets the absolute path of the current working directory on the remote server.
Public methodSupported by the .NET Compact FrameworkGetDownloadStream
Returns a Stream for reading data from the remote file.
Public methodSupported by the .NET Compact FrameworkGetFile(String, Stream)
Downloads the remote file to the data stream.
Public methodSupported by the .NET Compact FrameworkGetFile(String, String)
Downloads the remote file to the local file, overriding it if it already exists.
Public methodSupported by the .NET Compact FrameworkGetFile(String, Stream, Int64, Int64)
Downloads the specified part of the remote file to the data stream.
Public methodSupported by the .NET Compact FrameworkGetFile(String, String, Int64, Int64, Int64)
Downloads the specified part of the remote file to the specified offset of the local file.
Public methodSupported by the .NET Compact FrameworkGetFileDateTime
Retrieves the modification date and time of the specified remote file.
Public methodSupported by the .NET Compact FrameworkGetFileLength
Retrieves the size of the specified remote file.
Public methodSupported by the .NET Compact FrameworkGetFiles(String, String, SftpBatchTransferOptions) Obsolete.
Public methodSupported by the .NET Compact FrameworkGetFiles(String, String, SftpBatchTransferOptions, SftpActionOnExistingFiles) Obsolete.
Public methodSupported by the .NET Compact FrameworkGetFileSystemInfo
Gets drive information (such as free disk space) for the specified path.
Public methodSupported by the .NET Compact FrameworkGetHashCode
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.)
Public methodSupported by the .NET Compact FrameworkGetHomeDirectory
Gets the absolute path of the home directory path of currently logged user.
Public methodSupported by the .NET Compact FrameworkGetChecksum(String, ChecksumAlgorithm)
Returns the checksum of the specified file on the server. Only works on servers that support the
 Copy imageCopy Code
check-file
extension.
Public methodSupported by the .NET Compact FrameworkGetChecksum(String, ChecksumAlgorithm, Int64, Int64)
Returns the checksum of the specified file on the server. Only works on servers that support the
 Copy imageCopy Code
check-file
extension.
Public methodSupported by the .NET Compact FrameworkGetInfo(String)
Retrieves a SftpItem containing the information about the specified remote file or directory.
Public methodSupported by the .NET Compact FrameworkGetInfo(String, Boolean)
Retrieves a SftpItem containing the information about the specified remote file or directory.
Public methodSupported by the .NET Compact FrameworkGetItems(String)
Retrieves the list of files and directories. Matching directories are searched recursively.
Public methodSupported by the .NET Compact FrameworkGetItems(FileSet)
Retrieves the list of files and directories specified by the set.
Public methodSupported by the .NET Compact FrameworkGetItems(String, TraversalMode)
Retrieves the list of files and directories.
Public methodSupported by the .NET Compact FrameworkGetList()()()()
Retrieves the list of files and directories in the current remote directory.
Public methodSupported by the .NET Compact FrameworkGetList(String)
Retrieves the list of files and directories in the specified remote directory, or a list of files matching the specified mask.
Public methodSupported by the .NET Compact FrameworkGetNameList()()()()
Retrieves the list of file and directory names in the current remote directory.
Public methodSupported by the .NET Compact FrameworkGetNameList(String)
Retrieves the list of file and directory names in the specified remote directory, or a list of names matching the specified mask.
Public methodSupported by the .NET Compact FrameworkGetRawList()()()()
Retrieves the list of files and directories in the current remote directory using a raw text format.
Public methodSupported by the .NET Compact FrameworkGetRawList(String)
Retrieves the list of files and directories in the specified remote directory (or a list of files matching the specified mask) using a raw text format.
Public methodSupported by the .NET Compact FrameworkGetStream(String, FileMode)
Returns a Stream for reading and writing data from the remote file.
Public methodSupported by the .NET Compact FrameworkGetStream(String, FileMode, FileAccess)
Returns a Stream for reading data from the remote file.
Public methodSupported by the .NET Compact FrameworkGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSupported by the .NET Compact FrameworkGetUploadStream
Returns a Stream for writing data to the remote file. The remote file is created if it doesn't exist, and truncated if it does. Use GetStream(String, FileMode) method if different behavior is desired.
Public methodSupported by the .NET Compact FrameworkChangeDirectory
Changes the current working directory on the server.
Public methodSupported by the .NET Compact FrameworkCheckConnectionState
Checks whether the SFTP session is still connected. Throws an exception on error.
Public methodSupported by the .NET Compact FrameworkKeepAlive
Sends an SSH 'ignore' packet to the server. This can be used to keep firewalls or routers that don't like inactive connection from closing idle session.
Public methodSupported by the .NET Compact FrameworkLogin()()()()
Authenticates the user to the server interactively and initializes the SFTP session. Uses AuthenticationRequest event to request credentials.
Public methodSupported by the .NET Compact FrameworkLogin(String)
Authenticates the user to the server interactively and initializes the SFTP session. Uses AuthenticationRequest event to request credentials.
Public methodSupported by the .NET Compact FrameworkLogin(SshGssApiCredentials)
Authenticates to the server using GSSAPI. Kerberos is only supported on Mono. NTLM is supported on Windows and partially on Mono.
Public methodSupported by the .NET Compact FrameworkLogin(String, SshPrivateKey)
Authenticates the user to the server using his private key and initializes the SFTP session.
Public methodSupported by the .NET Compact FrameworkLogin(String, String)
Authenticates the user to the server and initializes the SFTP session.
Public methodSupported by the .NET Compact FrameworkLogin(String, String, SshPrivateKey)
Authenticates the user to the server using a combination of password and public key and initializes the SFTP session.
Protected methodSupported by the .NET Compact FrameworkMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodSupported by the .NET Compact FrameworkOnCommandSent
Raises the CommandSent event.
Protected methodSupported by the .NET Compact FrameworkOnResponseRead
Raises the ResponseRead event.
Protected methodSupported by the .NET Compact FrameworkOnStateChanged
Raises the StateChanged event.
Protected methodSupported by the .NET Compact FrameworkOnTransferProgress
Raises the TransferProgress event.
Public methodSupported by the .NET Compact FrameworkPutFile(Stream, String)
Uploads the content of the data stream to the file on the server, overriding it if it already exists.
Public methodSupported by the .NET Compact FrameworkPutFile(String, String)
Uploads the content of the local file to the file on the server, overriding it if it already exists.
Public methodSupported by the .NET Compact FrameworkPutFile(Stream, String, Int64, Int64)
Uploads the content of the data stream to the specified offset of the file on the SFTP server.
Public methodSupported by the .NET Compact FrameworkPutFile(String, String, Int64, Int64, Int64)
Uploads the specified part of the local file to the specified offset of the file on the SFTP server.
Public methodSupported by the .NET Compact FrameworkPutFiles(String, String, SftpBatchTransferOptions) Obsolete.
Public methodSupported by the .NET Compact FrameworkPutFiles(String, String, SftpBatchTransferOptions, SftpActionOnExistingFiles) Obsolete.
Public methodSupported by the .NET Compact FrameworkRemoveDirectory
Deletes an empty remote directory with the specified pathname.
Public methodSupported by the .NET Compact FrameworkRename
Renames or moves a file or directory on the server.
Public methodSupported by the .NET Compact FrameworkResolveSymlink
Resolves the symlink and returns the real path.
Public methodSupported by the .NET Compact FrameworkSetAttributes
Sets the attributes of the remote file.
Public methodSupported by the .NET Compact FrameworkSetFileDateTime
Sets the modification date and time of the specified remote file.
Public methodSupported by the .NET Compact FrameworkSetSocketFactory
Sets the socket factory to be used to create communication sockets.
Public methodSupported by the .NET Compact FrameworkToString
Returns a string representation of this object.
(Overrides Object..::..ToString()()()().)
Public methodSupported by the .NET Compact FrameworkUpload(String, String)
Uploads the specific local file or directory hierarchy to the directory to the SFTP server. Accepts wildcards.
Public methodSupported by the .NET Compact FrameworkUpload(FileSet, String)
Uploads the specified local files and/or directories to the directory to the SFTP server.
Public methodSupported by the .NET Compact FrameworkUpload(String, String, TraversalMode)
Uploads the specific local file or directory hierarchy to the directory to the SFTP server. Accepts wildcards.
Public methodSupported by the .NET Compact FrameworkUpload(FileSet, String, TransferMethod, ActionOnExistingFiles)
Uploads the specified local files and/or directories to the directory to the SFTP server.
Public methodSupported by the .NET Compact FrameworkUpload(String, String, TraversalMode, TransferMethod, ActionOnExistingFiles)
Uploads the specified local file or directory hierarchy to the directory to the SFTP server. Accepts wildcards.

Fields

  NameDescription
Public fieldStatic memberSupported by the .NET Compact FrameworkDefaultPort
Default SFTP port (22).

Properties

  NameDescription
Public propertySupported by the .NET Compact FrameworkEncoding
Gets or sets the Encoding to use to encode and decode command parameters and server responses.
Public propertySupported by the .NET Compact FrameworkFingerprint
Gets the server public key fingerprint (a SHA-256 hash of the server public key).
Protected propertySupported by the .NET Compact FrameworkInstanceId
Gets instance ID (intended for logging purposes).
(Inherited from NetworkSession.)
Public propertySupported by the .NET Compact FrameworkIsAuthenticated
Gets a value indicating whether the session is authenticated.
(Overrides NetworkSession..::..IsAuthenticated.)
Public propertySupported by the .NET Compact FrameworkIsConnected
Gets a value indicating whether the session is connected.
(Overrides NetworkSession..::..IsConnected.)
Public propertySupported by the .NET Compact FrameworkLocalEndPoint
Gets the local client EndPoint.
Public propertySupported by the .NET Compact FrameworkLogWriter
Gets or sets the LogWriter used by this object.
(Inherited from NetworkSession.)
Public propertySupported by the .NET Compact FrameworkMaxDownloadSpeed
Gets or sets the maximum allowed download speed, in kilobytes per second. For unlimited speed, set this to zero.
Public propertySupported by the .NET Compact FrameworkMaxUploadSpeed
Gets or sets the maximum allowed upload speed, in kilobytes per second. For unlimited speed, set this to zero.
Public propertySupported by the .NET Compact FrameworkOptions Obsolete.
Public propertySupported by the .NET Compact FrameworkProtocolVersion
Gets the SFTP protocol version used by this session. This information is only available on fully initialized and authenticated sessions.
Public propertySupported by the .NET Compact FrameworkProxy
Gets or sets the network proxy to use to access a remote server.
Public propertySupported by the .NET Compact FrameworkRemoteEndPoint
Gets the remote server EndPoint.
Public propertySupported by the .NET Compact FrameworkServerKey
Gets the server public key.
Public propertySupported by the .NET Compact FrameworkServerName
Gets the server name, if available.
(Inherited from NetworkSession.)
Public propertySupported by the .NET Compact FrameworkServerPort
Gets the server port, if available.
(Inherited from NetworkSession.)
Public propertySupported by the .NET Compact FrameworkServerType
Gets or sets the server type.
Public propertySupported by the .NET Compact FrameworkSession
Gets the SSH session used by this SFTP session.
Public propertySupported by the .NET Compact FrameworkSettings
Gets or sets SFTP object settings.
Public propertySupported by the .NET Compact FrameworkState
Public propertySupported by the .NET Compact FrameworkTimeout
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).
Public propertySupported by the .NET Compact FrameworkTransferType
Gets or sets the data transfer type. Make sure to set the ServerType property to the target OS first!
Public propertySupported by the .NET Compact FrameworkUserName
Gets the authenticated user name, if available.
(Inherited from NetworkSession.)
Public propertyStatic memberSupported by the .NET Compact FrameworkVersion
Gets the version of the SFTP component.

Events

  NameDescription
Public eventSupported by the .NET Compact FrameworkAuthenticationRequest
Occurs when an authentication request is received from the server that cannot be answered programmatically.
Public eventSupported by the .NET Compact FrameworkBannerReceived
Occurs when a banner message is received from the server.
Public eventSupported by the .NET Compact FrameworkBatchTransferProblemDetected Obsolete.
Public eventSupported by the .NET Compact FrameworkBatchTransferProgress Obsolete.
Public eventSupported by the .NET Compact FrameworkCommandSent
Occurs when a command is send to the server.
Public eventSupported by the .NET Compact FrameworkDeleteProgressChanged
Occurs when a significant action occurs in Delete method. Notifies the client about currently processing directory, currently deleting file and progress of the delete.
Public eventSupported by the .NET Compact FrameworkFingerprintCheck
Occurs when a fingerprint is received from the server and needs to be validated.
Public eventSupported by the .NET Compact FrameworkListItemReceived
Occurs when a file and directory listing item is received by GetList()()()(), GetRawList()()()(), GetNameList()()()() or GetItems methods.
Public eventSupported by the .NET Compact FrameworkProblemDetected
Occurs when a problem is detected in Download, Upload, Delete or GetItems methods, making it possible for the handler to choose a desired reaction.
Public eventSupported by the .NET Compact FrameworkResponseRead
Occurs when a response is received from the server.
Public eventSupported by the .NET Compact FrameworkStateChanged
Public eventSupported by the .NET Compact FrameworkTransferProgress Obsolete.
Public eventSupported by the .NET Compact FrameworkTransferProgressChanged
Occurs when a significant action occurs in Download, Upload methods. Notifies the client about currently processing directory, currently transferring file and progress of the transfer.
Public eventSupported by the .NET Compact FrameworkTraversing
Occurs when a significant action occurs in Download, Upload, Delete or GetItems methods. Notifies the client about traversing hierarchy structure.

Explicit Interface Implementations

See Also