This is experimental documentation.
Represents an MPQ file stream (that is, a stream within an MPQ file).
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class MpqFileStream : Stream, IDisposable
Public Class MpqFileStream _ Inherits Stream _ Implements IDisposable
public ref class MpqFileStream : public Stream, IDisposable
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | BeginRead(array<Byte>[]()[][], Int32, Int32, AsyncCallback, Object) | HostProtectionAttribute. Begins an asynchronous read operation. (Inherited from Stream.) |
| BeginWrite(array<Byte>[]()[][], Int32, Int32, AsyncCallback, Object) | HostProtectionAttribute. Begins an asynchronous write operation. (Inherited from Stream.) |
 | CanRead |
Gets whether the stream supports reading.
(Overrides Stream.CanRead.) |
| CanSeek |
Gets whether the stream supports seeking.
(Overrides Stream.CanSeek.) |
| CanTimeout | Gets a value that determines whether the current stream can time out. (Inherited from Stream.) |
| CanWrite |
Gets whether this stream supports writing.
(Overrides Stream.CanWrite.) |
| Close()()()() | Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. (Inherited from Stream.) |
| CreateObjRef(Type) | 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()()()() |
Disposes the MpqFileStream.
|
| Dispose(Boolean) |
Cleans up unmanaged resources in use.
(Overrides Stream.Dispose(Boolean).) |
| EndRead(IAsyncResult) | Waits for the pending asynchronous read to complete. (Inherited from Stream.) |
| EndWrite(IAsyncResult) | Ends an asynchronous write operation. (Inherited from Stream.) |
| Equals(Object) | (Inherited from Object.) |
| Finalize()()()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| Flush()()()() |
Flushes the buffer to the underlying stream.
(Overrides Stream.Flush()()()().) |
| GetHashCode()()()() | Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (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.) |
| Length |
Gets the length of the stream.
(Overrides Stream.Length.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Name |
Gets the name of the file.
|
| Position |
Gets or sets the offset from the beginning of the stream at which the stream is currently located.
(Overrides Stream.Position.) |
| Read(array<Byte>[]()[][], Int32, Int32) |
Reads data from the underlying stream into the specified buffer.
(Overrides Stream.Read(array<Byte>[]()[][], Int32, Int32).) |
| 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.) |
| ReadTimeout | Gets or sets a value that determines how long the stream will attempt to read before timing out. (Inherited from Stream.) |
| Seek(Int64, SeekOrigin) |
Moves the current location within the stream to the specified location.
(Overrides Stream.Seek(Int64, SeekOrigin).) |
| SetLength(Int64) |
Sets the length of the underlying stream.
(Overrides Stream.SetLength(Int64).) |
| ToString()()()() | (Inherited from Object.) |
| Write(array<Byte>[]()[][], Int32, Int32) |
Writes to the stream.
(Overrides Stream.Write(array<Byte>[]()[][], Int32, Int32).) |
| WriteByte(Byte) | Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from Stream.) |
| WriteTimeout | Gets or sets a value that determines how long the stream will attempt to write before timing out. (Inherited from Stream.) |
Inheritance Hierarchy| Object | |||
 | MarshalByRefObject | ||
| Stream | ||
| MpqFileStream | ||
Assembly: Asgard5Library (Module: Asgard5Library)