TextReader.ReadLineAsync Method

.NET Framework 4.5

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

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

[ComVisibleAttribute(false)]
[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public virtual Task<string> ReadLineAsync()

Return Value

Type: System.Threading.Tasks.Task<String>
A task that represents the asynchronous read operation. The value of the TResult parameter contains the next line from the text reader, or is null if all of the characters have been read.

ExceptionCondition
ArgumentOutOfRangeException

The number of characters in the next line is larger than MaxValue.

ObjectDisposedException

The text reader has been disposed.

InvalidOperationException

The reader is currently in use by a previous read operation.

The TextReader class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the ReadLineAsync method, see the StreamReader.ReadLineAsync method.

If the current TextReader represents the standard input stream returned by the Console.In property, the ReadLineAsync method executes synchronously rather than asynchronously.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.6, 4.5

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft