FileStream Class

Exposes a stream around a file, supporting both synchronous and asynchronous read and write operations.

Inheritance Hierarchy

System.Object
  CMS.IO.Stream
    CMS.IO.FileStream
      CMS.AmazonStorage.FileStream
      CMS.AzureStorage.FileStream
      CMS.FileSystemStorage.FileStream
      CMS.IO.Zip.ZipFileStream

Namespace: CMS.IO
Assembly: CMS.IO (in CMS.IO.dll) Version: 8.2.23

Syntax

public class FileStream : Stream

The FileStream type exposes the following members.

Constructors

	Name	Description
Protected method	FileStream	Creates new instance of FileStream object.

Methods

	Name	Description
Public method	Close	Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. (Overrides Stream.Close().)
Public method	Dispose	Releases all resources. (Overrides Stream.Dispose().)
Public method	Flush	Clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Overrides Stream.Flush().)
Public method	LogFileOperation	Logs the file operation. Logs the file operation to the file and to current request log for debugging.
Public method Static member	New(String, FileMode)	Initializes new instance and intializes new system file stream.
Public method Static member	New(String, FileMode, FileAccess)	Initializes new instance and intializes new system file stream.
Public method Static member	New(String, FileMode, FileAccess, FileShare)	Initializes new instance and intializes new system file stream.
Public method Static member	New(String, FileMode, FileAccess, FileShare, Int32)	Initializes new instance and intializes new system file stream.
Public method	Read	Reads from stream. (Overrides Stream.Read(Byte[], Int32, Int32).)
Public method	Seek	Sets the position within the current stream to the specified value. (Overrides Stream.Seek(Int64, SeekOrigin).)
Public method	SetLength	Sets length to stream. (Overrides Stream.SetLength(Int64).)
Public method	Write	Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Overrides Stream.Write(Byte[], Int32, Int32).)
Public method	WriteByte	Writes byte to stream. (Overrides Stream.WriteByte(Byte).)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	Length	Gets the length in bytes of the stream. (Overrides Stream.Length.)
Public property	Path	Stream path
Public property	Position	Gets or sets the position within the current stream. (Overrides Stream.Position.)
Public property	SystemStream	Gets or sets system stream. (Overrides Stream.SystemStream.)