Share via


PipedReader.Read(Char[], Int32, Int32) Method

Definition

Reads up to len characters of data from this piped stream into an array of characters.

[Android.Runtime.Register("read", "([CII)I", "GetRead_arrayCIIHandler")]
public override int Read (char[]? cbuf, int off, int len);
[<Android.Runtime.Register("read", "([CII)I", "GetRead_arrayCIIHandler")>]
override this.Read : char[] * int * int -> int

Parameters

cbuf
Char[]

the buffer into which the data is read.

off
Int32

the start offset of the data.

len
Int32

the maximum number of characters read.

Returns

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

Attributes

Exceptions

if offset buffer.length.

if the thread reading from this reader is interrupted.

if this reader is closed or not connected to a writer, or if the thread writing to the connected writer is no longer alive.

Remarks

Reads up to len characters of data from this piped stream into an array of characters. Less than len characters will be read if the end of the data stream is reached or if len exceeds the pipe's buffer size. This method blocks until at least one character of input is available.

Java documentation for java.io.PipedReader.read(char[], 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