Share via


DataInputStream.Read Method

Definition

Overloads

Read(Byte[])

Reads some number of bytes from the contained input stream and stores them into the buffer array b.

Read(Byte[], Int32, Int32)

Reads up to len bytes of data from the contained input stream into an array of bytes.

Read(Byte[])

Reads some number of bytes from the contained input stream and stores them into the buffer array b.

[Android.Runtime.Register("read", "([B)I", "")]
public override sealed int Read (byte[]? b);
[<Android.Runtime.Register("read", "([B)I", "")>]
override this.Read : byte[] -> int

Parameters

b
Byte[]

the buffer into which the data is read.

Returns

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Attributes

Exceptions

Remarks

Reads some number of bytes from the contained input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.

If b is null, a NullPointerException is thrown. If the length of b is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected.

The read(b) method has the same effect as: <blockquote>

read(b, 0, b.length)

</blockquote>

Java documentation for java.io.DataInputStream.read(byte[]).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to

Read(Byte[], Int32, Int32)

Reads up to len bytes of data from the contained input stream into an array of bytes.

[Android.Runtime.Register("read", "([BII)I", "")]
public override sealed int Read (byte[]? b, int off, int len);
[<Android.Runtime.Register("read", "([BII)I", "")>]
override this.Read : byte[] * int * int -> int

Parameters

b
Byte[]

the buffer into which the data is read.

off
Int32

the start offset in the destination array b

len
Int32

the maximum number of bytes read.

Returns

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Attributes

Exceptions

Remarks

Reads up to len bytes of data from the contained input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read, possibly zero. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off] and elements b[off+len] through b[b.length-1] are unaffected.

Java documentation for java.io.DataInputStream.read(byte[], int, int).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to