PowerShell Cmdlet - Out-Host
 記事記号:[mg1942] 初版:2011/Sep/30

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    Out-Host
    
概要
    出力をコマンド ラインに送ります。
    
構文
    Out-Host [-InputObject <psobject>] [-Paging] [<CommonParameters>]
    
説明
    Out-Host コマンドレットは、出力を Windows PowerShell ホストに送り、表示しま
    す。Windows PowerShell ホストは、出力をコマンド ラインに表示します。Out-Host 
    は既定値であるため、表示変更用のパラメーターを使用しない場合は指定する必要が
    ありません。
    
パラメーター
    -InputObject <psobject>
        コンソールに書き込むオブジェクトを指定します。オブジェクトが格納されてい
        る変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   true (ByValue)
        ワイルドカード文字を許可する false
        
    -Paging [<SwitchParameter>]
        出力を一度に 1 ページずつ表示し、ユーザーからの入力を待って残りのページ
        を表示します。従来の more コマンドによく似ています。既定では、出力は単
        一ページにすべてが表示されます。ページ サイズはホストの特性によって決定
        されます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    System.Management.Automation.PSObject
        パイプを使用して、あらゆるオブジェクトを Out-Host に渡すことができます。
    
出力
    なし
        Out-Host は出力を生成しません。ただし、Out-Host から渡されたオブジェクト
        をホストが表示する場合があります。
    
メモ
        Out-Host は、その組み込みエイリアスである "oh" で参照することもできます。
        詳細については、「about_Aliases」を参照してください。
        
        Out という動詞を含むコマンドレット (Out コマンドレット) はオブジェクトを
        書式設定しません。オブジェクトをレンダリングし、指定された表示先に送るだ
        けです。書式設定されていないオブジェクトを Out コマンドレットに送ると、O
        ut コマンドレットはこのオブジェクトをレンダリングする前に書式設定用コマ
        ンドレットに送ります。
        
        Out コマンドレットには、名前またはファイル パス用のパラメーターがありま
        せん。Out コマンドレットにデータを送るには、Windows PowerShell コマンド
        の出力をコマンドレットに送るパイプライン演算子 (|) を使用します。InputOb
        ject パラメーターを使用すると、変数に保存したデータをコマンドレットに渡
        すこともできます。ヘルプについては、例を参照してください。
        
        Out-Host はデータを送りますが、出力オブジェクトは作成しません。パイプを
        使用して Out-Host の出力を Get-Member に渡すと、Get-Member はオブジェク
        トが指定されていないと報告します。
        
    -------------------------- 例 1 --------------------------
    
    C:\PS>get-process | out-host -paging
    
    説明
    -----------
    このコマンドは、システム上のプロセスを一度に 1 ページずつ表示します。Get-Pro
    cess コマンドを使用して、システム上のプロセスを取得します。結果はパイプライ
    ン演算子 (|) によって 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 に変数を指定します。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113365
    Out-Printer 
    Out-Null 
    Out-File 
    Out-String 
    Out-Default 
    Write-Host 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Out-Host
ご利用数: 1917611
感想・要望・問い合わせは こちら