次の方法で共有

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

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

型:PSObject
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Paging

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

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

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

手記

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

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

PSObject

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

出力

None

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

メモ

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

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

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

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

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

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