Table of Contents

Class StatusCodeResult

Namespace
System.Web.Http.Results
Assembly
System.Web.Http.dll

Represents an action result that returns a specified HTTP status code.

public class StatusCodeResult : IHttpActionResult
Inheritance
StatusCodeResult
Implements
Inherited Members

Constructors

StatusCodeResult(HttpStatusCode, HttpRequestMessage)

Initializes a new instance of the StatusCodeResult class.

public StatusCodeResult(HttpStatusCode statusCode, HttpRequestMessage request)

Parameters

statusCode HttpStatusCode

The HTTP status code for the response message.

request HttpRequestMessage

The request message which led to this result.

StatusCodeResult(HttpStatusCode, ApiController)

Initializes a new instance of the StatusCodeResult class.

public StatusCodeResult(HttpStatusCode statusCode, ApiController controller)

Parameters

statusCode HttpStatusCode

The HTTP status code for the response message.

controller ApiController

The controller from which to obtain the dependencies needed for execution.

Properties

Request

Gets the request message which led to this result.

public HttpRequestMessage Request { get; }

Property Value

HttpRequestMessage

The request message which led to this result.

StatusCode

Gets the HTTP status code for the response message.

public HttpStatusCode StatusCode { get; }

Property Value

HttpStatusCode

The HTTP status code for the response message.

Methods

ExecuteAsync(CancellationToken)

Creates a response message asynchronously.

public virtual Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task<HttpResponseMessage>

A task that, when completed, contains the response message.