Share via


ReadBlock Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Reads a specified maximum number of characters from the current text reader and writes the data to a buffer, beginning at the specified index.

Namespace:  System.IO
Assembly:  System.IO (in System.IO.dll)

Syntax

'Declaration
Public Overridable Function ReadBlock ( _
    buffer As Char(), _
    index As Integer, _
    count As Integer _
) As Integer
public virtual int ReadBlock(
    char[] buffer,
    int index,
    int count
)
public:
virtual int ReadBlock(
    array<wchar_t>^ buffer, 
    int index, 
    int count
)
abstract ReadBlock : 
        buffer:char[] * 
        index:int * 
        count:int -> int 
override ReadBlock : 
        buffer:char[] * 
        index:int * 
        count:int -> int 
public function ReadBlock(
    buffer : char[], 
    index : int, 
    count : int
) : int

Parameters

  • buffer
    Type: array<System. . :: . .Char> [] () [] []
    When this method returns, this parameter contains the specified character array with the values between index and (index + count -1) replaced by the characters read from the current source.

Return Value

Type: System. . :: . .Int32
The number of characters that have been read. The number will be less than or equal to count, depending on whether all input characters have been read.

Remarks

The position of the underlying text reader is advanced by the number of characters that were read into buffer.

The method blocks until either count characters are read, or all characters have been read. This is a blocking version of Read.

.NET Framework Security

See Also

Reference

TextReader Class

System.IO Namespace