Write-Error

Sintaxis

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>]

Description

El Write-Error cmdlet declara un error de no terminación. De forma predeterminada, los errores se envían en la secuencia de error al programa host que se va a mostrar, junto con el resultado.

Para escribir un error de no terminación, escriba una cadena de mensaje de error, un objeto ErrorRecord o un objeto Exception . Use los demás parámetros de para rellenar el registro de Write-Error error.

Los errores de no terminación escriben un error en la secuencia de errores, pero no detienen el procesamiento de comandos. Si se declara un error de no terminación en un elemento de una colección de elementos de entrada, el comando sigue procesando los demás elementos de la colección.

Para declarar un error de terminación, use la Throw palabra clave . Para obtener más información, consulte about_Throw.

Ejemplos

Ejemplo 1: Escritura de un error para el objeto RegistryKey

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

Este comando declara un error de no terminación cuando el Get-ChildItem cmdlet devuelve un Microsoft.Win32.RegistryKey objeto, como los objetos de o HKLM: HKCU: las unidades del proveedor del Registro de PowerShell.

Ejemplo 2: Escribir un mensaje de error en la consola

Write-Error "Access denied."

Este comando declara un error de no terminación y escribe un error de acceso denegado. El comando usa el parámetro Message para especificar el mensaje, pero omite el nombre del parámetro Message opcional.

Ejemplo 3: Escribir un error en la consola y especificar la categoría

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

Este comando declara un error de no terminación y especifica una categoría de error.

Ejemplo 4: Escritura de un error mediante un objeto 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 doesn't contain any XML files."

Este comando usa un objeto Exception para declarar un error de no terminación.

El primer comando usa una tabla hash para crear el objeto System.Exception . Guarda el objeto de excepción en la $E variable . Una tabla hash se puede usar para crear cualquier objeto de un tipo que tenga un constructor nulo.

El segundo comando usa el Write-Error cmdlet para declarar un error de no terminación. El valor del parámetro Exception es el objeto Exception de la $E variable .

Parámetros

-Category

-CategoryActivity

-CategoryReason

-CategoryTargetName

-CategoryTargetType

-ErrorId

-ErrorRecord

-Exception

-Message

-RecommendedAction

-TargetObject

Entradas

String

Puede canalizar una cadena que contenga un mensaje de error a este cmdlet.

Salidas

None

Este cmdlet no devuelve ningún resultado. Solo escribe en el flujo de mensajes de error.

Notas

Write-Error no cambia el valor de la $? variable automática, por lo que no indica una condición de error de terminación. Para indicar un error de terminación, use el método $PSCmdlet.WriteError().

Vínculos relacionados

• about_Automatic_Variables
• Acerca de los flujos de salid
• about_Redirection
• Write-Debug
• Write-Host
• Write-Output
• Write-Progress
• Write-Verbose
• Write-Warning