StringReader.Read Method (array<Char>[]()[], Int32, Int32)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Reads a block of characters from the input string and advances the character position by count.

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

Syntax

Public Overrides Function Read ( _
    buffer As Char(), _
    index As Integer, _
    count As Integer _
) As Integer
public override int Read(
    char[] buffer,
    int index,
    int count
)

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.

Return Value

Type: System..::.Int32
The total number of characters read into the buffer. This can be less than the number of characters requested if that many characters are not currently available, or zero if the end of the underlying string has been reached.

Exceptions

Exception Condition
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 current reader is closed.

Remarks

This method overrides TextReader..::.Read.

The method will read up to count characters from the StringReader into the buffer character array starting at position index. Returns the actual number of characters read, or zero if the end of the string has been reached and no characters are read.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

StringReader Class

Read Overload

System.IO Namespace