SftpFileStream MembersSSH .NET Client Library Documentation

The SftpFileStream type exposes the following members.
Methods

  NameDescription
Public methodBeginRead
Begins an asynchronous read operation.
(Overrides OnlineStream BeginRead( Byte , Int32, Int32, AsyncCallback, Object).)
Public methodBeginWrite
Begins an asynchronous write operation.
(Overrides OnlineStream BeginWrite( Byte , Int32, Int32, AsyncCallback, Object).)
Public methodClose
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
(Overrides OnlineStream Close .)
Public methodOnlineCopyTo(Stream)
Reads all the bytes from the current stream and writes them to the destination stream.
(Inherited from OnlineStream.)
Public methodOnlineCopyTo(Stream, Int32)
Reads all the bytes from the current stream and writes them to a destination stream, using a specified buffer size.
(Inherited from OnlineStream.)
Public methodOnlineCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from OnlineMarshalByRefObject.)
Protected methodOnlineCreateWaitHandleObsolete.
Allocates a OnlineWaitHandle object.
(Inherited from OnlineStream.)
Public methodOnlineDispose 
Releases all resources used by the OnlineStream.
(Inherited from OnlineStream.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the OnlineStream and optionally releases the managed resources.
(Overrides OnlineStream Dispose(Boolean).)
Public methodEndRead
Waits for the pending asynchronous read to complete.
(Overrides OnlineStream EndRead(IAsyncResult).)
Public methodEndWrite
Ends an asynchronous write operation.
(Overrides OnlineStream EndWrite(IAsyncResult).)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the SftpFileStream is reclaimed by garbage collection.
(Overrides OnlineObject Finalize .)
Public methodFlush
Clears all buffers for this stream and causes any buffered data to be written to the file.
(Overrides OnlineStream Flush .)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from OnlineMarshalByRefObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodOnlineInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from OnlineMarshalByRefObject.)
Protected methodOnlineMemberwiseClone 
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineMemberwiseClone(Boolean)
Creates a shallow copy of the current OnlineMarshalByRefObject object.
(Inherited from OnlineMarshalByRefObject.)
Protected methodOnlineObjectInvariant
Provides support for a OnlineContract.
(Inherited from OnlineStream.)
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 OnlineStream Read( 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 OnlineStream ReadByte .)
Public methodSeek
Sets the position within the current stream.
(Overrides OnlineStream Seek(Int64, SeekOrigin).)
Public methodSetLength
When overridden in a derived class, sets the length of the current stream.
(Overrides OnlineStream SetLength(Int64).)
Public methodOnlineToString
Returns a OnlineString that represents the current OnlineObject.
(Inherited from OnlineObject.)
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 OnlineStream Write( 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 OnlineStream WriteByte(Byte).)
Back to Top
Properties

  NameDescription
Public propertyCanRead
Gets a value indicating whether the current stream supports reading.
(Overrides OnlineStream CanRead.)
Public propertyCanSeek
Gets a value indicating whether the current stream supports seeking.
(Overrides OnlineStream CanSeek.)
Public propertyOnlineCanTimeout
Gets a value that determines whether the current stream can time out.
(Inherited from OnlineStream.)
Public propertyCanWrite
Gets a value indicating whether the current stream supports writing.
(Overrides OnlineStream CanWrite.)
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 OnlineStream Length.)
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 OnlineStream Position.)
Public propertyOnlineReadTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from OnlineStream.)
Public propertyTimeout
Gets or sets the operation timeout.
Public propertyOnlineWriteTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from OnlineStream.)
Back to Top
See Also