Ask Learn
Preview
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign inThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Send a GET request to the specified URI and return the response body as a string in an asynchronous operation.
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. |
This operation doesn't block.
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<System::String ^> ^ GetStringAsync(System::String ^ requestUri);
public System.Threading.Tasks.Task<string> GetStringAsync(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)
The URI the request is sent to.
The task object representing the asynchronous operation.
The requestUri
is not an absolute URI and BaseAddress isn't set.
The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by HttpRequestError
-or-
The response status code was outside of the range of 200-299 (which indicate success according to the standard).
-or-
.NET Framework only: The request timed out.
.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.
This operation doesn't block. The returned Task<TResult> object will complete after the whole response body is read.
Internally, this operation uses HttpResponseMessage.EnsureSuccessStatusCode to ensure the response status code is in the success range (200-299) and throws an HttpRequestException if it is not.
In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return 200 OK
. In such cases, we recommend to manually check if StatusCode matches the expected value.
Note
In case of a timeout:
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, 10 |
.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 |
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<System::String ^> ^ GetStringAsync(Uri ^ requestUri);
public System.Threading.Tasks.Task<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)
The URI the request is sent to.
The task object representing the asynchronous operation.
The requestUri
is not an absolute URI and BaseAddress isn't set.
The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by HttpRequestError
-or-
The response status code was outside of the range of 200-299 (which indicate success according to the standard).
-or-
.NET Framework only: The request timed out.
.NET Core and .NET 5 and later only: The request failed due to timeout.
This operation doesn't block. The returned Task<TResult> object will complete after the whole response body is read.
Internally, this operation uses HttpResponseMessage.EnsureSuccessStatusCode to ensure the response status code is in the success range (200-299) and throws an HttpRequestException if it is not.
In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return 200 OK
. In such cases, we recommend to manually check if StatusCode matches the expected value.
Note
In case of a timeout:
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, 10 |
.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 |
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<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)
The URI the request is sent to.
The cancellation token to cancel the operation.
The task object representing the asynchronous operation.
The requestUri
is null
.
The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by HttpRequestError
-or-
The response status code was outside of the range of 200-299 (which indicate success according to the standard).
The provided request URI is not valid relative or absolute URI.
The cancellation token was canceled. This exception is stored into the returned task.
-or-
.NET Core and .NET 5 and later only: The request failed due to timeout.
This operation doesn't block. The returned Task<TResult> object will complete after the whole response body is read.
Internally, this operation uses HttpResponseMessage.EnsureSuccessStatusCode to ensure the response status code is in the success range (200-299) and throws an HttpRequestException if it is not.
In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return 200 OK
. In such cases, we recommend to manually check if StatusCode matches the expected value.
Note
In case of a timeout:
Product | Versions |
---|---|
.NET | 5, 6, 7, 8, 9, 10 |
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<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)
The URI the request is sent to.
The cancellation token to cancel the operation.
The task object representing the asynchronous operation.
The requestUri
is null
.
The request failed due to an issue getting a valid HTTP response, such as network connectivity failure, DNS failure, server certificate validation error, or invalid server response. On .NET 8 and later versions, the reason is indicated by HttpRequestError
-or-
The response status code was outside of the range of 200-299 (which indicate success according to the standard).
The cancellation token was canceled. This exception is stored into the returned task.
-or-
.NET Core and .NET 5 and later only: The request failed due to timeout.
This operation doesn't block. The returned Task<TResult> object will complete after the whole response body is read.
Internally, this operation uses HttpResponseMessage.EnsureSuccessStatusCode to ensure the response status code is in the success range (200-299) and throws an HttpRequestException if it is not.
In some scenarios, you might need more control over which status codes are considered to be successful; for example, an API might be expected to always return 200 OK
. In such cases, we recommend to manually check if StatusCode matches the expected value.
Note
In case of a timeout:
Product | Versions |
---|---|
.NET | 5, 6, 7, 8, 9, 10 |
.NET feedback
.NET is an open source project. Select a link to provide feedback:
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign in