HttpRequestMessageExtensions.CreateErrorResponse Method (HttpRequestMessage, HttpStatusCode, String, Exception)
Creates an HttpResponseMessage that represents an exception with an error message.
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, _
message As String, _
exception As Exception _
) As HttpResponseMessage
'Usage
Dim request As HttpRequestMessage
Dim statusCode As HttpStatusCode
Dim message As String
Dim exception As Exception
Dim returnValue As HttpResponseMessage
returnValue = request.CreateErrorResponse(statusCode, _
message, exception)
public static HttpResponseMessage CreateErrorResponse(
this HttpRequestMessage request,
HttpStatusCode statusCode,
string message,
Exception exception
)
[ExtensionAttribute]
public:
static HttpResponseMessage^ CreateErrorResponse(
HttpRequestMessage^ request,
HttpStatusCode statusCode,
String^ message,
Exception^ exception
)
static member CreateErrorResponse :
request:HttpRequestMessage *
statusCode:HttpStatusCode *
message:string *
exception:Exception -> HttpResponseMessage
public static function CreateErrorResponse(
request : HttpRequestMessage,
statusCode : HttpStatusCode,
message : String,
exception : Exception
) : HttpResponseMessage
Parameters
- request
Type: HttpRequestMessage
The HTTP request.
- statusCode
Type: System.Net.HttpStatusCode
The status code of the response.
- message
Type: System.String
The error message.
- 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.118) or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.118).