HttpRequestMessageExtensions.CreateErrorResponse Method (, HttpStatusCode, ModelStateDictionary)
Creates an HttpResponseMessage that represents an error in the model state.
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, _
modelState As ModelStateDictionary _
) As HttpResponseMessage
'Usage
Dim request As HttpRequestMessage
Dim statusCode As HttpStatusCode
Dim modelState As ModelStateDictionary
Dim returnValue As HttpResponseMessage
returnValue = request.CreateErrorResponse(statusCode, _
modelState)
public static HttpResponseMessage CreateErrorResponse(
this HttpRequestMessage request,
HttpStatusCode statusCode,
ModelStateDictionary modelState
)
[ExtensionAttribute]
public:
static HttpResponseMessage^ CreateErrorResponse(
HttpRequestMessage^ request,
HttpStatusCode statusCode,
ModelStateDictionary^ modelState
)
static member CreateErrorResponse :
request:HttpRequestMessage *
statusCode:HttpStatusCode *
modelState:ModelStateDictionary -> HttpResponseMessage
public static function CreateErrorResponse(
request : HttpRequestMessage,
statusCode : HttpStatusCode,
modelState : ModelStateDictionary
) : HttpResponseMessage
Parameters
request
Type: HttpRequestMessageThe HTTP request.
statusCode
Type: System.Net.HttpStatusCodeThe status code of the response.
modelState
Type: System.Web.Http.ModelBinding.ModelStateDictionaryThe model state.
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).