HostEnvironmentEnvExtensions.IsEnvironment(IHostEnvironment, String) Method

Reference

Definition

Namespace:: Microsoft.Extensions.Hosting

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

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

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.

Compares the current host environment name against the specified value.

public:
[System::Runtime::CompilerServices::Extension]
 static bool IsEnvironment(Microsoft::Extensions::Hosting::IHostEnvironment ^ hostEnvironment, System::String ^ environmentName);

public static bool IsEnvironment (this Microsoft.Extensions.Hosting.IHostEnvironment hostEnvironment, string environmentName);

static member IsEnvironment : Microsoft.Extensions.Hosting.IHostEnvironment * string -> bool

<Extension()>
Public Function IsEnvironment (hostEnvironment As IHostEnvironment, environmentName As String) As Boolean

Parameters

hostEnvironment: IHostEnvironment

An instance of IHostEnvironment.

environmentName: String

Environment name to validate against.

Returns

Boolean

true if the specified name is the same as the current environment, otherwise false.

Remarks

Environment names are generally specific to an application. Libraries designed for use in many different applications should avoid coupling behavior to specific environment names.

Applies to

Jaa