HttpClient.GetStringAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una cadena en una operación asincrónica.
Sobrecargas
| Nombre | Description |
|---|---|
| GetStringAsync(String) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una cadena en una operación asincrónica. |
| GetStringAsync(Uri) |
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una cadena en una operación asincrónica. |
Comentarios
Esta operación no se bloquea.
GetStringAsync(String)
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una cadena en una operación asincrónica.
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)Parámetros
- requestUri
- String
Identificador URI al que se envía la solicitud.
Devoluciones
Objeto de tarea que representa la operación asincrónica.
Excepciones
no requestUri es un URI absoluto y BaseAddress no se establece.
Error en la solicitud debido a un problema al obtener una respuesta HTTP válida, como un error de conectividad de red, un error dns, un error de validación del certificado de servidor o una respuesta de servidor no válida. En .NET 8 y versiones posteriores, el motivo se indica mediante HttpRequestError
O bien
El código de estado de respuesta estaba fuera del intervalo comprendido entre 200 y 299 (lo que indica que se realizó correctamente según el estándar).
O bien
solo .NET Framework: se agota el tiempo de espera de la solicitud.
.NET Core y .NET 5 y versiones posteriores solo: error en la solicitud debido al tiempo de espera.
El URI de solicitud proporcionado no es un URI relativo o absoluto válido.
Comentarios
Esta operación no se bloquea. El objeto devuelto Task<TResult> se completará después de leer todo el cuerpo de la respuesta.
Internamente, esta operación usa HttpResponseMessage.EnsureSuccessStatusCode para asegurarse de que el código de estado de respuesta está en el intervalo correcto (200-299) y produce un HttpRequestException si no lo es.
En algunos escenarios, es posible que necesite más control sobre qué códigos de estado se consideran correctos; por ejemplo, se puede esperar que una API devuelva siempre 200 OK. En tales casos, se recomienda comprobar manualmente si StatusCode coincide con el valor esperado.
Note
En el caso de un tiempo de espera:
- .NET Framework inicia una HttpRequestException.
- .NET Core inicia una OperationCanceledException sin ninguna excepción interna.
- .NET 5 y versiones posteriores inician una OperationCanceledException que anida un TimeoutException.
Se aplica a
GetStringAsync(Uri)
Envíe una solicitud GET al URI especificado y devuelva el cuerpo de la respuesta como una cadena en una operación asincrónica.
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)Parámetros
- requestUri
- Uri
Identificador URI al que se envía la solicitud.
Devoluciones
Objeto de tarea que representa la operación asincrónica.
Excepciones
no requestUri es un URI absoluto y BaseAddress no se establece.
Error en la solicitud debido a un problema al obtener una respuesta HTTP válida, como un error de conectividad de red, un error dns, un error de validación del certificado de servidor o una respuesta de servidor no válida. En .NET 8 y versiones posteriores, el motivo se indica mediante HttpRequestError
O bien
El código de estado de respuesta estaba fuera del intervalo comprendido entre 200 y 299 (lo que indica que se realizó correctamente según el estándar).
O bien
solo .NET Framework: se agota el tiempo de espera de la solicitud.
.NET Core y .NET 5 y versiones posteriores solo: error en la solicitud debido al tiempo de espera.
Comentarios
Esta operación no se bloquea. El objeto devuelto Task<TResult> se completará después de leer todo el cuerpo de la respuesta.
Internamente, esta operación usa HttpResponseMessage.EnsureSuccessStatusCode para asegurarse de que el código de estado de respuesta está en el intervalo correcto (200-299) y produce un HttpRequestException si no lo es.
En algunos escenarios, es posible que necesite más control sobre qué códigos de estado se consideran correctos; por ejemplo, se puede esperar que una API devuelva siempre 200 OK. En tales casos, se recomienda comprobar manualmente si StatusCode coincide con el valor esperado.
Note
En el caso de un tiempo de espera:
- .NET Framework inicia una HttpRequestException.
- .NET Core inicia una OperationCanceledException sin ninguna excepción interna.
- .NET 5 y versiones posteriores inician una OperationCanceledException que anida un TimeoutException.