StreamReader.ReadToEndAsync 方法

定义

命名空间:
System.IO
程序集:
mscorlib.dll, System.IO.dll
程序集:
netstandard.dll, System.Runtime.dll
程序集:
System.IO.dll
程序集:
System.Runtime.Extensions.dll
程序集:
mscorlib.dll
程序集:
netstandard.dll

重载

名称 说明
ReadToEndAsync()

以异步方式读取从当前位置到流末尾的所有字符，并将其作为一个字符串返回。
ReadToEndAsync(CancellationToken)

以异步方式读取从当前位置到流末尾的所有字符，并将其作为一个字符串返回。

ReadToEndAsync()

Source:
StreamReader.cs
Source:
StreamReader.cs
Source:
StreamReader.cs
Source:
StreamReader.cs
Source:
StreamReader.cs

以异步方式读取从当前位置到流末尾的所有字符，并将其作为一个字符串返回。

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync();
public override System.Threading.Tasks.Task<string> ReadToEndAsync();
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<string> ReadToEndAsync();
override this.ReadToEndAsync : unit -> System.Threading.Tasks.Task<string>
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadToEndAsync : unit -> System.Threading.Tasks.Task<string>
Public Overrides Function ReadToEndAsync () As Task(Of String)

返回

Task<String>

表示异步读取操作的任务。 参数的值 TResult 包含一个字符串，其中包含从当前位置到流末尾的字符。

属性
ComVisibleAttribute

例外

ArgumentOutOfRangeException

字符数大于 Int32.MaxValue。

ObjectDisposedException

流已释放。

InvalidOperationException

读取器当前正由以前的读取操作使用。

示例

以下示例演示如何使用 ReadToEndAsync() 该方法读取文件的内容。

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static async Task Main()
        {
            await ReadCharacters();
        }

        static async Task ReadCharacters()
        {
            String result;
            using (StreamReader reader = File.OpenText("existingfile.txt"))
            {
                Console.WriteLine("Opened file.");
                result = await reader.ReadToEndAsync();
                Console.WriteLine("Contains: " + result);
            }
        }
    }
}

Imports System.IO

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim result As String

        Using reader As StreamReader = File.OpenText("existingfile.txt")
            Console.WriteLine("Opened file.")
            result = Await reader.ReadToEndAsync()
            Console.WriteLine("Contains: " + result)
        End Using
    End Sub
End Module

注解

此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中，则等待任务时将引发该异常。 使用情况异常（例如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅由 ReadToEnd()..

适用于

ReadToEndAsync(CancellationToken)

Source:
StreamReader.cs
Source:
StreamReader.cs
Source:
StreamReader.cs
Source:
StreamReader.cs
Source:
StreamReader.cs

以异步方式读取从当前位置到流末尾的所有字符，并将其作为一个字符串返回。

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync(System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<string> ReadToEndAsync(System.Threading.CancellationToken cancellationToken);
override this.ReadToEndAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
Public Overrides Function ReadToEndAsync (cancellationToken As CancellationToken) As Task(Of String)

参数

cancellationToken
CancellationToken

用于监视取消请求的令牌。

返回

Task<String>

表示异步读取操作的任务。 参数的值 TResult 包含一个字符串，其中包含从当前位置到流末尾的字符。

例外

ArgumentOutOfRangeException

字符数大于 Int32.MaxValue。

ObjectDisposedException

流读取器已释放。

InvalidOperationException

读取器当前正由以前的读取操作使用。

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

如果通过 cancellationToken此方法取消，则从当前 Stream 但未存储（由 StreamReader该调用方）或返回的（调用方）读取的某些数据可能会丢失。

此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中，则等待任务时将引发该异常。 使用情况异常（例如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅由 ReadToEnd()..

适用于