CachedFileStreamRead Method

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: GSF.IO
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.248-beta+a497a19de709fd99e2448886199a2c8824265ddf

Syntax

C++

JavaScript

Copy

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

Public Overrides Function Read ( 
	buffer As Byte(),
	offset As Integer,
	count As Integer
) As Integer

public:
virtual int Read(
	array<unsigned char>^ buffer, 
	int offset, 
	int count
) override

abstract Read : 
        buffer : byte[] * 
        offset : int * 
        count : int -> int 
override Read : 
        buffer : byte[] * 
        offset : int * 
        count : int -> int

function Read(buffer, offset, count);

View Source

Parameters

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

Return Value

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

Exception	Condition
ArgumentException	offset and count describe an invalid range in buffer.
ArgumentNullException	buffer is null.
ArgumentOutOfRangeException	offset or count is negative.
IOException	An I/O error occurs.
NotSupportedException	The stream does not support reading.
ObjectDisposedException	Methods were called after the stream was closed.

Reference

CachedFileStream Class

GSF.IO Namespace