Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
HttpResponseMessage Class
Definition
- Namespace:
- System.Net.Http
- Assembly:
- System.Net.Http.dll
- Assemblies:
- netstandard.dll, System.Net.Http.dll
- Assembly:
- netstandard.dll
- Source:
- HttpResponseMessage.cs
- Source:
- HttpResponseMessage.cs
- Source:
- HttpResponseMessage.cs
- Source:
- HttpResponseMessage.cs
- Source:
- HttpResponseMessage.cs
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.
Represents a HTTP response message including the status code and data.
public ref class HttpResponseMessage : IDisposable
public class HttpResponseMessage : IDisposable
type HttpResponseMessage = class
interface IDisposable
Public Class HttpResponseMessage
Implements IDisposable
- Inheritance
-
HttpResponseMessage
- Implements
Examples
// HttpClient is intended to be instantiated once per application, rather than per-use. See Remarks.
static readonly HttpClient client = new HttpClient();
static async Task Main()
{
// Call asynchronous network methods in a try/catch block to handle exceptions.
try
{
using HttpResponseMessage response = await client.GetAsync("http://www.contoso.com/");
response.EnsureSuccessStatusCode();
string responseBody = await response.Content.ReadAsStringAsync();
// Above three lines can be replaced with new helper method below
// string responseBody = await client.GetStringAsync(uri);
Console.WriteLine(responseBody);
}
catch (HttpRequestException e)
{
Console.WriteLine("\nException Caught!");
Console.WriteLine("Message :{0} ", e.Message);
}
}
open System.Net.Http
// HttpClient is intended to be instantiated once per application, rather than per-use. See Remarks.
let client = new HttpClient()
let main =
task {
// Call asynchronous network methods in a try/catch block to handle exceptions.
try
use! response = client.GetAsync "http://www.contoso.com/"
response.EnsureSuccessStatusCode() |> ignore
let! responseBody = response.Content.ReadAsStringAsync()
// Above three lines can be replaced with new helper method below
// let! responseBody = client.GetStringAsync uri
printfn $"{responseBody}"
with
| :? HttpRequestException as e ->
printfn "\nException Caught!"
printfn $"Message :{e.Message} "
}
main.Wait()
' HttpClient is intended to be instantiated once per application, rather than per-use. See Remarks.
Shared ReadOnly client As HttpClient = New HttpClient()
Private Shared Async Function Main() As Task
' Call asynchronous network methods in a try/catch block to handle exceptions.
Try
Using response As HttpResponseMessage = Await client.GetAsync("http://www.contoso.com/")
response.EnsureSuccessStatusCode()
Dim responseBody As String = Await response.Content.ReadAsStringAsync()
' Above three lines can be replaced with new helper method below
' Dim responseBody As String = Await client.GetStringAsync(uri)
Console.WriteLine(responseBody)
End Using
Catch e As HttpRequestException
Console.WriteLine(Environment.NewLine & "Exception Caught!")
Console.WriteLine("Message :{0} ", e.Message)
End Try
End Function
The preceding code example uses an async Task Main() entry point. That feature requires C# 7.1 or later.
Remarks
A common way to get an HttpResponseMessage is from one of the HttpClient.SendAsync(HttpRequestMessage) methods.
Constructors
| Name | Description |
|---|---|
| HttpResponseMessage() |
Initializes a new instance of the HttpResponseMessage class. |
| HttpResponseMessage(HttpStatusCode) |
Initializes a new instance of the HttpResponseMessage class with a specific StatusCode. |
Properties
| Name | Description |
|---|---|
| Content |
Gets or sets the content of a HTTP response message. |
| Headers |
Gets the collection of HTTP response headers. |
| IsSuccessStatusCode |
Gets a value that indicates if the HTTP response was successful. |
| ReasonPhrase |
Gets or sets the reason phrase, which typically is sent by servers together with the status code. |
| RequestMessage |
Gets or sets the request message that led to this response message. |
| StatusCode |
Gets or sets the status code of the HTTP response. |
| TrailingHeaders |
Gets the collection of trailing headers included in an HTTP response. |
| Version |
Gets or sets the HTTP message version. |
Methods
| Name | Description |
|---|---|
| Dispose() |
Releases the unmanaged resources and disposes of unmanaged resources used by the HttpResponseMessage. |
| Dispose(Boolean) |
Releases the unmanaged resources used by the HttpResponseMessage and optionally disposes of the managed resources. |
| EnsureSuccessStatusCode() |
Throws an exception if the IsSuccessStatusCode property for the HTTP response is |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString() |
Returns a string that represents the current object. |
Extension Methods
| Name | Description |
|---|---|
| ToMessage(HttpResponseMessage) |
Creates a Message instance from an HttpResponseMessage instance. |
Applies to
Feedback
Was this page helpful?
