Skip to main content

OffsetStream Class

Wraps a source stream and offsets all read/write/seek calls by a given value.

Methods

MethodDescription
Close()Closes the underlying stream.
Flush()Flushes the source stream.
Read(buffer, offset, count)Reads a sequence of bytes from the source stream and advances the position within the stream by the number of bytes read.
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.
Seek(offset, origin)Sets the position within the current stream, which is equal to the position within the source stream minus the offset.
SetLength(value)Sets the effective length of the stream, which is equal to the length of the source stream minus the offset.
Write(buffer, offset, count)Writes a sequence of bytes to the source stream and advances the current position within this stream by the number of bytes written.
WriteByte(value)Writes a byte to the current position in the source stream and advances the position within the stream by one byte.

Properties

PropertyDescription
CanReadGets a value indicating whether the source stream supports reading.
CanSeekGets a value indicating whether the source stream supports seeking.
CanWriteGets a value indicating whether the source stream supports writing.
LengthGets the effective length of the stream, which is equal to the length of the source stream minus the offset.
OffsetGets the number of bytes to offset all calls before redirecting to the underlying stream.
PositionGets or sets the effective position of the stream, which is equal to the position of the source stream minus the offset.
SourceGets the underlying stream that this OffsetStream calls into.

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. WixToolset.Dtf.Compression.dll version 5.0.1+2f00cbe680fb01ab485d56f16de9cd19b133f875

Close() Method

Closes the underlying stream.

Declaration

public void Close()

Flush() Method

Flushes the source stream.

Declaration

public void Flush()

Read(buffer, offset, count) Method

Reads a sequence of bytes from the source stream and advances the position within the stream by the number of bytes read.

Declaration

public int Read(
System.Byte[] buffer,
int offset,
int count
)

Parameters

ParameterTypeDescription
bufferSystem.Byte[]An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
offsetintThe zero-based byte offset in buffer at which to begin storing the data read from the current stream.
countintThe maximum number of bytes to be read from the current stream.

Return value

int The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

ReadByte() Method

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.

Declaration

public int ReadByte()

Return value

int The unsigned byte cast to an Int32, or -1 if at the end of the stream.

Seek(offset, origin) Method

Sets the position within the current stream, which is equal to the position within the source stream minus the offset.

Declaration

public System.Int64 Seek(
System.Int64 offset,
System.IO.SeekOrigin origin
)

Parameters

ParameterTypeDescription
offsetSystem.Int64A byte offset relative to the origin parameter.
originSystem.IO.SeekOriginA value of type SeekOrigin indicating the reference point used to obtain the new position.

Return value

System.Int64 The new position within the current stream.

SetLength(value) Method

Sets the effective length of the stream, which is equal to the length of the source stream minus the offset.

Declaration

public void SetLength(
System.Int64 value
)

Parameters

ParameterTypeDescription
valueSystem.Int64The desired length of the current stream in bytes.

Write(buffer, offset, count) Method

Writes a sequence of bytes to the source stream and advances the current position within this stream by the number of bytes written.

Declaration

public void Write(
System.Byte[] buffer,
int offset,
int count
)

Parameters

ParameterTypeDescription
bufferSystem.Byte[]An array of bytes. This method copies count bytes from buffer to the current stream.
offsetintThe zero-based byte offset in buffer at which to begin copying bytes to the current stream.
countintThe number of bytes to be written to the current stream.

WriteByte(value) Method

Writes a byte to the current position in the source stream and advances the position within the stream by one byte.

Declaration

public void WriteByte(
System.Byte value
)

Parameters

ParameterTypeDescription
valueSystem.ByteThe byte to write to the stream.

CanRead Property

Gets a value indicating whether the source stream supports reading.

Declaration

public bool CanRead { get; set; } 

CanSeek Property

Gets a value indicating whether the source stream supports seeking.

Declaration

public bool CanSeek { get; set; } 

CanWrite Property

Gets a value indicating whether the source stream supports writing.

Declaration

public bool CanWrite { get; set; } 

Length Property

Gets the effective length of the stream, which is equal to the length of the source stream minus the offset.

Declaration

public System.Int64 Length { get; set; } 

Offset Property

Gets the number of bytes to offset all calls before redirecting to the underlying stream.

Declaration

public System.Int64 Offset { get; set; } 

Position Property

Gets or sets the effective position of the stream, which is equal to the position of the source stream minus the offset.

Declaration

public System.Int64 Position { get; set; } 

Source Property

Gets the underlying stream that this OffsetStream calls into.

Declaration

public System.IO.Stream Source { get; set; }