Click or drag to resize

FileStream Class

SimplSharp.CrestronIO FileStream Instance of a file supporting synchronous read and write operations.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharp.CrestronIOStream
    Crestron.SimplSharp.CrestronIOFileStream

Namespace: Crestron.SimplSharp.CrestronIO
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public class FileStream : Stream

The FileStream type exposes the following members.

Constructors
 NameDescription
Public methodFileStream(String, FileMode) Initializes a new instance of the CrestronIO.FileStream class with the specified path and creation mode.
Public methodFileStream(String, FileMode, FileAccess) Initialize the FileStream with the specified path, mode, and access.
Public methodFileStream(String, FileMode, FileAccess, FileShare) Initializes a new instance of the CrestronIO.FileStream class with the specified path, creation mode, read/write permission, and sharing permission.
Top
Properties
 NameDescription
Public propertyCanRead Returns true if the stream supports reading.
(Overrides StreamCanRead)
Public propertyCanSeek Returns true if the stream supports seeking.
(Overrides StreamCanSeek)
Public propertyCanTimeout Gets a value that determines whether the current stream can time out.
(Overrides StreamCanTimeout)
Public propertyCanWrite Returns true if the stream supports writing.
(Overrides StreamCanWrite)
Public propertyIsAsync Gets a value indicating whether the FileStream was opened asynchronously or synchronously.
Public propertyLength Get the length of the stream in bytes.
(Overrides StreamLength)
Public propertyName Gets the name of the FileStream that was passed to the constructor.
Public propertyPosition Get or set the current position in the 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.
(Overrides StreamReadTimeout)
Public propertyWriteTimeout Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
(Overrides StreamWriteTimeout)
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.
(Inherited from Stream)
Public methodDispose Releases all resources used by the Crestron.SimplSharp.CrestronStream.Stream.
(Inherited from Stream)
Protected methodDispose(Boolean) Checks to see if Dispose has already been called.
(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 Destructor for FileStream.
(Overrides ObjectFinalize)
Public methodFlush Clears all buffers for the stream and writes any cleared data to the file system.
(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 Read bytes from a stream in to the specified buffer.
(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 current position of the stream.
(Overrides StreamSeek(Int64, SeekOrigin))
Public methodSetLength Sets the length of the stream
(Overrides StreamSetLength(Int64))
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodWrite(String, Encoding) Function to write a string to the stream using the specified encoding.
Public methodWrite(Byte, Int32, Int32) Write bytes to a stream using the buffer as data.
(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