AtalaFileStream Class |
A custom Stream object that is used to read and write images to a file. This is the default stream object
used when specifying filenames for images. Deprecated, use AtalaFile64Stream in preferance to this class.
Inheritance HierarchySystem.Object
System.MarshalByRefObject
System.IO.Stream
Atalasoft.Imaging.AtalaFileStream
System.MarshalByRefObject
System.IO.Stream
Atalasoft.Imaging.AtalaFileStream
Namespace: Atalasoft.Imaging
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
SyntaxThe AtalaFileStream type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AtalaFileStream | Initializes a new instance of AtalaFileStream. |
Properties| Name | Description | |
|---|---|---|
 | CanRead | Gets a value indicating if the stream can be read. (Overrides Stream.CanRead.) |
| CanSeek | Gets a value indicating if the steam is seekable. (Overrides Stream.CanSeek.) |
| CanTimeout | Gets a value that determines whether the current stream can time out. (Inherited from Stream.) |
| CanWrite | Gets a value indicating if the stream can be written to. (Overrides Stream.CanWrite.) |
| Handle | Gets or sets the unmanaged handle to the file stream. |
| Length | Gets the length of the stream in bytes. (Overrides Stream.Length.) |
| Name | Gets the name of the file for this stream. |
| Position | Gets the current position of the stream pointer. (Overrides Stream.Position.) |
| ReadTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.) |
| WriteTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.) |
Methods| Name | Description | |
|---|---|---|
| BeginRead | Begins an asynchronous read operation. (Consider using ReadAsync(Byte[], Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.) |
| BeginWrite | Begins an asynchronous write operation. (Consider using WriteAsync(Byte[], Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.) |
| Close | Closes the stream. (Overrides Stream.Close().) |
| CopyTo(Stream) | Reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.) |
| CopyTo(Stream, Int32) | Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.) |
| CopyToAsync(Stream) | Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.) |
| CopyToAsync(Stream, Int32) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.) |
| CopyToAsync(Stream, Int32, CancellationToken) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. (Inherited from Stream.) |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
 | CreateWaitHandle | Obsolete. Allocates a WaitHandle object. (Inherited from Stream.) |
| Dispose() | This will dispose of any resources used by the stream. |
| Dispose(Boolean) | Releases the unmanaged resources used by the Stream and optionally releases the managed resources. (Inherited from Stream.) |
| EndRead | Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte[], Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.) |
| EndWrite | Ends an asynchronous write operation. (Consider using WriteAsync(Byte[], Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Flush | Forces any unwritten data to be committed. (Overrides Stream.Flush().) |
| FlushAsync() | Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream.) |
| FlushAsync(CancellationToken) | Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. (Inherited from Stream.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| MemberwiseClone() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| ObjectInvariant | Obsolete. Provides support for a Contract. (Inherited from Stream.) |
| Read | Reads data from the stream into a byte array. (Overrides Stream.Read(Byte[], Int32, Int32).) |
| ReadAsync(Byte[], Int32, Int32) | Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream.) |
| ReadAsync(Byte[], Int32, Int32, CancellationToken) | Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from Stream.) |
| ReadByte | 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. (Inherited from Stream.) |
| Seek() | Moves the file pointer to the beginning of the stream. |
| Seek(Int64, SeekOrigin) | Moves the file pointer to a specific position within the stream. (Overrides Stream.Seek(Int64, SeekOrigin).) |
| SetLength | Sets the size of the stream. (Overrides Stream.SetLength(Int64).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Write | Writes data to the stream. (Overrides Stream.Write(Byte[], Int32, Int32).) |
| WriteAsync(Byte[], Int32, Int32) | Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Stream.) |
| WriteAsync(Byte[], Int32, Int32, CancellationToken) | Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. (Inherited from Stream.) |
| WriteByte | Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from Stream.) |
Fields| Name | Description | |
|---|---|---|
 | Access | Determines whether this stream is a source or destination stream. |
| CanReadAFS | Gets a value indicating if the stream can be read. |
| CanSeekAFS | Gets a value indicating if the steam is seekable. |
| CanWriteAFS | Gets a value indicating if the stream can be written to. |
| Source | Gets the unmanaged handle to the file stream. |
Remarks This File Stream object is approximately 20% faster than the System.IO.FileStream object
for loading images.
See Also