System.IO.StringReader.ReadLine Method

Reads a line of characters from the current string and returns the data as a string.

Syntax

public override string ReadLine ()

Returns

The next line from the current string, or null if the end of the string is reached.

Exceptions

TypeReason
ObjectDisposedExceptionThe current reader is closed.
OutOfMemoryExceptionThere 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 string that is returned does not contain the terminating carriage return or line feed. The returned value is null if the end of the 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, but the characters already read into the internal StringReader.ReadLine buffer are discarded. Because 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 System.IO.StringReader. To avoid such a situation, use the StringReader.Read method and store the read characters in a preallocated buffer.

The following table lists examples of other typical or related I/O tasks.

Create a text file.

[<topic://cpconwritingtexttofile>]

Write to a text file.

[<topic://cpconwritingtexttofile>]

Read from a text file.

[<topic://cpconreadingtextfromfile>]

Append text to a file.

[<topic://cpconopeningappendingtologfile>]

File.AppendText(string)

FileInfo.AppendText

Get the size of a file.

FileInfo.Length

Get the attributes of a file.

File.GetAttributes(string)

Set the attributes of a file.

File.SetAttributes(string, FileAttributes)

Determine if a file exists.

File.Exists(string)

Read from a binary file.

[<topic://cpconReadingWritingToNewlyCreatedDataFile>]

Write to a binary file.

[<topic://cpconReadingWritingToNewlyCreatedDataFile>]

Requirements

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0