HostEnvironmentEnvExtensions.IsStaging(IHostEnvironment) Method

Reference

Definition

Namespace:: Microsoft.Extensions.Hosting

Assembly:: Microsoft.Extensions.Hosting.Abstractions.dll

Package:: Microsoft.Extensions.Hosting.Abstractions v6.0.0

Package:: Microsoft.Extensions.Hosting.Abstractions v7.0.0

Package:: Microsoft.Extensions.Hosting.Abstractions v8.0.0

Package:: Microsoft.Extensions.Hosting.Abstractions v9.0.0-preview.2.24128.5

Source:: HostEnvironmentEnvExtensions.cs

Source:: HostEnvironmentEnvExtensions.cs

Source:: HostEnvironmentEnvExtensions.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.

Checks if the current host environment name is Staging. This API should not be used in libraries, see remarks for details.

public:
[System::Runtime::CompilerServices::Extension]
 static bool IsStaging(Microsoft::Extensions::Hosting::IHostEnvironment ^ hostEnvironment);

public static bool IsStaging (this Microsoft.Extensions.Hosting.IHostEnvironment hostEnvironment);

static member IsStaging : Microsoft.Extensions.Hosting.IHostEnvironment -> bool

<Extension()>
Public Function IsStaging (hostEnvironment As IHostEnvironment) As Boolean

Parameters

hostEnvironment: IHostEnvironment

An instance of IHostEnvironment.

Returns

Boolean

true if the environment name is Staging; otherwise, false.

Remarks

The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library authors should avoid coupling specific behavior to these environment names.

Applies to