PowerShell HelpFile - about_CommonParameters
 記事記号:[me1521] 初版:2011/May/10

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

トピック
    about_CommonParameters

簡易説明
    すべてのコマンドレットで使用できるパラメーターについて説明します。

詳細説明
    共通パラメーターは、すべてのコマンドレットで使用することができるコマンドレッ
    ト パラメーターのセットです。共通パラメーターは、コマンドレットの開発者が実
    装するのではなく、Windows PowerShell によって実装され、自動的にすべてのコマ
    ンドレットで使用できるようになります。

    共通パラメーターはどのコマンドレットでも使用できますが、一部のコマンドレット
    に対しては効力がない場合があります。たとえば、コマンドレットが詳細出力を生成
    しない場合、Verbose 共通パラメーターを使用しても効力はありません。

    いくつかの共通パラメーターは、Windows PowerShell のユーザー設定変数を使用して
    設定するシステムの既定値またはユーザー設定をオーバーライドします。ユーザー設
    定変数とは異なり、共通パラメーターは、共通パラメーターが使用されているコマン
    ドにのみ影響します。
    
    共通パラメーターに加えて、多くのコマンドレットでは WhatIf と Confirm というリ
    スク軽減パラメーターを使用できます。システムまたはユーザー データのリスクに関
    連するコマンドレットでは、通常これらのパラメーターを使用できます。

    共通パラメーターには、以下のものがあります。

       -Verbose
       -Debug
       -WarningAction
       -WarningVariable
       -ErrorAction
       -ErrorVariable
       -OutVariable
       -OutBuffer
 
    リスク軽減パラメーターには、次のものがあります。

       -WhatIf
       -Confirm

    ユーザー設定変数の詳細については、次のように入力してください。
  
       help about_preference_variables

  共通パラメーターの説明       

    -Verbose[:{$true | $false}]

        コマンドによって実行される操作の詳細情報を表示します。この情報は、トレー
        スやトランザクション ログの情報に似ています。このパラメーターは、コマン
        ドが詳細メッセージを生成する場合にのみ有効です。たとえば、このパラメータ
        ーはコマンドに Write-Verbose コマンドレットが含まれている場合に有効にな
        ります。
        
        Verbose パラメーターは、現在のコマンドの $VerbosePreference 変数の値をオ
        ーバーライドします。$VerbosePreference 変数の既定値が SilentlyContinue 
        であるため、既定では詳細メッセージは表示されません。

        有効な値は次のとおりです。

            $true (-Verbose:$true) の場合は、-Verbose と同じ結果になります。

            $false (-Verbose:$false) の場合は、詳細メッセージの表示が抑止されま
            す。$VerbosePreference の値が SilentlyContinue (既定値) ではない場合
            に、このパラメーターを使用します。

    -Debug[:{$true | $false}]

        コマンドによって実行される操作のプログラマ レベルの詳細情報を表示します。
        このパラメーターは、コマンドがデバッグ メッセージを生成する場合にのみ有
        効です。たとえば、このパラメーターはコマンドに Write-Debug コマンドレッ
        トが含まれている場合に有効になります。
    
        Debug パラメーターは、現在のコマンドの $DebugPreference 変数の値をオーバ
        ーライドします。$DebugPreference 変数の既定値が SilentlyContinue である
        ため、既定ではデバッグ メッセージは表示されません。
       
        有効な値は次のとおりです。

            $true (-Debug:$true)。-Debug と同じ結果になります。

            $false (-Debug:$false)。$DebugPreference の値が 
            SilentlyContinue (既定値) でない場合に、デバッグ メッセージの表示を
            抑止します。

    -WarningAction[:{SilentlyContinue | Continue | Inquire | Stop}]

        コマンドレットがコマンドからの警告に応答する方法を決定します。
        既定値は "Continue" です。このパラメーターは、コマンドが警告メッセージを
        生成する場合にのみ有効です。たとえば、このパラメーターはコマンドに Write
        -Warning コマンドレットが含まれている場合に有効になります。

        WarningAction パラメーターは、現在のコマンドの $WarningPreference 変数の
        値をオーバーライドします。$WarningPreference 変数の既定値が Continue で
        あるため、警告が表示され、WarningAction パラメーターを使用しない限り実行
        が継続されます。

         有効な値は次のとおりです。

            SilentlyContinue。警告メッセージが表示されないようにし、コマンドの実
            行を継続します。

            Continue。警告メッセージを表示し、コマンドの実行を継続します。既定値
            は"Continue" です。
 
            Inquire。警告メッセージを表示し、実行を継続する前に確認メッセージを
            表示します。この値を使用するのはまれです。

            Stop。警告メッセージを表示し、コマンドの実行を停止します。

    -WarningVariable [+]

        指定された変数のコマンドに関する警告を格納します。

        変数の内容に警告を追加するには、既に格納されている警告があっても置き換え
        ず、変数名の前にプラス記号 (+) を入力します。

        たとえば、次のコマンドは変数 $a を作成し、その変数に任意の警告を格納しま
        す。

            get-process -id 6 -WarningVariable a

        次のコマンドは、任意の警告を変数 $a に追加します。

            get-process -id 2 -WarningVariable +a

        次のコマンドは $a の内容を表示します。

            $a                                     

        このパラメーターを使用して、特定のコマンドからの警告のみを格納する変数を
        作成できます。$a[0] や $warning[1,2] などの配列表記を使用して、変数に格
        納されている特定の警告を参照できます。

    -ErrorAction[:{SilentlyContinue | Continue | Inquire | Stop)]

        コマンドレットがコマンドからの未終了エラーに応答する方法を決定します。こ
        のパラメーターは、コマンドがデバッグ メッセージを生成する場合にのみ有効
        です。たとえば、このパラメーターはコマンドに Write-Error コマンドレット
        が含まれている場合に有効になります。

        ErrorAction パラメーターは、現在のコマンドの $ErrorActionPreference 変数
        の値をオーバーライドします。$ErrorActionPreference 変数の既定値は Contin
        ue であるため、エラー メッセージが表示され、ErrorAction パラメーターを使
        用しない限り実行が継続されます。

        ErrorAction パラメーターは、コマンドの正常な完了を妨げるような終了エラー
        (データが見つからない、パラメーターが無効である、十分なアクセス許可がな
        いなど) には効力がありません。

        有効な値は次のとおりです。

            SilentlyContinue。エラー メッセージが表示されないようにし、コマンド
            の実行を継続します。

            Continue。エラー メッセージを表示し、コマンドの実行を継続します。既
            定値は "Continue" です。
 
            Inquire。エラー メッセージを表示し、実行を継続する前に確認メッセージ
            を表示します。この値を使用するのはまれです。

            Stop。エラー メッセージを表示し、コマンドの実行を停止します。
            
    -ErrorVariable [+]

        コマンドに関するエラー メッセージを指定された変数および $Error 自動変数
        に格納します。詳細については、次のコマンドを入力してください。

            get-help about_automatic_variables

        既定では、変数に既に格納されているエラー メッセージが新しいエラー メッセ
        ージに上書きされます。変数の内容にエラー メッセージを追加するには、変数
        名の前にプラス記号 (+) を入力します。

        たとえば、次のコマンドは変数 $a を作成し、その変数に任意のエラーを格納し
        ます。

            get-process -id 6 -ErrorVariable a

        次のコマンドは、任意のエラー メッセージを変数 $a に追加します。

            get-process -id 2 -ErrorVariable +a

        次のコマンドは $a の内容を表示します。

            $a                                     

        このパラメーターを使用して、特定のコマンドからのエラー メッセージのみを
        格納する変数を作成できます。$Error 自動変数には、セッション内のすべての
        コマンドによるエラー メッセージが格納されます。
        $a[0] や $error [1,2] などの配列表記を使用して、変数に格納されている特定
        のエラーを参照できます。

    -OutVariable [+]

        コマンドからの出力オブジェクトを指定された変数に格納し、コマンド ライン
        に表示します。

        変数に出力を追加するには、既に保存されている出力があっても置き換えず、変
        数名の前にプラス記号 (+) を入力します。

        たとえば、次のコマンドは変数 $out を作成し、その変数にプロセス オブジェ
        クトを格納します。

            get-process powershell -OutVariable out

        次のコマンドは、プロセス オブジェクトを変数 $out に追加します。

            get-process iexplore -OutVariable +out

        次のコマンドは、変数 $out の内容を表示します。

            $out                                         

    -OutBuffer 

        パイプライン経由でオブジェクトが送信されるまでにバッファーに蓄積するオブ
        ジェクト数を決定します。このパラメーターを省略した場合、オブジェクトは生
        成されると同時に送信されます。
        
        このリソース管理パラメーターは、詳しい知識のあるユーザー向けに設計されて
        います。このパラメーターを使用すると、Windows PowerShell で、生成される
        オブジェクト数が OutBuffer で指定した数より 1 つ多くなるまでパイプライン
        にある次のコマンドレットは呼び出されません。したがって、すべてのオブジェ
        クトが生成されてから同時に送信されます。
        
  リスク管理パラメーターの説明         
    -WhatIf[:{$true | $false}]
        コマンドを実行する代わりに、コマンドの結果を説明するメッセージを表示しま
        す。

        WhatIf パラメーターは、現在のコマンドの $WhatIfPreference 変数の値をオー
        バーライドします。$WhatIfPreference 変数の既定値は 0 (無効) であるため、
        WhatIf の動作は WhatIf パラメーターなしでは実行されません。詳細については、
        次のコマンドを入力してください。

            get-help about_preference_variables

        有効な値は次のとおりです。

            $true (-WhatIf:$true)。-WhatIf と同じ結果になります。           
            
            $false (-WhatIf:$false)。$WhatIfPreference 変数の値が 1 
            であった場合に発生する自動的な WhatIf の動作を抑止します。

        たとえば、次のコマンドは Remove-Item コマンドの WhatIf パラメーターを使
        用します。

            PS> remove-item date.csv -whatif

        項目を削除する代わりに、Windows PowerShell は実行する操作および影響を受
        ける項目を一覧表示します。このコマンドの出力は次のようになります。

            WhatIf: 対象 "C:\ps-test\date.csv" に対して操作 "ファイルの削除" を
            実行しています。

        
    -Confirm[:{$true | $false}]
        コマンドを実行する前に確認メッセージを表示します。

        Confirm パラメーターは、現在のコマンドの $ConfirmPreference 変数の値をオ
        ーバーライドします。既定値は High です。詳細については、次のコマンドを入
        力してください。

            get-help about_preference_variables 
        
        有効な値は次のとおりです。

            $true (-WhatIf:$true)。-Confirm と同じ結果になります。          

            $false(-Confirm:$false)。$ConfirmPreference の値がコマンドレット
            の推定リスク以下であった場合に表示される自動確認メッセージを抑止しま
            す。

        たとえば、次のコマンドは Remove-Item コマンドで Confirm パラメーターを使
        用しています。Windows PowerShell は、項目を削除する前に、実行する操作お
        よび影響を受ける項目を一覧表示し、承認するよう求めます。

            PS C:\ps-test> remove-item tmp*.txt -confirm

        このコマンドの出力は次のようになります。

            確認
            この操作を実行しますか?
            対象 "C:\ps-test\tmp1.txt" に対して操作 "ファイルの削除" を実行して
            います。[Y] はい [A] すべて続行 [N] いいえ [L] すべて無視 [S] 中断
            [?] ヘルプ (既定値は "Y"):

関連項目
    about_Preference_Variables
    Write-Debug
    Write-Warning
    Write-Error
    Write-Verbose
	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、HelpFile、about_CommonParameters
ご利用数: 1862292
感想・要望・問い合わせは こちら