HttpRequestMessageExtensions.CreateErrorResponse Method (, HttpStatusCode, Exception)

Creates an HttpResponseMessage that represents an exception.

Namespace:  System.Net.Http
Assembly:  System.Web.Http (in System.Web.Http.dll)

public static HttpResponseMessage CreateErrorResponse(
	this HttpRequestMessage request,
	HttpStatusCode statusCode,
	Exception exception
)

Parameters

request
Type: HttpRequestMessage

The HTTP request.

statusCode
Type: System.Net.HttpStatusCode

The status code of the response.

exception
Type: System.Exception

The exception.

Return Value

Type: HttpResponseMessage
The request must be associated with an HttpConfiguration instance.
An HttpResponseMessage whose content is a serialized representation of an HttpError instance.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type HttpRequestMessage. When you use instance method syntax to call this method, omit the first parameter. For more information, see https://msdn.microsoft.com/en-us/library/bb384936(v=vs.108).aspx or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.108).aspx.

The method performs content negotiation to serialize the HttpError instance. If the method cannot find a suitable media-type formatter, the method returns a response with status code 406 (Not Acceptable).

Show: