次の方法で共有


Write-Debug

デバッグ メッセージをコンソールに書き込みます。

構文

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

説明

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

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

パラメーター

-Message <string>

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

必須

true

位置

1

既定値

パイプライン入力を許可する

true (ByValue)

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.

入力と出力

入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。

入力

System.String

パイプを使用してデバッグ メッセージを含む文字列を Write-Debug に渡すことができます。

出力

なし

Write-Debug は、デバッグ ストリームに対してのみ書き込みを行います。このコマンドレットによる戻り値はありません。

例 1

C:\PS>Write-Debug "Cannot open file."

説明
-----------
このコマンドは、デバッグ メッセージを書き込みます。$DebugPreference の値が "SilentlyContinue" であるため、このメッセージはコンソールに表示されません。





例 2

C:\PS>$DebugPreference

SilentlyContinue

C:\PS> Write-Debug "Cannot open file."
C:\PS>

C:\PS> Write-Debug "Cannot open file." -debug
DEBUG: Cannot open file.

説明
-----------
この例は、Debug 共通パラメーターを使用して、特定コマンドの $DebugPreference 変数の値を上書きする方法を示しています。

最初のコマンドは $DebugPreference 変数の値を表示します。この変数は既定の "SilentlyContinue" です。

2 番目のコマンドはデバッグ メッセージを書き込みますが、$DebugPreference の値によってメッセージは表示されません。

3 番目のコマンドはデバッグ メッセージを書き込みます。Debug 共通パラメーターを使用して、$DebugPreference の値を上書きしたり、このコマンドから作成されるデバッグ メッセージを表示したりします。

その結果、$DebugPreference の値は "SilentlyContinue" ですが、デバッグ メッセージは表示されます。


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





例 3

C:\PS>$DebugPreference

SilentlyContinue

C:\PS> Write-Debug "Cannot open file."
C:\PS>

C:\PS> $DebugPreference = "Continue"

C:\PS> Write-Debug "Cannot open file."
DEBUG: Cannot open file.

説明
-----------
このコマンドは、$DebugPreference 変数の値を変更した場合にデバッグ メッセージの表示に与える影響を示しています。

最初のコマンドは $DebugPreference 変数の値を表示します。この変数は既定の "SilentlyContinue" です。

2 番目のコマンドはデバッグ メッセージを書き込みますが、$DebugPreference の値によってメッセージは表示されません。

3 番目のコマンドは、"Continue" の値を $DebugPreference 変数に代入します。

4 番目のコマンドはデバッグ メッセージを書き込みます。このメッセージはコンソールに表示されます。

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





関連項目

概念

Write-Verbose
Write-Error
Write-Host
Write-Progress
Write-Output
Write-Warning