Deployment Tools Foundation
OffsetStream Class
Deployment Tools Foundation Namespaces ► Microsoft.Deployment.Compression ► OffsetStream
Wraps a source stream and offsets all read/write/seek calls by a given value.
Declaration Syntax| C# | Visual Basic | Visual C++ | F# |
public class OffsetStream : Stream
Public Class OffsetStream Inherits Stream
public ref class OffsetStream : public Stream
type OffsetStream = class inherit Stream end
Members| All Members | Constructors | Methods | Properties | ||
|
|
|
|
|||
| Icon | Member | Description |
|---|---|---|
|
OffsetStream(Stream, Int64) |
Creates a new OffsetStream instance from a source stream
and using a specified offset.
|
|
|
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 a value indicating whether the source stream supports reading.
(Overrides Stream.CanRead.) |
|
|
CanSeek |
Gets a value indicating whether the source stream supports seeking.
(Overrides Stream.CanSeek.) |
|
|
CanTimeout | Gets a value that determines whether the current stream can time out. (Inherited from Stream.) |
|
|
CanWrite |
Gets a value indicating whether the source stream supports writing.
(Overrides Stream.CanWrite.) |
|
|
Close()()()() |
Closes the underlying stream.
(Overrides Stream.Close()()()().) |
|
|
CopyTo(Stream) | Reads the bytes from the current stream and writes them to the destination stream. (Inherited from Stream.) |
|
|
CopyTo(Stream, Int32) | Reads all the bytes from the current stream and writes them to a destination stream, using a specified buffer size. (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()()()() | Releases all resources used by the Stream. (Inherited from Stream.) |
|
|
Dispose(Boolean) | Releases the unmanaged resources used by the Stream and optionally releases the managed resources. (Inherited from Stream.) |
|
|
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 try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
Flush()()()() |
Flushes the source stream.
(Overrides Stream.Flush()()()().) |
|
|
GetHashCode()()()() | Serves as a hash function for a particular type. (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 effective length of the stream, which is equal to
the length of the source stream minus the offset.
(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.) |
|
|
ObjectInvariant()()()() | Provides support for a Contract. (Inherited from Stream.) |
|
|
Offset |
Gets the number of bytes to offset all calls before
redirecting to the underlying stream.
|
|
|
Position |
Gets or sets the effective position of the stream, which
is equal to the position of the source stream minus the offset.
(Overrides Stream.Position.) |
|
|
Read(array<Byte>[]()[][], Int32, Int32) |
Reads a sequence of bytes from the source stream and advances
the position within the stream by the number of bytes read.
(Overrides Stream.Read(array<Byte>[]()[][], Int32, Int32).) |
|
|
ReadByte()()()() |
Reads a byte from the stream and advances the position within the
source stream by one byte, or returns -1 if at the end of the stream.
(Overrides Stream.ReadByte()()()().) |
|
|
ReadTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.) |
|
|
Seek(Int64, SeekOrigin) |
Sets the position within the current stream, which is
equal to the position within the source stream minus the offset.
(Overrides Stream.Seek(Int64, SeekOrigin).) |
|
|
SetLength(Int64) |
Sets the effective length of the stream, which is equal to
the length of the source stream minus the offset.
(Overrides Stream.SetLength(Int64).) |
|
|
Source |
Gets the underlying stream that this OffsetStream calls into.
|
|
|
ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
|
|
Write(array<Byte>[]()[][], Int32, Int32) |
Writes a sequence of bytes to the source stream and advances the
current position within this stream by the number of bytes written.
(Overrides Stream.Write(array<Byte>[]()[][], Int32, Int32).) |
|
|
WriteByte(Byte) |
Writes a byte to the current position in the source stream and
advances the position within the stream by one byte.
(Overrides Stream.WriteByte(Byte).) |
|
|
WriteTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.) |
Remarks
This class is used to trick archive an packing or unpacking process
into reading or writing at an offset into a file, primarily for
self-extracting packages.
Inheritance Hierarchy| Object | |||
|
MarshalByRefObject | ||
|
|
Stream | ||
|
|
OffsetStream | ||
Assembly: Microsoft.Deployment.Compression (Module: Microsoft.Deployment.Compression.dll) Version: 3.0.0.0 (3.11.1.2318)