HeaderedStreamRead Method Document Toolkit Help
When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Namespace: FirstFloor.Documents.IO
Assembly: FirstFloor.Documents (in FirstFloor.Documents.dll) Version: 2.5.0.0 (2.5.11.0)
Syntax

public override int Read(
	byte[] buffer,
	int offset,
	int count
)

Parameters

buffer
Type: SystemByte
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.
offset
Type: SystemInt32
The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
count
Type: SystemInt32
The maximum number of bytes to be read from the current stream.

Return Value

Type: Int32
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.
Exceptions

ExceptionCondition
ArgumentExceptionThe sum of offset and count is larger than the buffer length.
ArgumentNullExceptionbuffer is null.
ArgumentOutOfRangeExceptionoffset or count is negative.
IOExceptionAn I/O error occurs.
NotSupportedExceptionThe stream does not support reading.
ObjectDisposedExceptionMethods were called after the stream was closed.
See Also

Reference