HttpClient.GetStringAsync Metoda

Definice

Obor názvů:

System.Net.Http

Sestavení:

netstandard.dll, System.Net.Http.dll

Odešle požadavek GET na zadaný identifikátor URI a vrátí text odpovědi jako řetězec v asynchronní operaci.

Přetížení

Name	Description
GetStringAsync(String)	Odešle požadavek GET na zadaný identifikátor URI a vrátí text odpovědi jako řetězec v asynchronní operaci.
GetStringAsync(Uri)	Odešle požadavek GET na zadaný identifikátor URI a vrátí text odpovědi jako řetězec v asynchronní operaci.
GetStringAsync(String, CancellationToken)	Odešle požadavek GET na zadaný identifikátor URI a vrátí text odpovědi jako řetězec v asynchronní operaci.
GetStringAsync(Uri, CancellationToken)	Odešle požadavek GET na zadaný identifikátor URI a vrátí text odpovědi jako řetězec v asynchronní operaci.

Poznámky

Tato operace neblokuje.

GetStringAsync(String)

Zdroj:

HttpClient.cs

Odešle požadavek GET na zadaný identifikátor URI a vrátí text odpovědi jako řetězec v asynchronní operaci.

public:
 System::Threading::Tasks::Task<System::String ^> ^ GetStringAsync(System::String ^ requestUri);

public System.Threading.Tasks.Task<string> GetStringAsync(string? requestUri);

member this.GetStringAsync : string -> System.Threading.Tasks.Task<string>

Public Function GetStringAsync (requestUri As String) As Task(Of String)

Parametry

requestUri

String

Identifikátor URI, na který se požadavek odešle.

Návraty

Task<String>

Objekt úkolu představující asynchronní operaci.

Výjimky

InvalidOperationException

Nejedná se requestUri o absolutní identifikátor URI a BaseAddress není nastavený.

HttpRequestException

Požadavek se nepovedl kvůli problému se získáním platné odpovědi HTTP, jako je selhání síťového připojení, selhání DNS, chyba ověření certifikátu serveru nebo neplatná odpověď serveru. Na .NET 8 a novějších verzích je důvod označen HttpRequestError

nebo

Stavový kód odpovědi byl mimo rozsah 200–299 (který označuje úspěch podle standardu).

nebo

pouze .NET Framework: Vypršel časový limit požadavku.

OperationCanceledException

.NET Core a .NET 5 a novějších verzích: Požadavek selhal kvůli vypršení časového limitu.

UriFormatException

Zadaný identifikátor URI požadavku není platný relativní nebo absolutní identifikátor URI.

Poznámky

Tato operace neblokuje. Vrácený Task<TResult> objekt se dokončí po přečtení celého textu odpovědi. Tato operace interně používá HttpResponseMessage.EnsureSuccessStatusCode k zajištění, že stavový kód odpovědi je v rozsahu úspěchu (200–299) a vyvolá HttpRequestException výjimku, pokud ne. V některých scénářích můžete potřebovat větší kontrolu nad tím, které stavové kódy se považují za úspěšné; Například by se dalo očekávat, že rozhraní API vždy vrátí 200 OK. V takových případech doporučujeme ručně zkontrolovat, jestli StatusCode odpovídá očekávané hodnotě.

Note

V případě časového limitu:

• .NET Framework vyvolá HttpRequestException.
• .NET Core vyvolá OperationCanceledException bez vnitřní výjimky.
• .NET 5 a novějších verzích vyvolá OperationCanceledException, která vnořuje TimeoutException.

GetStringAsync(Uri)

Zdroj:

HttpClient.cs

Odešle požadavek GET na zadaný identifikátor URI a vrátí text odpovědi jako řetězec v asynchronní operaci.

public:
 System::Threading::Tasks::Task<System::String ^> ^ GetStringAsync(Uri ^ requestUri);

public System.Threading.Tasks.Task<string> GetStringAsync(Uri? requestUri);

member this.GetStringAsync : Uri -> System.Threading.Tasks.Task<string>

Public Function GetStringAsync (requestUri As Uri) As Task(Of String)

Parametry

requestUri

Uri

Identifikátor URI, na který se požadavek odešle.

Návraty

Task<String>

Objekt úkolu představující asynchronní operaci.

Výjimky

InvalidOperationException

Nejedná se requestUri o absolutní identifikátor URI a BaseAddress není nastavený.

HttpRequestException

Požadavek se nepovedl kvůli problému se získáním platné odpovědi HTTP, jako je selhání síťového připojení, selhání DNS, chyba ověření certifikátu serveru nebo neplatná odpověď serveru. Na .NET 8 a novějších verzích je důvod označen HttpRequestError

nebo

Stavový kód odpovědi byl mimo rozsah 200–299 (který označuje úspěch podle standardu).

nebo

pouze .NET Framework: Vypršel časový limit požadavku.

OperationCanceledException

.NET Core a .NET 5 a novějších verzích: Požadavek selhal kvůli vypršení časového limitu.

Poznámky

Tato operace neblokuje. Vrácený Task<TResult> objekt se dokončí po přečtení celého textu odpovědi. Tato operace interně používá HttpResponseMessage.EnsureSuccessStatusCode k zajištění, že stavový kód odpovědi je v rozsahu úspěchu (200–299) a vyvolá HttpRequestException výjimku, pokud ne. V některých scénářích můžete potřebovat větší kontrolu nad tím, které stavové kódy se považují za úspěšné; Například by se dalo očekávat, že rozhraní API vždy vrátí 200 OK. V takových případech doporučujeme ručně zkontrolovat, jestli StatusCode odpovídá očekávané hodnotě.

Note

V případě časového limitu:

• .NET Framework vyvolá HttpRequestException.
• .NET Core vyvolá OperationCanceledException bez vnitřní výjimky.
• .NET 5 a novějších verzích vyvolá OperationCanceledException, která vnořuje TimeoutException.

GetStringAsync(String, CancellationToken)

Zdroj:

HttpClient.cs

Odešle požadavek GET na zadaný identifikátor URI a vrátí text odpovědi jako řetězec v asynchronní operaci.

public:
 System::Threading::Tasks::Task<System::String ^> ^ GetStringAsync(System::String ^ requestUri, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<string> GetStringAsync(string? requestUri, System.Threading.CancellationToken cancellationToken);

member this.GetStringAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Function GetStringAsync (requestUri As String, cancellationToken As CancellationToken) As Task(Of String)

Parametry

requestUri

String

Identifikátor URI, na který se požadavek odešle.

cancellationToken

CancellationToken

Token zrušení pro zrušení operace.

Návraty

Task<String>

Objekt úkolu představující asynchronní operaci.

Výjimky

ArgumentNullException

To requestUri je null.

HttpRequestException

Požadavek se nepovedl kvůli problému se získáním platné odpovědi HTTP, jako je selhání síťového připojení, selhání DNS, chyba ověření certifikátu serveru nebo neplatná odpověď serveru. Na .NET 8 a novějších verzích je důvod označen HttpRequestError

nebo

Stavový kód odpovědi byl mimo rozsah 200–299 (který označuje úspěch podle standardu).

UriFormatException

Zadaný identifikátor URI požadavku není platný relativní nebo absolutní identifikátor URI.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.

nebo

.NET Core a .NET 5 a novějších verzích: Požadavek selhal kvůli vypršení časového limitu.

Poznámky

Tato operace neblokuje. Vrácený Task<TResult> objekt se dokončí po přečtení celého textu odpovědi. Tato operace interně používá HttpResponseMessage.EnsureSuccessStatusCode k zajištění, že stavový kód odpovědi je v rozsahu úspěchu (200–299) a vyvolá HttpRequestException výjimku, pokud ne. V některých scénářích můžete potřebovat větší kontrolu nad tím, které stavové kódy se považují za úspěšné; Například by se dalo očekávat, že rozhraní API vždy vrátí 200 OK. V takových případech doporučujeme ručně zkontrolovat, jestli StatusCode odpovídá očekávané hodnotě.

Note

V případě časového limitu:

• .NET Framework vyvolá HttpRequestException.
• .NET Core vyvolá OperationCanceledException bez vnitřní výjimky.
• .NET 5 a novějších verzích vyvolá OperationCanceledException, která vnořuje TimeoutException.

GetStringAsync(Uri, CancellationToken)

Zdroj:

HttpClient.cs

Odešle požadavek GET na zadaný identifikátor URI a vrátí text odpovědi jako řetězec v asynchronní operaci.

public:
 System::Threading::Tasks::Task<System::String ^> ^ GetStringAsync(Uri ^ requestUri, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<string> GetStringAsync(Uri? requestUri, System.Threading.CancellationToken cancellationToken);

member this.GetStringAsync : Uri * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Function GetStringAsync (requestUri As Uri, cancellationToken As CancellationToken) As Task(Of String)

Parametry

requestUri

Uri

Identifikátor URI, na který se požadavek odešle.

cancellationToken

CancellationToken

Token zrušení pro zrušení operace.

Návraty

Task<String>

Objekt úkolu představující asynchronní operaci.

Výjimky

ArgumentNullException

To requestUri je null.

HttpRequestException

Požadavek se nepovedl kvůli problému se získáním platné odpovědi HTTP, jako je selhání síťového připojení, selhání DNS, chyba ověření certifikátu serveru nebo neplatná odpověď serveru. Na .NET 8 a novějších verzích je důvod označen HttpRequestError

nebo

Stavový kód odpovědi byl mimo rozsah 200–299 (který označuje úspěch podle standardu).

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.

nebo

.NET Core a .NET 5 a novějších verzích: Požadavek selhal kvůli vypršení časového limitu.

Poznámky

Tato operace neblokuje. Vrácený Task<TResult> objekt se dokončí po přečtení celého textu odpovědi. Tato operace interně používá HttpResponseMessage.EnsureSuccessStatusCode k zajištění, že stavový kód odpovědi je v rozsahu úspěchu (200–299) a vyvolá HttpRequestException výjimku, pokud ne. V některých scénářích můžete potřebovat větší kontrolu nad tím, které stavové kódy se považují za úspěšné; Například by se dalo očekávat, že rozhraní API vždy vrátí 200 OK. V takových případech doporučujeme ručně zkontrolovat, jestli StatusCode odpovídá očekávané hodnotě.

Note

V případě časového limitu:

• .NET Framework vyvolá HttpRequestException.
• .NET Core vyvolá OperationCanceledException bez vnitřní výjimky.
• .NET 5 a novějších verzích vyvolá OperationCanceledException, která vnořuje TimeoutException.