Write-Debug
Выводит сообщение отладки на консоль.
Синтаксис
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
Обратите внимание, что значение изменяется $DebugPreference
при использовании параметра Debug . Это изменение влияет только на область функции. Значение не затрагивается за пределами функции.
Примечание
Если значение $DebugPreference
равно Inquire, PowerShell останавливает выполнение, чтобы спросить, следует ли продолжать выполнение.
Дополнительные сведения об общем параметре Debug см. в разделе about_CommonParameters.
Параметры
-Message
Задает сообщение отладки для отправки на консоль.
Type: | String |
Aliases: | Msg |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Входные данные
Вы можете передать строку, содержащую сообщение отладки, в Write-Debug
.
Выходные данные
None
Write-Debug
выполняет запись только в поток отладки. Он не создает никаких выходных данных.