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

Write-Error

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Записывает объект в поток ошибок.

Синтаксис

Write-Error
     [-Message] <String>
     [-Category <ErrorCategory>]
     [-ErrorId <String>]
     [-TargetObject <Object>]
     [-RecommendedAction <String>]
     [-CategoryActivity <String>]
     [-CategoryReason <String>]
     [-CategoryTargetName <String>]
     [-CategoryTargetType <String>]
     [<CommonParameters>]
Write-Error
     -Exception <Exception>
     [[-Message] <String>]
     [-Category <ErrorCategory>]
     [-ErrorId <String>]
     [-TargetObject <Object>]
     [-RecommendedAction <String>]
     [-CategoryActivity <String>]
     [-CategoryReason <String>]
     [-CategoryTargetName <String>]
     [-CategoryTargetType <String>]
     [<CommonParameters>]
Write-Error
     -ErrorRecord <ErrorRecord>
     [-RecommendedAction <String>]
     [-CategoryActivity <String>]
     [-CategoryReason <String>]
     [-CategoryTargetName <String>]
     [-CategoryTargetType <String>]
     [<CommonParameters>]

Описание

Командлет Write-Error объявляет ошибку без конца. По умолчанию ошибки отправляются в поток ошибок в отображаемую программу узла вместе с выходными данными.

Чтобы написать ошибку без конца, введите строку сообщения об ошибке, объект ErrorRecord или объект Exception. Используйте другие параметры Write-Error для заполнения записи об ошибке.

Не завершающие ошибки записывают ошибку в поток ошибок, но не останавливают обработку команд. Если ошибка, не завершающаяся, объявлена на одном элементе в коллекции входных элементов, команда продолжает обрабатывать другие элементы в коллекции.

Чтобы объявить завершающееся сообщение об ошибке, используйте ключевое слово Throw. Дополнительные сведения см. в about_Throw.

Примеры

Пример 1. Запись ошибки для объекта RegistryKey

Get-ChildItem | ForEach-Object {
    if ($_.GetType().ToString() -eq "Microsoft.Win32.RegistryKey")
    {
        Write-Error "Invalid object" -ErrorId B1 -TargetObject $_
    }
    else
    {
        $_
    }
}

Эта команда объявляет ошибку без конца, когда командлет Get-ChildItem возвращает объект Microsoft.Win32.RegistryKey, например объекты в HKLM: или HKCU: дисках поставщика реестра PowerShell.

Пример 2. Запись сообщения об ошибке в консоль

Write-Error "Access denied."

Эта команда объявляет ошибку без прекращения и записывает ошибку "Отказано в доступе". Команда использует параметр Message для указания сообщения, но не указывает необязательное имя параметра Message.

Пример 3. Запись ошибки в консоль и указание категории

Write-Error -Message "Error: Too many input values." -Category InvalidArgument

Эта команда объявляет несрочную ошибку и указывает категорию ошибок.

Пример 4. Запись ошибки с помощью объекта Exception

$E = [System.Exception]@{Source="Get-ParameterNames.ps1";HelpLink="https://go.microsoft.com/fwlink/?LinkID=113425"}
Write-Error -Exception $E -Message "Files not found. The $Files location does not contain any XML files."

Эта команда использует объект исключения , чтобы объявить ошибку без конца.

Первая команда использует хэш-таблицу для создания объекта System.Exception . Он сохраняет объект исключения в переменной $E. Хэш-таблица можно использовать для создания любого объекта типа с конструктором NULL.

Вторая команда использует командлет Write-Error для объявления неустранимой ошибки. Значение параметра исключения является объектом исключения в переменной .

Параметры

-Category

Указывает категорию ошибки. Значение по умолчанию — NotSpecified. Допустимые значения для этого параметра:

  • NotSpecified
  • OpenError
  • CloseError
  • DeviceError
  • ВзаимоблокировкаDetected
  • InvalidArgument
  • InvalidData
  • InvalidOperation
  • InvalidResult
  • InvalidType
  • MetadataError
  • NotImplemented
  • NotInstalled
  • ObjectNotFound
  • ОперацияStopped
  • OperationTimeout
  • СинтаксисError
  • ParserError
  • PermissionDenied
  • ResourceBusy
  • ResourceExists
  • ResourceUnavailable
  • ReadError
  • WriteError
  • FromStdErr
  • SecurityError
  • ProtocolError
  • ConnectionError
  • AuthenticationError
  • ОграниченияExceed
  • КвотаExceeded
  • NotEnabled

Сведения о категориях ошибок см. в перечисления errorCategory.

Тип:ErrorCategory
Допустимые значения:NotSpecified, OpenError, CloseError, DeviceError, DeadlockDetected, InvalidArgument, InvalidData, InvalidOperation, InvalidResult, InvalidType, MetadataError, NotImplemented, NotInstalled, ObjectNotFound, OperationStopped, OperationTimeout, SyntaxError, ParserError, PermissionDenied, ResourceBusy, ResourceExists, ResourceUnavailable, ReadError, WriteError, FromStdErr, SecurityError, ProtocolError, ConnectionError, AuthenticationError, LimitsExceeded, QuotaExceeded, NotEnabled
Position:Named
Default value:NotSpecified
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-CategoryActivity

Указывает действие, вызвавшее ошибку.

Тип:String
Aliases:Activity
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-CategoryReason

Указывает, как или почему действие вызвало ошибку.

Тип:String
Aliases:Reason
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-CategoryTargetName

Указывает имя объекта, обрабатываемого при возникновении ошибки.

Тип:String
Aliases:TargetName
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-CategoryTargetType

Указывает тип объекта, который обрабатывается при возникновении ошибки.

Тип:String
Aliases:TargetType
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ErrorId

Указывает строку идентификатора для идентификации ошибки. Строка должна быть уникальной для ошибки.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ErrorRecord

Указывает объект записи об ошибке, представляющий ошибку. Используйте свойства объекта для описания ошибки.

Чтобы создать объект записи об ошибке, используйте командлет New-Object или получите объект записи ошибок из массива в $Error автоматической переменной.

Тип:ErrorRecord
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Exception

Указывает объект исключения, представляющий ошибку. Используйте свойства объекта для описания ошибки.

Чтобы создать объект исключения, используйте хэш-таблицу или используйте командлет New-Object.

Тип:Exception
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Message

Задает текст сообщения об ошибке. Если текст содержит пробелы или специальные символы, заключите его в кавычки. Можно также передать строку сообщения в Write-Error.

Тип:String
Aliases:Msg
Position:0
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-RecommendedAction

Указывает действие, которое пользователь должен предпринять, чтобы устранить или предотвратить ошибку.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-TargetObject

Указывает объект, обрабатываемый при возникновении ошибки. Введите объект, переменную, содержащую объект, или команду, которая получает объект.

Тип:Object
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

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

String

Можно передать строку, содержащую сообщение об ошибке, в Write-Error.

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

Error object

Write-Error записывает только в поток ошибок. Он не возвращает объекты.

Примечания

Write-Error не изменяет значение автоматической переменной $?, поэтому она не сигнализирует о завершающейся ошибке. Чтобы сигнализировать об ошибке конца, используйте метод $PSCmdlet.WriteError().