HttpClient.GetStringAsync 方法

定义

命名空间:

System.Net.Http

程序集:

System.Net.Http.dll

将 GET 请求发送到指定 URI 并在异步操作中以字符串的形式返回响应正文。

重载

GetStringAsync(String)	将 GET 请求发送到指定 URI 并在异步操作中以字符串的形式返回响应正文。
GetStringAsync(Uri)	将 GET 请求发送到指定 URI 并在异步操作中以字符串的形式返回响应正文。
GetStringAsync(String, CancellationToken)	将 GET 请求发送到指定 URI 并在异步操作中以字符串的形式返回响应正文。
GetStringAsync(Uri, CancellationToken)	将 GET 请求发送到指定 URI 并在异步操作中以字符串的形式返回响应正文。

注解

此操作不会阻止。

GetStringAsync(String)

Source:

HttpClient.cs

将 GET 请求发送到指定 URI 并在异步操作中以字符串的形式返回响应正文。

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)

参数

requestUri

String

请求发送到的 URI。

返回

Task<String>

表示异步操作的任务对象。

例外

InvalidOperationException

requestUri 必须为绝对 URI 或必须设置 BaseAddress。

HttpRequestException

由于基础问题（如网络连接性、DNS 失败、服务器证书验证或仅 .NET Framework 超时），请求失败。

TaskCanceledException

仅限 .NET Core 和 .NET 5 及更高版本：请求因超时而失败。

UriFormatException

提供的请求 URI 不是有效的相对 URI 或绝对 URI。

注解

此操作不会阻止。 返回 Task<TResult> 的对象将在读取整个响应正文后完成。

备注

如果超时：

• .NET Framework引发 HttpRequestException。
• .NET Core 引发 TaskCanceledException 没有任何内部异常的 。
• .NET 5 及更高版本引发嵌套 TaskCanceledException 的 TimeoutException。

GetStringAsync(Uri)

Source:

HttpClient.cs

将 GET 请求发送到指定 URI 并在异步操作中以字符串的形式返回响应正文。

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)

参数

requestUri

Uri

请求发送到的 URI。

返回

Task<String>

表示异步操作的任务对象。

例外

InvalidOperationException

requestUri 必须为绝对 URI 或必须设置 BaseAddress。

HttpRequestException

由于基础问题（如网络连接性、DNS 失败、服务器证书验证或仅 .NET Framework 超时），请求失败。

TaskCanceledException

仅限 .NET Core 和 .NET 5 及更高版本：请求因超时而失败。

注解

此操作不会阻止。 返回 Task<TResult> 的对象将在读取整个响应正文后完成。

备注

如果超时：

• .NET Framework引发 HttpRequestException。
• .NET Core 引发 TaskCanceledException 没有任何内部异常的 。
• .NET 5 及更高版本引发嵌套 TaskCanceledException 的 TimeoutException。

GetStringAsync(String, CancellationToken)

Source:

HttpClient.cs

将 GET 请求发送到指定 URI 并在异步操作中以字符串的形式返回响应正文。

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)

参数

requestUri

String

请求发送到的 URI。

cancellationToken

CancellationToken

用于取消操作的取消令牌。

返回

Task<String>

表示异步操作的任务对象。

例外

ArgumentNullException

requestUri 为 null。

HttpRequestException

由于基础问题（如网络连接性、DNS 失败、服务器证书验证或仅 .NET Framework 超时），请求失败。

TaskCanceledException

仅限 .NET Core 和 .NET 5 及更高版本：请求因超时而失败。

UriFormatException

提供的请求 URI 不是有效的相对 URI 或绝对 URI。

OperationCanceledException

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

注解

此操作不会阻止。 返回 Task<TResult> 的对象将在读取整个响应正文后完成。

备注

如果超时：

• .NET Framework引发 HttpRequestException。
• .NET Core 引发 TaskCanceledException 没有任何内部异常的 。
• .NET 5 及更高版本引发嵌套 TaskCanceledException 的 TimeoutException。

GetStringAsync(Uri, CancellationToken)

Source:

HttpClient.cs

将 GET 请求发送到指定 URI 并在异步操作中以字符串的形式返回响应正文。

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)

参数

requestUri

Uri

请求发送到的 URI。

cancellationToken

CancellationToken

用于取消操作的取消令牌。

返回

Task<String>

表示异步操作的任务对象。

例外

ArgumentNullException

requestUri 为 null。

HttpRequestException

由于基础问题（如网络连接性、DNS 失败、服务器证书验证或仅 .NET Framework 超时），请求失败。

TaskCanceledException

仅限 .NET Core 和 .NET 5 及更高版本：请求因超时而失败。

OperationCanceledException

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

注解

此操作不会阻止。 返回 Task<TResult> 的对象将在读取整个响应正文后完成。

备注

如果超时：

• .NET Framework引发 HttpRequestException。
• .NET Core 引发 TaskCanceledException 没有任何内部异常的 。
• .NET 5 及更高版本引发嵌套 TaskCanceledException 的 TimeoutException。