Поделиться через


Write-Debug

Записывает в консоль сообщение отладки.

Синтаксис

Default (по умолчанию)

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

Описание

Командлет Write-Debug записывает отладочные сообщения на хост из скрипта или команды.

По умолчанию отладочные сообщения не отображаются в консоли, но их можно отобразить с помощью параметра отладки или переменной $DebugPreference.

Примеры

Пример 1. Понимание $DebugPreference

В этом примере записывается отладочное сообщение.

Write-Debug "Cannot open file."

Значение по умолчанию $DebugPreferenceSilentlyContinue. Поэтому сообщение не отображается в консоли.

Пример 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. Использование параметра отладки для переопределения $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 изменяется при использовании параметра отладки. Это изменение влияет только на область действия функции. Значение не затрагивается за пределами функции.

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

Параметры

-Message

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

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:Msg

Наборы параметров

(All)
Position:0
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

String

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

Выходные данные

None

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