DefaultStatusCodeAttribute Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.Infrastructure

Assembly:: Microsoft.AspNetCore.Mvc.Core.dll

Package:: Microsoft.AspNetCore.Mvc.Core v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Package:: Microsoft.AspNetCore.App.Ref v9.0.0

Source:: DefaultStatusCodeAttribute.cs

Source:: DefaultStatusCodeAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies the default status code associated with an ActionResult.

public ref class DefaultStatusCodeAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=true)]
public sealed class DefaultStatusCodeAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)]
public sealed class DefaultStatusCodeAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=true)>]
type DefaultStatusCodeAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)>]
type DefaultStatusCodeAttribute = class
    inherit Attribute

Public NotInheritable Class DefaultStatusCodeAttribute
Inherits Attribute

Inheritance: Attribute
DefaultStatusCodeAttribute

Attributes: AttributeUsageAttribute

Remarks

This attribute is informational only and does not have any runtime effects. Applying the attribute on a class indicates that the ActionResult represented by that class uses a particular status code by default. Applying the attribute to a method indicates that the ActionResult returned by the method uses that status code by default. The later is helpful in scenarios where we need to specify that a method modifies the status code that an ActionResult uses by default in its logic or for specifying the status code for consumption in the API analyzers.

Constructors

DefaultStatusCodeAttribute(Int32)

Initializes a new instance of DefaultStatusCodeAttribute.

Properties

StatusCode

Gets the default status code.

Applies to

Product	Versions
ASP.NET Core	2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

Share via