【コマンド】Write-Host

コマンドプロンプトでの『echo』に該当する。。。


名前
    Write-Host
   
概要
    ホスト ユーザー インターフェイスを使用してオブジェクトを表示します。
   
構文
    Write-Host [
                [-object] <Object>]
                [-noNewLine]
                [-separator <Object>]
                [-foregroundcolor {
                                   | <Black>
                                   | <Blue>    | <DarkBlue>
                                   | <Green>   | <DarkGreen>
                                   | <Cyan>    | <DarkCyan>
                                   | <Red>     | <DarkRed>
                                   | <Magenta> | <DarkMagenta>
                                   | <Yellow>  | <DarkYellow>
                                   | <Gray>    | <DarkGray>
                                   | <White>
                                  }
                ]
                [-backgroundColor {
                                   | <Black>
                                   | <Blue>    | <DarkBlue>
                                   | <Green>   | <DarkGreen>
                                   | <Cyan>    | <DarkCyan>
                                   | <Red>     | <DarkRed>
                                   | <Magenta> | <DarkMagenta>
                                   | <Yellow>  | <DarkYellow>
                                   | <Gray>    | <DarkGray>
                                   | <White>
                                  }
                ]
                [<CommonParameters>]
   
   
詳細説明
    ホスト ユーザー インターフェイスを使用してオブジェクトを表示します。
    Write-Host は、ホスト ウィンドウをカスタマイズします。
    ForegroundColor パラメータにより、そのウィンドウでのテキストの色を指定できます。
    また、BackgroundColor パラメータにより、ウィンドウの背景色を指定できます。
    Separator パラメータを使用すると、表示オブジェクトを区切るための文字列を指定できます。
   

パラメータ
    -object <Object>
        コンソールに表示するオブジェクト。
       
        必須                         false
        位置                         1
        既定値                       Any
        パイプライン入力を許可する   true (ByValue)
        ワイルドカード文字を許可する false
       
    -noNewLine <SwitchParameter>
        コンソールに表示されるコンテンツの最後に改行文字を使用しないことを指定します。
       
        必須                         false
        位置                         named
        既定値                       False
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
       
    -separator <Object>
        コンソールに表示されるオブジェクトとオブジェクトの間に出力する文字列。
       
        必須                         false
        位置                         named
        既定値                       1 文字のスペース
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
       
    -foregroundcolor <ConsoleColor>
        テキストの色を指定します。
        このパラメータに設定可能な値の一覧を以下に示します。
       
         Black
         Blue     DarkBlue
         Green    DarkGreen
         Cyan     DarkCyan
         Red      DarkRed
         Magenta  DarkMagenta
         Yellow   DarkYellow
         Gray     DarkGray
         White
        
        必須                         false
        位置                         named
        既定値                       ホスト定義
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
       
    -backgroundColor <ConsoleColor>
        背景色を指定します。
        このパラメータに設定可能な値の一覧を以下に示します。
       
         Black
         Blue     DarkBlue
         Green    DarkGreen
         Cyan     DarkCyan
         Red      DarkRed
         Magenta  DarkMagenta
         Yellow   DarkYellow
         Gray     DarkGray
         White
        
        必須                         false
        位置                         named
        既定値                       ホスト定義
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
       
    <CommonParameters>
        このコマンドレットは、次の共通パラメータをサポートします: -Verbose、-Debug、
        -ErrorAction、-ErrorVariable、および -OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
   
入力の種類
    Any
    
   
戻り値の型
   
    
   
メモ
   
   
        詳細を参照するには、「Get-Help Write-Host -detailed」と入力してください。
        技術情報を参照するには、「Get-Help Write-Host -full」と入力してください。
       
        パラメータに複数の値を指定するときは、各値をコンマで区切ります。
        たとえば、"<パラメータ名> <値 1>, <値 2>" と指定します。
       
   
    -------------------------- 例 1 --------------------------
   
    C:\PS>write-host "no newline test" -nonewline
   
   
    このコマンドは入力をコンソールに表示しますが、
    nonewline パラメータが指定されているため、出力の直後にプロンプトが続いて表示されます。
   
   
   
   
   
    -------------------------- 例 2 --------------------------
   
    C:\PS>write-host (2,4,6,8,10,12) -Separator ", +2= "
   
   
    このコマンドは、2 〜 12 の範囲の偶数を表示します。
    ", +2= " (コンマ、スペース、+、2、=、スペース) という文字列を追加するため、
    Separator パラメータが使用されています。
   
   
    2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12
   
   
    -------------------------- 例 3 --------------------------
   
    C:\PS>write-host (2,4,6,8,10,12) -Separator ", -> "
           -foregroundcolor DarkGreen -backgroundcolor white
   
   
    このコマンドは、2 〜 12 の範囲の偶数を表示します。
    Foreground パラメータを使用してテキストを濃い緑色で出力し、
    Background パラメータを使用して背景を白で表示します。
   
   
   
   
   
   
関連するリンク
    Write-Verbose
    Write-Error
    Write-Progress
    Write-Debug
    write-Output
    Write-Warning
    Out-Host
    Clear-Host

<< 【コマンド】ForEach-Object | ホーム |


コメント

コメントの投稿


管理者にだけ表示を許可する

 BLOG TOP