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)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function CreateErrorResponse ( _
request As HttpRequestMessage, _
statusCode As HttpStatusCode, _
exception As Exception _
) As HttpResponseMessage
'Usage
Dim request As HttpRequestMessage
Dim statusCode As HttpStatusCode
Dim exception As Exception
Dim returnValue As HttpResponseMessage
returnValue = request.CreateErrorResponse(statusCode, _
exception)
public static HttpResponseMessage CreateErrorResponse(
this HttpRequestMessage request,
HttpStatusCode statusCode,
Exception exception
)
[ExtensionAttribute]
public:
static HttpResponseMessage^ CreateErrorResponse(
HttpRequestMessage^ request,
HttpStatusCode statusCode,
Exception^ exception
)
static member CreateErrorResponse :
request:HttpRequestMessage *
statusCode:HttpStatusCode *
exception:Exception -> HttpResponseMessage
public static function CreateErrorResponse(
request : HttpRequestMessage,
statusCode : HttpStatusCode,
exception : Exception
) : HttpResponseMessage
Parameters
request
Type: HttpRequestMessageThe HTTP request.
statusCode
Type: System.Net.HttpStatusCodeThe status code of the response.
exception
Type: System.ExceptionThe 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) or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.108).
Remarks
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).