Write-Debug (Microsoft.PowerShell.Utility)

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 Continue
$DebugPreference is Continue
PS> $DebugPreference
SilentlyContinue

Обратите внимание, что значение $DebugPreference меняется при использовании параметра Debug. Это изменение влияет только на область действия функции. Значение не изменяется вне функции.

Дополнительные сведения об общем параметре Debug см. в разделе about_CommonParameters.

Параметры

-Message

Указывает отладочное сообщение для отправки на консоль.

Тип :

String

Псевдонимы:

Msg

Позиция:

0

Значение по умолчанию:

None

Необходимый:

True

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

False

Входы

Строка

В этот командлет можно передать строку, содержащую отладочное сообщение.

Выходы

Нет

Этот командлет не возвращает никаких результатов. Он пишет только в поток отладки.