.NET Framework Class Library
TextReader..::.Read Method (array<Char>[]()[], Int32, Int32)

Reads a maximum of count characters from the current stream and writes the data to buffer, beginning at index.

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

Visual Basic (Declaration)
Public Overridable Function Read ( _
    <OutAttribute> buffer As Char(), _
    index As Integer, _
    count As Integer _
) As Integer
Visual Basic (Usage)
Dim instance As TextReader
Dim buffer As Char()
Dim index As Integer
Dim count As Integer
Dim returnValue As Integer

returnValue = instance.Read(buffer, index, _
    count)
C#
public virtual int Read(
    char[] buffer,
    int index,
    int count
)
Visual C++
public:
virtual int Read(
    [InAttribute] [OutAttribute] array<wchar_t>^ buffer, 
    int index, 
    int count
)
JScript
public function Read(
    buffer : char[], 
    index : int, 
    count : int
) : int

Parameters

buffer
Type: array<System..::.Char>[]()[]
When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
index
Type: System..::.Int32
The place in buffer at which to begin writing.
count
Type: System..::.Int32
The maximum number of characters to read. If the end of the stream is reached before count of characters is read into buffer, the current method returns.

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 the data is available within the stream. This method returns zero if called when no more characters are left to read.
Exceptions

ExceptionCondition
ArgumentNullException

buffer is nullNothingnullptra null reference (Nothing in Visual Basic).

ArgumentException

The buffer length minus index is less than count.

ArgumentOutOfRangeException

index or count is negative.

ObjectDisposedException

The TextReader is closed.

IOException

An I/O error occurs.

Remarks

This method returns after either count characters are read or the end of the file is reached. ReadBlock is a blocking version of this method.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
See Also

Reference

Other Resources

Tags :


Page view tracker