Share via

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 値を [続行] に変更します。これにより、デバッグ メッセージを表示できます。

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値が変更されます。 この変更は、関数のスコープにのみ影響します。 値は関数の外部では影響を受けません。

注意

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

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

パラメーター

-Message

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

Type:String
Aliases:Msg
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

入力

String

デバッグ メッセージを含む文字列を に Write-Debugパイプできます。

出力

None

Write-Debug は、デバッグ ストリームへの書き込みのみを行います。 出力は返しません。