Get-Host
現在のホスト プログラムを表すオブジェクトを取得します。また、既定では、Windows PowerShell のバージョンと地域情報を表示します。
構文
Get-Host [<CommonParameters>]
説明
Get-Host コマンドレットは、Windows PowerShell のホストとなるプログラムを表すオブジェクトを取得します。
既定では、Windows PowerShell のバージョン番号や、ホストが使用している現在の地域や言語の設定などが表示されますが、ホスト オブジェクトには、現在実行中の Windows PowerShell のバージョンの詳細情報、現在のカルチャ、Windows PowerShell の UI カルチャなど多くの情報が含まれています。このコマンドレットを使用すると、ホスト プログラムのユーザー インターフェイスをカスタマイズして、テキスト色や背景色などを変更することもできます。
パラメーター
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
入力 |
なし パイプを使用してこのコマンドレットに入力を渡すことはできません。 |
出力 |
System.Management.Automation.Internal.Host.InternalHost Get-Host は System.Management.Automation.Internal.Host.InternalHost オブジェクトを返します。 |
注
自動変数 $host には Get-Host が返すオブジェクトと同じオブジェクトが保存されているので、同じ方法で使用できます。同様に、自動変数 $PSCulture および $PSUICulture には、ホスト オブジェクトの CurrentCulture プロパティおよび CurrentUICulture プロパティに含まれているオブジェクトと同じオブジェクトが保存されています。したがって、これらのオブジェクトは入れ替えて使用することができます。
詳細については、「about_Automatic_Variables」を参照してください。
例 1
C:\PS>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
C:\PS>$h = get-host
C:\PS> $win = $h.ui.rawui.windowsize
C:\PS> $win.height = 10
C:\PS> $win.width = 10
C:\PS> $h.ui.rawui.set_windowsize($win)
説明
-----------
このコマンドは、Windows PowerShell ウィンドウのサイズを 10 x 10 ピクセルに変更します。
例 3
C:\PS>(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 パラメーターにすべての値 (*) を指定して、バージョン オブジェクトのすべてのプロパティとプロパティ値を一覧表示します。
例 4
C:\PS>(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 パラメーターにすべての値 (*) を指定して、CultureInfo オブジェクトのすべてのプロパティとプロパティ値を一覧表示します。
例 5
C:\PS>(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
C:\PS>(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
C:\PS>(get-host).ui.rawui.backgroundcolor = "Black"
C:\PS> cls
説明
-----------
これらのコマンドは、Windows PowerShell コンソールの背景色を黒に変更します。"cls" コマンドは Clear-Host 関数のエイリアスで、これによって画面がクリアされ画面全体が新しい色に変更されます。
この変更は現在のセッションについてのみ有効です。すべてのセッションのコンソールの背景色を変更する場合は、Windows PowerShell プロファイルにコマンドを追加します。
例 8
C:\PS>$host.privatedata.errorbackgroundcolor = "white"
説明
-----------
このコマンドは、書き込むエラー メッセージの背景色を変更します。
このコマンドは、現在のホスト プログラムのホスト オブジェクトを含む自動変数 $host を使用します。Get-Host は $host に保存されているオブジェクトと同じオブジェクトを返すので、それらを入れ替えて使用できます。
このコマンドは、$host の PrivateData プロパティをその ErrorBackgroundColor プロパティとして使用します。$host.PrivateData プロパティにあるオブジェクトのすべてのプロパティを表示するには、「$host.privatedata | format-list *」と入力します。