HttpClient.GetStringAsync Method

Definition

Send a GET request to the specified Uri and return the response body as a string in an asynchronous operation.

Overloads

GetStringAsync(String)

Send a GET request to the specified Uri and return the response body as a string in an asynchronous operation.

GetStringAsync(Uri)

Send a GET request to the specified Uri and return the response body as a string in an asynchronous operation.

GetStringAsync(String, CancellationToken)

Send a GET request to the specified Uri and return the response body as a string in an asynchronous operation.

GetStringAsync(Uri, CancellationToken)

Send a GET request to the specified Uri and return the response body as a string in an asynchronous operation.

Remarks

This operation will not block.

GetStringAsync(String)

Source:
HttpClient.cs
Source:
HttpClient.cs
Source:
HttpClient.cs

Send a GET request to the specified Uri and return the response body as a string in an asynchronous operation.

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

Parameters

requestUri
String

The Uri the request is sent to.

Returns

The task object representing the asynchronous operation.

Exceptions

The requestUri must be an absolute URI or BaseAddress must be set.

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only).

.NET Core and .NET 5 and later only: The request failed due to timeout.

The provided request URI is not valid relative or absolute URI.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response body is read.

Note

In case of a timeout:

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

GetStringAsync(Uri)

Source:
HttpClient.cs
Source:
HttpClient.cs
Source:
HttpClient.cs

Send a GET request to the specified Uri and return the response body as a string in an asynchronous operation.

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

Parameters

requestUri
Uri

The Uri the request is sent to.

Returns

The task object representing the asynchronous operation.

Exceptions

The requestUri must be an absolute URI or BaseAddress must be set.

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only).

.NET Core and .NET 5 and later only: The request failed due to timeout.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response body is read.

Note

In case of a timeout:

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

GetStringAsync(String, CancellationToken)

Source:
HttpClient.cs
Source:
HttpClient.cs
Source:
HttpClient.cs

Send a GET request to the specified Uri and return the response body as a string in an asynchronous operation.

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

Parameters

requestUri
String

The Uri the request is sent to.

cancellationToken
CancellationToken

The cancellation token to cancel the operation.

Returns

The task object representing the asynchronous operation.

Exceptions

The requestUri is null.

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only).

.NET Core and .NET 5 and later only: The request failed due to timeout.

The provided request URI is not valid relative or absolute URI.

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response body is read.

Note

In case of a timeout:

Applies to

.NET 9 and other versions
Product Versions
.NET 5, 6, 7, 8, 9

GetStringAsync(Uri, CancellationToken)

Source:
HttpClient.cs
Source:
HttpClient.cs
Source:
HttpClient.cs

Send a GET request to the specified Uri and return the response body as a string in an asynchronous operation.

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

Parameters

requestUri
Uri

The Uri the request is sent to.

cancellationToken
CancellationToken

The cancellation token to cancel the operation.

Returns

The task object representing the asynchronous operation.

Exceptions

The requestUri is null.

The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation (or timeout for .NET Framework only).

.NET Core and .NET 5 and later only: The request failed due to timeout.

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This operation will not block. The returned Task<TResult> object will complete after the whole response body is read.

Note

In case of a timeout:

Applies to

.NET 9 and other versions
Product Versions
.NET 5, 6, 7, 8, 9