PSHost.Name Property

  • Reference

Definition

Namespace:
System.Management.Automation.Host
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Gets the hosting application's identification in some user-friendly fashion. This name can be referenced by scripts and cmdlets to identify the host that is executing them. The format of the value is not defined, but a short, simple string is recommended.

public:
 abstract property System::String ^ Name { System::String ^ get(); };
public:
 abstract property Platform::String ^ Name { Platform::String ^ get(); };
public abstract string Name { get; }
member this.Name : string
Public MustOverride ReadOnly Property Name As String

Property Value

String

The name identifier of the hosting application.

Examples

if ($Host.Name -ieq "ConsoleHost") { write-host "I'm running in the Console Host" }

Remarks

In implementing this member, you should return some sort of informative string describing the nature your hosting application. For the default console host shipped by Microsoft this is ConsoleHost.

Applies to