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

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

名前
    Write-Host
    
概要
    カスタマイズされた出力をホストに書き込みます。
    
構文
    Write-Host [[-Object] <Object>] [-BackgroundColor {Black | DarkBlue | DarkGr
    een | DarkCyan | DarkRed | DarkMagenta | DarkYellow | Gray | DarkGray | Blue 
    | Green | Cyan | Red | Magenta | Yellow | White}] [-ForegroundColor {Black | 
    DarkBlue | DarkGreen | DarkCyan | DarkRed | DarkMagenta | DarkYellow | Gray 
    | DarkGray | Blue | Green | Cyan | Red | Magenta | Yellow | White}] [-NoNewl
    ine] [-Separator <Object>] [<CommonParameters>]
    
説明
    Write-Host コマンドレットは、出力をカスタマイズします。ForegroundColor パラ
    メーターを使用して、テキストの色を指定できます。また、BackgroundColor パラメ
    ーターを使用して、背景色を指定できます。Separator パラメーターを使用すると、
    表示オブジェクトを区切るための文字列を指定できます。具体的な結果は、Windows 
    PowerShell をホストしているプログラムによって異なります。
    
パラメーター
    -BackgroundColor <ConsoleColor>
        背景色を指定します。既定値はありません。
        
        必須                         false
        位置                         named
        既定値                       なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -ForegroundColor <ConsoleColor>
        テキストの色を指定します。既定値はありません。
        
        必須                         false
        位置                         named
        既定値                       なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -NoNewline [<SwitchParameter>]
        コンソールに表示されるコンテンツの最後に改行文字を使用しないことを指定し
        ます。
        
        必須                         false
        位置                         named
        既定値                       なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Object <Object>
        コンソールに表示するオブジェクト。
        
        必須                         false
        位置                         1
        既定値                       なし
        パイプライン入力を許可する   true (ByValue)
        ワイルドカード文字を許可する false
        
    -Separator <Object>
        コンソールに表示されるオブジェクトとオブジェクトの間に出力する文字列。
        
        必須                         false
        位置                         named
        既定値                       なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    System.Object
        パイプを使用して、書き込むオブジェクトをホストに渡すことができます。
    
出力
    なし
        Write-Host は、オブジェクトをホストに渡します。このコマンドレットはオブ
        ジェクトを返しません。ただし、Write-Host から渡されたオブジェクトをホス
        トが表示する場合があります。
    
メモ
    -------------------------- 例 1 --------------------------
    
    C:\PS>write-host "no newline test " -nonewline
    
    no newline test C:\PS>
    
    説明
    -----------
    このコマンドは入力をコンソールに表示しますが、NoNewline パラメーターが指定さ
    れているため、出力の直後にプロンプトが続いて表示されます。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>write-host (2,4,6,8,10,12) -Separator ", +2= "
    
    2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12
    
    説明
    -----------
    このコマンドは、2 〜 12 の範囲の偶数を表示します。", +2= " (コンマ、スペース、
    +、2、=、スペース) という文字列を追加するため、Separator パラメーターが使用
    されています。
    
    -------------------------- 例 3 --------------------------
    
    C:\PS>write-host (2,4,6,8,10,12) -Separator ", -> " -foregroundcolor DarkGre
    en -backgroundcolor white
    
    説明
    -----------
    このコマンドは、2 〜 12 の範囲の偶数を表示します。ForegroundColor パラメータ
    ーを使用してテキストを濃い緑色で出力し、BackgroundColor パラメーターを使用し
    て背景を白で表示します。
    
    -------------------------- 例 4 --------------------------
    
    C:\PS>write-host "Red on white text." -ForegroundColor red -BackgroundColor 
    white
    
    Red on white text.
    
    説明
    -----------
    このコマンドを実行すると、"Red on white text" という文字列が表示されます。Fo
    regroundColor パラメーターで定義されたとおり、テキストは赤です。BackgroundCo
    lor パラメーターで定義されたとおり、背景は白です。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113426
    Write-Verbose 
    Write-Error 
    Write-Progress 
    Write-Debug 
    Write-Output 
    Write-Warning 
    Out-Host 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Write-Host
ご利用数: 1858242
感想・要望・問い合わせは こちら