Out-Host

  • リファレンス
モジュール:
Microsoft.PowerShell.Core

コマンド ラインに出力を送信します。

構文

Out-Host
   [-Paging]
   [-InputObject <PSObject>]
   [<CommonParameters>]

説明

コマンドレットは Out-Host 、PowerShell ホストに出力を送信して表示します。 ホストは、コマンド ラインに出力を表示します。 既定値であるため Out-Host 、パラメーターを使用しない限り、指定する必要はありません。

Out-Host は、実行されるすべてのコマンドに自動的に追加されます。 コマンドを実行しているホストにパイプラインの出力を渡します。 Out-Host は ANSI エスケープ シーケンスを無視します。 エスケープ シーケンスはホストによって処理されます。 Out-Host は、ANSI エスケープ シーケンスを解釈または変更せずにホストに渡します。

例

例 1: 出力を一度に 1 ページずつ表示する

次の使用例は、システムプロセスを一度に 1 ページずつ表示します。

Get-Process | Out-Host -Paging

NPM(K)    PM(M)      WS(M)     CPU(s)      Id  SI ProcessName
 ------    -----      -----     ------      --  -- -----------
     30    24.12      36.95      15.86   21004  14 ApplicationFrameHost
     55    24.33      60.48      10.80   12904  14 BCompare
<SPACE> next page; <CR> next line; Q quit
      9     4.71       8.94       0.00   16864  14 explorer
<SPACE> next page; <CR> next line; Q quit

Get-Process はシステム プロセスを取得し、パイプラインの下にオブジェクトを送信します。 Out-Hostは、ページング パラメーターを使用して、一度に 1 ページのデータを表示します。

例 2: 変数を入力として使用する

この例では、変数に格納されているオブジェクトを入力として使用します Out-Host。

$io = Get-History
Out-Host -InputObject $io

Get-History は PowerShell セッションの履歴を取得し、オブジェクトを変数に $io 格納します。 Out-Hostは InputObject パラメーターを使用して変数を$io指定し、履歴を表示します。

パラメーター

-InputObject

コンソールに書き込まれるオブジェクトを指定します。 オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Paging

一度に Out-Host 1 ページの出力を表示し、再メインページが表示されるまでユーザー入力を待機することを示します。 既定では、すべての出力が 1 ページに表示されます。 ページ サイズは、ホストの特性によって決まります。

Space バーを押して出力の次のページを表示するか、Enter キーを押して次の出力行を表示します。 Q キーを押して終了します。

ページングは、more コマンドに似ています。

Note

ページング パラメーターは、PowerShell I Standard Edition ホストではサポートされていません。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PSObject

任意のオブジェクトをこのコマンドレットにパイプできます。

出力

None

このコマンドレットは、出力を返しません。 表示のためにホストにオブジェクトを送信します。

メモ

PowerShell には、次のエイリアスが Out-Host含まれています。

  • すべてのプラットフォーム:
    • oh

ページング パラメーターは、すべての PowerShell ホストでサポートされているわけではありません。 たとえば、PowerShell I Standard Edition でページング パラメーターを使用すると、次のエラーが表示されます。out-lineoutput : The method or operation is not implemented.

Out 動詞を含むコマンドレットは、Out-オブジェクトの書式を設定しません。 オブジェクトをレンダリングし、指定した表示先に送信します。 書式設定されていないオブジェクトをコマンドレットに Out- 送信すると、そのオブジェクトをレンダリングする前に、そのオブジェクトが書式設定コマンドレットに送信されます。

コマンドレットには Out- 、名前またはファイル パスのパラメーターがありません。 コマンドレットにデータを Out- 送信するには、パイプラインを使用して PowerShell コマンドの出力をコマンドレットに送信します。 または、変数にデータを格納し、InputObject パラメーターを使用して、コマンドレットにデータを渡すことができます。

Out-Host はデータを送信しますが、出力オブジェクトは生成されません。 コマンドレットへのGet-Member出力Out-Hostをパイプライン化すると、Get-Memberオブジェクトが指定されていないことが報告されます。