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

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."

Эта команда объявляет устранимую ошибку с помощью объекта Exception.

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

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

Параметры

-Category

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

  • 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
  • LimitsExceededed
  • QuotaExceeded
  • NotEnabled

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

Type:ErrorCategory
Accepted values: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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CategoryActivity

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

Type:String
Aliases:Activity
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CategoryReason

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

Type:String
Aliases:Reason
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CategoryTargetName

Задает имя объекта, который обрабатывался во время возникновения ошибки.

Type:String
Aliases:TargetName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CategoryTargetType

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

Type:String
Aliases:TargetType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorId

Задает строку идентификатора для идентификации ошибки. Эта строка должны быть уникальной для конкретной ошибки.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorRecord

Задает объект записи об ошибке. Для описания ошибки используются свойства объекта.

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

Type:ErrorRecord
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Exception

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

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

Type:Exception
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Message

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

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

-RecommendedAction

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TargetObject

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

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

String

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

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

Error object

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

Примечания

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