出力をコマンド ラインに送ります。
構文
Out-Host [-InputObject <psobject>] [-Paging] [<CommonParameters>]
説明
Out-Host コマンドレットは、出力を Windows PowerShell ホストに送り、表示します。Windows PowerShell ホストは、出力をコマンド ラインに表示します。Out-Host は既定値であるため、表示変更用のパラメーターを使用しない場合は指定する必要がありません。
パラメーター
-InputObject <psobject>
コンソールに書き込むオブジェクトを指定します。オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
true (ByValue) |
|
ワイルドカード文字を許可する |
false |
-Paging
出力を一度に 1 ページずつ表示し、ユーザーからの入力を待って残りのページを表示します。従来の more コマンドによく似ています。既定では、出力は単一ページにすべてが表示されます。ページ サイズはホストの特性によって決定されます。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。Ô”¼š¤Ë¤Ä¤¤¤Æ¤Ï¡¢次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
|
入力 |
System.Management.Automation.PSObject パイプを使用して、あらゆるオブジェクトを Out-Host に渡すことができます。 |
|
出力 |
なし Out-Host は出力を生成しません。ただし、Out-Host から渡されたオブジェクトをホストが表示する場合があります。 |
注
Out-Host は、その組み込みエイリアスである "oh" で参照することもできます。詳細については、「about_Aliases」を参照してください。
Out という動詞を含むコマンドレット (Out コマンドレット) はオブジェクトを書式設定しません。オブジェクトをレンダリングし、指定された表示先に送るだけです。書式設定されていないオブジェクトを Out コマンドレットに送ると、Out コマンドレットはこのオブジェクトをレンダリングする前に書式設定用コマンドレットに送ります。
Out コマンドレットには、名前またはファイル パス用のパラメーターがありません。Out コマンドレットにデータを送るには、Windows PowerShell コマンドの出力をコマンドレットに送るパイプライン演算子 (|) を使用します。InputObject パラメーターを使用すると、変数に保存したデータをコマンドレットに渡すこともできます。ヘルプについては、例を参照してください。
Out-Host はデータを送りますが、出力オブジェクトは作成しません。パイプを使用して Out-Host の出力を Get-Member に渡すと、Get-Member はオブジェクトが指定されていないと報告します。
例 1
C:\PS>get-process | out-host -paging 説明 ----------- このコマンドは、システム上のプロセスを一度に 1 ページずつ表示します。Get-Process コマンドを使用して、システム上のプロセスを取得します。結果はパイプライン演算子 (|) によって Out-Host に送られ、コンソールに表示されます。Paging パラメーターが指定されているため、データは一度に 1 ページずつ表示されます。 同じコマンド形式が、Windows PowerShell に組み込まれている Help 関数で使用されています。この関数は Get-Help からデータを取得し、Out-Host の Paging パラメーターを使用してデータを一度に 1 ページずつ表示します (コマンド形式は get-help $args[0] | out-host -paging を使用)。
例 2
C:\PS>$a = get-history C:\PS>out-host -InputObject $a 説明 ----------- これらのコマンドは、セッション履歴をコマンド ラインに表示します。最初のコマンドは、Get-History コマンドレットを使用して取得したセッション履歴を $a 変数に保存します。2 番目のコマンドは、Out-Host を使用して $a 変数の内容を表示します。また、InputObject パラメーターを使用して Out-Host に変数を指定します。
関連項目