StringReader.ReadLine Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Reads a line from the underlying string.
Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Overrides Function ReadLine As String
public override string ReadLine()
Return Value
Type: System.String
The next line from the underlying string, or nulla null reference (Nothing in Visual Basic) if the end of the underlying string is reached.
Exceptions
| Exception | Condition |
|---|---|
| ObjectDisposedException | The current reader is closed. |
| OutOfMemoryException | There is insufficient memory to allocate a buffer for the returned string. |
Remarks
This method overrides the TextReader.ReadLine method.
A line is defined as a sequence of characters followed by a line feed ("\n"), a carriage return ("\r"), or a carriage return immediately followed by a line feed ("\r\n"). The resulting string does not contain the terminating carriage return and/or line feed. The returned value is nulla null reference (Nothing in Visual Basic) if the end of the underlying string has been reached.
If the current method throws an OutOfMemoryException, the reader's position in the underlying string is advanced by the number of characters the method was able to read, and the characters already read into the internal ReadLine buffer are discarded. Since the position of the reader in the string cannot be changed, the characters already read are unrecoverable, and can be accessed only by reinitializing the StringReader. To avoid such a situation and produce robust code you should use the Read method and store the read characters in a preallocated buffer.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.