Get-Host
現在のホスト プログラムを表すオブジェクトを取得します。
構文
Get-Host []
説明
Get-Host コマンドレットは、Windows PowerShellをホストしているプログラムを表す オブジェクトを取得します。
既定の表示には、Windows PowerShell のバージョン番号とホストで使用されている現在の地域と言語の設定が含まれていますが、ホスト オブジェクトには、現在実行中の Windows PowerShell のバージョンの詳細情報、現在のカルチャ、Windows PowerShell の UI カルチャなど多くの情報が含まれています。 このコマンドレットを使用して、テキストや背景色などのホスト プログラムのユーザー インターフェイスの機能をカスタマイズすることもできます。
例
例 1: PowerShell コンソール ホストに関する情報を取得する
PS C:\> Get-Host
Name : ConsoleHost
Version : 2.0
InstanceId : e4e0ab54-cc5e-4261-9117-4081f20ce7a2
UI : System.Management.Automation.Internal.Host.InternalHostUserInterface
CurrentCulture : en-US
CurrentUICulture : en-US
PrivateData : Microsoft.PowerShell.ConsoleHost+ConsoleColorProxy
IsRunspacePushed : False
Runspace : System.Management.Automation.Runspaces.LocalRunspace
このコマンドは、この例の Windows PowerShell の現在のホスト プログラムである Windows PowerShell コンソールに関する情報を表示します。 これには、ホストの名前、ホストで実行されている Windows PowerShell のバージョン、現在のカルチャおよび UI カルチャが含まれます。
Version、UI、CurrentCulture、CurrentUICulture、PrivateData、および Runspace プロパティには、それぞれ非常に便利なプロパティを持つオブジェクトが含まれています。 後で示す例では、これらのプロパティを説明します。
例 2: PowerShell ウィンドウのサイズを変更する
PS C:\> $H = Get-Host
PS C:\> $Win = $H.UI.RawUI.WindowSize
PS C:\> $Win.Height = 10
PS C:\> $Win.Width = 10
PS C:\> $H.UI.RawUI.Set_WindowSize($Win)
このコマンドは、Windows PowerShell ウィンドウを 10 x 10 ピクセルにサイズ変更します。
例 3: ホストの PowerShell バージョンを取得する
PS C:\> (Get-Host).Version | Format-List -Property *
Major : 2
Minor : 0
Build : -1
Revision : -1
MajorRevision : -1
MinorRevision : -1
このコマンドは、ホストで実行されている Windows PowerShell のバージョンに関する詳細情報を取得します。 これらの値は表示できますが、変更することはできません。
Get-Host の Version プロパティには、System.Version オブジェクトが含まれています。 このコマンドは、パイプライン演算子 (|) を使用してバージョン オブジェクトを Format-List コマンドレットに送信します。 Format-List コマンドは、Property パラメーターと all (*) の値を使用して、バージョン オブジェクトのすべてのプロパティとプロパティ値を表示します。
例 4: ホストの現在のカルチャを取得する
PS C:\> (Get-Host).CurrentCulture | Format-List -Property *
Parent : en
LCID : 1033
KeyboardLayoutId : 1033
Name : en-US
IetfLanguageTag : en-US
DisplayName : English (United States)
NativeName : English (United States)
EnglishName : English (United States)
TwoLetterISOLanguageName : en
ThreeLetterISOLanguageName : eng
ThreeLetterWindowsLanguageName : ENU
CompareInfo : CompareInfo - 1033
TextInfo : TextInfo - 1033
IsNeutralCulture : False
CultureTypes : SpecificCultures, InstalledWin32Cultures, FrameworkCultures
NumberFormat : System.Globalization.NumberFormatInfo
DateTimeFormat : System.Globalization.DateTimeFormatInfo
Calendar : System.Globalization.GregorianCalendar
OptionalCalendars : {System.Globalization.GregorianCalendar, System.Globalization.GregorianCalendar}
UseUserOverride : True
IsReadOnly : False
このコマンドは、ホストで実行されている Windows PowerShell に設定されている現在のカルチャに関する詳細情報を取得します。 これは、Get-Culture コマンドレットによって返されるのと同じ情報です。
同様に、 CurrentUICulture プロパティは、Get-UICulture が返すのと同じオブジェクトを返します。
ホスト オブジェクトの CurrentCulture プロパティには、 System.Globalization.CultureInfo オブジェクトが含まれています。 このコマンドでは、パイプライン演算子 (|) を使用して CultureInfo オブジェクトを Format-List コマンドレットに送信します。 Format-List コマンドは、Property パラメーターと all (*) の値を使用して、CultureInfo オブジェクトのすべてのプロパティとプロパティ値を表示します。
例 5: 現在のカルチャの DateTimeFormat を取得する
PS C:\> (Get-Host).CurrentCulture.DateTimeFormat | Format-List -Property *
AMDesignator : AM
Calendar : System.Globalization.GregorianCalendar
DateSeparator : /
FirstDayOfWeek : Sunday
CalendarWeekRule : FirstDay
FullDateTimePattern : dddd, MMMM dd, yyyy h:mm:ss tt
LongDatePattern : dddd, MMMM dd, yyyy
LongTimePattern : h:mm:ss tt
MonthDayPattern : MMMM dd
PMDesignator : PM
RFC1123Pattern : ddd, dd MMM yyyy HH':'mm':'ss 'GMT'
ShortDatePattern : M/d/yyyy
ShortTimePattern : h:mm tt
SortableDateTimePattern : yyyy'-'MM'-'dd'T'HH':'mm':'ss
TimeSeparator : :
UniversalSortableDateTimePattern : yyyy'-'MM'-'dd HH':'mm':'ss'Z'
YearMonthPattern : MMMM, yyyy
AbbreviatedDayNames : {Sun, Mon, Tue, Wed...}
ShortestDayNames : {Su, Mo, Tu, We...}
DayNames : {Sunday, Monday, Tuesday, Wednesday...}
AbbreviatedMonthNames : {Jan, Feb, Mar, Apr...}
MonthNames : {January, February, March, April...}
IsReadOnly : False
NativeCalendarName : Gregorian Calendar
AbbreviatedMonthGenitiveNames : {Jan, Feb, Mar, Apr...}
MonthGenitiveNames : {January, February, March, April...}
このコマンドは、Windows PowerShell に使用されている現在のカルチャの DateTimeFormat に関する詳細情報を返します。
ホスト オブジェクトの CurrentCulture プロパティには CultureInfo オブジェクトが含まれています。このオブジェクトには、多くの便利なプロパティがあります。 その中で、 DateTimeFormat プロパティには、多くの便利なプロパティを持つ DateTimeFormatInfo オブジェクトが含まれています。
オブジェクトのプロパティに格納されているオブジェクトの種類を検索するには、Get-Member コマンドレットを使用します。 オブジェクトのプロパティ値を表示するには、Format-List コマンドレットを使用します。
例 6: ホストの RawUI プロパティを取得する
PS C:\> (Get-Host).UI.RawUI | Format-List -Property *
ForegroundColor : DarkYellow
BackgroundColor : DarkBlue
CursorPosition : 0,390
WindowPosition : 0,341
CursorSize : 25
BufferSize : 120,3000
WindowSize : 120,50
MaxWindowSize : 120,81
MaxPhysicalWindowSize : 182,81
KeyAvailable : False
WindowTitle : Windows PowerShell 2.0 (04/11/2008 00:08:14)
このコマンドは、ホスト オブジェクトの RawUI プロパティのプロパティを表示します。 これらの値を変更すると、ホスト プログラムの外観を変更することができます。
例 7: PowerShell コンソールの背景色を設定する
PS C:\> (Get-Host).UI.RawUI.BackgroundColor = "Black"
PS C:\> cls
これらのコマンドは、Windows PowerShell コンソールの背景色を黒に変更します。 cls コマンドは、Clear-Host 関数のエイリアスです。これにより、画面がクリアされ、画面全体が新しい色に変更されます。
この変更は、現在のセッションでのみ有効です。 すべてのセッションでコンソールの背景色を変更するには、コマンドを Windows PowerShell プロファイルに追加します。
例 8: エラー メッセージの背景色を設定する
PS C:\> $Host.PrivateData.ErrorBackgroundColor = "white"
このコマンドは、エラー メッセージの背景色を白に変更します。
このコマンドは、現在のホスト プログラムのホスト オブジェクトを含む自動変数$Host使用します。 Get-Host は 、$Hostに含まれているのと同じオブジェクトを返します。そのため、同じ意味で使用できます。
このコマンドでは、$Hostの PrivateData プロパティを ErrorBackgroundColor プロパティとして使用します。
$Host.PrivateData プロパティ内の オブジェクトのすべてのプロパティを表示するには、「」と入力します $host.privatedata | format-list *
。
入力
None
パイプを使用してこのコマンドレットに入力を渡すことはできません。
出力
System.Management.Automation.Internal.Host.InternalHost
Get-Host はSystem.Management.Automation.Internal.Host.InternalHost オブジェクトを 返します。
メモ
$Host自動変数には 、Get-Host が返すのと同じオブジェクトが含まれており、同じ方法で使用できます。 同様に、$PSCulture変数と$PSUICulture自動変数には、ホスト オブジェクトの CurrentCulture プロパティと CurrentUICulture プロパティと同じオブジェクトが含まれます。 これらの機能は置き換えて使用できます。
詳細については、「about_Automatic_Variables」を参照してください。