HostingEnvironmentExtensions.IsEnvironment Method

Definition

Namespace:

Microsoft.Extensions.Hosting

Assembly:

Microsoft.Extensions.Hosting.Abstractions.dll

Package:

Microsoft.Extensions.Hosting.Abstractions v8.0.0

Source:

HostingEnvironmentExtensions.cs

Compares the current hosting environment name against the specified value. Library authors should avoid using this API, see remarks for details.

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

public static bool IsEnvironment (this Microsoft.Extensions.Hosting.IHostingEnvironment hostingEnvironment, string environmentName);

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

<Extension()>
Public Function IsEnvironment (hostingEnvironment As IHostingEnvironment, environmentName As String) As Boolean

Parameters

hostingEnvironment

IHostingEnvironment

An instance of IHostingEnvironment.

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.