StreamReader.ReadToEndAsync Metod

Definition

Namnområde:
System.IO
Sammansättningar:
mscorlib.dll, System.IO.dll
Sammansättningar:
netstandard.dll, System.Runtime.dll
Sammansättning:
System.IO.dll
Sammansättning:
System.Runtime.Extensions.dll
Sammansättning:
mscorlib.dll
Sammansättning:
netstandard.dll

Överlagringar

Name Description
ReadToEndAsync()

Läser alla tecken från den aktuella positionen till slutet av strömmen asynkront och returnerar dem som en sträng.
ReadToEndAsync(CancellationToken)

Läser alla tecken från den aktuella positionen till slutet av strömmen asynkront och returnerar dem som en sträng.

ReadToEndAsync()

Källa:
StreamReader.cs
Källa:
StreamReader.cs
Källa:
StreamReader.cs
Källa:
StreamReader.cs
Källa:
StreamReader.cs

Läser alla tecken från den aktuella positionen till slutet av strömmen asynkront och returnerar dem som en sträng.

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)

Returer

Task<String>

En uppgift som representerar den asynkrona läsåtgärden. Värdet för parametern TResult innehåller en sträng med tecknen från den aktuella positionen till slutet av strömmen.

Attribut
ComVisibleAttribute

Undantag

ArgumentOutOfRangeException

Antalet tecken är större än Int32.MaxValue.

ObjectDisposedException

Strömmen har tagits bort.

InvalidOperationException

Läsaren används för närvarande av en tidigare läsåtgärd.

Exempel

I följande exempel visas hur du läser innehållet i en fil med hjälp ReadToEndAsync() av metoden .

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

Kommentarer

Den här metoden lagrar i aktiviteten som returnerar alla undantag som inte används som metodens synkrona motsvarighet kan utlösa. Om ett undantag lagras i den returnerade aktiviteten utlöses undantaget när aktiviteten väntar. Användningsfel, till exempel ArgumentException, genereras fortfarande synkront. De lagrade undantagen finns i undantagen som genereras av ReadToEnd().

Gäller för

ReadToEndAsync(CancellationToken)

Källa:
StreamReader.cs
Källa:
StreamReader.cs
Källa:
StreamReader.cs
Källa:
StreamReader.cs
Källa:
StreamReader.cs

Läser alla tecken från den aktuella positionen till slutet av strömmen asynkront och returnerar dem som en sträng.

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)

Parametrar

cancellationToken
CancellationToken

Token som ska övervakas för annulleringsbegäranden.

Returer

Task<String>

En uppgift som representerar den asynkrona läsåtgärden. Värdet för parametern TResult innehåller en sträng med tecknen från den aktuella positionen till slutet av strömmen.

Undantag

ArgumentOutOfRangeException

Antalet tecken är större än Int32.MaxValue.

ObjectDisposedException

Strömläsaren har tagits bort.

InvalidOperationException

Läsaren används för närvarande av en tidigare läsåtgärd.

OperationCanceledException

Annulleringstoken avbröts. Det här undantaget lagras i den returnerade aktiviteten.

Kommentarer

Om den här metoden avbryts via cancellationTokenkan vissa data som har lästs från den aktuella Stream men inte lagrats (av StreamReader) eller returnerats (till anroparen) gå förlorade.

Den här metoden lagrar i aktiviteten som returnerar alla undantag som inte används som metodens synkrona motsvarighet kan utlösa. Om ett undantag lagras i den returnerade aktiviteten utlöses undantaget när aktiviteten väntar. Användningsfel, till exempel ArgumentException, genereras fortfarande synkront. De lagrade undantagen finns i undantagen som genereras av ReadToEnd().

Gäller för