Click or drag to resize

SftpFileStream Class

Exposes a System.IO.Stream around a remote SFTP file, supporting both synchronous and asynchronous read and write operations.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharp.CrestronIOStream
    Crestron.SimplSharp.Ssh.SftpSftpFileStream

Namespace: Crestron.SimplSharp.Ssh.Sftp
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public class SftpFileStream : Stream

The SftpFileStream type exposes the following members.

Properties
 NameDescription
Public propertyCanRead Gets a value indicating whether the current stream supports reading.
(Overrides StreamCanRead)
Public propertyCanSeek Gets a value indicating whether the current stream supports seeking.
(Overrides StreamCanSeek)
Public propertyCanTimeout Gets a value that determines whether the current stream can time out.
(Inherited from Stream)
Public propertyCanWrite Gets a value indicating whether the current stream supports writing.
(Overrides StreamCanWrite)
Public propertyHandle Gets the operating system file handle for the file that the current SftpFileStream object encapsulates.
Public propertyIsAsync Gets a value indicating whether the FileStream was opened asynchronously or synchronously.
Public propertyLength Gets the length in bytes of the stream.
(Overrides StreamLength)
Public propertyName Gets the name of the FileStream that was passed to the constructor.
Public propertyPosition Gets or sets the position within the current stream.
(Overrides StreamPosition)
Public propertyReadTimeout Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream)
Public propertyTimeout Gets or sets the operation timeout.
Public propertyWriteTimeout Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream)
Top
Methods
 NameDescription
Public methodBeginRead Begins an asynchronous read operation.
(Inherited from Stream)
Public methodBeginWrite Begins an asynchronous write operation.
(Inherited from Stream)
Public methodClose Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
(Overrides StreamClose)
Public methodDispose Releases all resources used by the Crestron.SimplSharp.CrestronStream.Stream.
(Inherited from Stream)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
(Overrides StreamDispose(Boolean))
Public methodEndRead Waits for the pending asynchronous read to complete.
(Inherited from Stream)
Public methodEndWrite Ends an asynchronous write operation.
(Inherited from Stream)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases unmanaged resources and performs other cleanup operations before the SftpFileStream is reclaimed by garbage collection.
(Overrides ObjectFinalize)
Public methodFlush Clears all buffers for this stream and causes any buffered data to be written to the file.
(Overrides StreamFlush)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodRead Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
(Overrides StreamRead(Byte, Int32, Int32))
Public methodReadByte Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
(Overrides StreamReadByte)
Public methodSeek Sets the position within the current stream.
(Overrides StreamSeek(Int64, SeekOrigin))
Public methodSetLength When overridden in a derived class, sets the length of the current stream.
(Overrides StreamSetLength(Int64))
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodWrite Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
(Overrides StreamWrite(Byte, Int32, Int32))
Public methodWriteByte Writes a byte to the current position in the stream and advances the position within the stream by one byte.
(Overrides StreamWriteByte(Byte))
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also