StreamReader.ReadLine Method
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Reads a line of characters from the current stream and returns the data as a string.
Assembly: mscorlib (in mscorlib.dll)
Return Value
Type: System.StringThe next line from the input stream, or Nothing if the end of the input stream is reached.
| Exception | Condition |
|---|---|
| OutOfMemoryException | There is insufficient memory to allocate a buffer for the returned string. |
| IOException | An I/O error occurs. |
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 string that is returned does not contain the terminating carriage return or line feed. The returned value is Nothing if the end of the input stream is reached.
This method overrides ReadLine.
If the current method throws an OutOfMemoryException, the reader's position in the underlying Stream object is advanced by the number of characters the method was able to read, but the characters already read into the internal ReadLine buffer are discarded. If you manipulate the position of the underlying stream after reading data into the buffer, the position of the underlying stream might not match the position of the internal buffer. To reset the internal buffer, call the DiscardBufferedData method; however, this method slows performance and should be called only when absolutely necessary.