次の方法で共有

Write-Debug

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

デバッグ メッセージをコンソールに出力します。

構文

Write-Debug
     [-Message] <String>
     [<CommonParameters>]

説明

Write-Debug コマンドレットは、スクリプトまたはコマンドからホストにデバッグ メッセージを書き込みます。

既定では、デバッグ メッセージはコンソールに表示されませんが、 Debug パラメーターまたは $DebugPreference 変数を使用して表示できます。

例

例 1: $DebugPreferenceについて

この例では、デバッグ メッセージを書き込みます。

Write-Debug "Cannot open file."

$DebugPreferenceの既定値は SilentlyContinue です。 そのため、メッセージはコンソールに表示されません。

例 2: $DebugPreferenceの値を変更する

この例では、 $DebugPreference 変数の値を変更した場合の効果を示します。 まず、 $DebugPreference の現在の値を表示し、デバッグ メッセージの書き込みを試みます。 次に、 $DebugPreference の値を Continue に変更し、デバッグ メッセージを表示できるようにします。

PS> $DebugPreference
SilentlyContinue
PS> Write-Debug "Cannot open file."
PS>
PS> $DebugPreference = "Continue"
PS> Write-Debug "Cannot open file."
DEBUG: Cannot open file.

$DebugPreference の詳細については、「about_Preference_Variables」を参照してください。

例 3: Debug パラメーターを使用して$DebugPreferenceをオーバーライドする

Test-Debug関数は、$DebugPreference変数の値を PowerShell ホストとデバッグ ストリームに書き込みます。 この例では、 Debug パラメーターを使用して、 $DebugPreference 値をオーバーライドします。

function Test-Debug {
    [CmdletBinding()]
    param()
    Write-Debug ('$DebugPreference is ' + $DebugPreference)
    Write-Host ('$DebugPreference is ' + $DebugPreference)
}

PS> Test-Debug
$DebugPreference is SilentlyContinue

PS> Test-Debug -Debug
DEBUG: $DebugPreference is Inquire

Confirm
Continue with this operation?
[Y] Yes  [A] Yes to All  [H] Halt Command  [?] Help (default is "Y"):
$DebugPreference is Inquire
PS> $DebugPreference
SilentlyContinue

Debug パラメーターを使用すると、$DebugPreferenceの値が変わります。 この変更は、関数のスコープにのみ影響します。 この値は関数の外部には影響しません。

Note

$DebugPreferenceの値が Inquire の場合、PowerShell は実行を停止して、実行を続行するかどうかを確認します。

Debug共通パラメーターの詳細については、about_CommonParametersを参照してください。

パラメーター

-Message

コンソールに出力するデバッグ メッセージを指定します。

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

入力

String

デバッグ メッセージを含む文字列をこのコマンドレットにパイプできます。

出力

None

このコマンドレットは、出力を返しません。 デバッグ ストリームにのみ書き込まれます。