Write-Error

Syntax

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

Beschreibung

Das Write-Error Cmdlet deklariert einen nicht beendeten Fehler. Standardmäßig werden Fehler im Fehlerdatenstrom an das Hostprogramm gesendet und zusammen mit der Ausgabe angezeigt.

Wenn Sie einen nicht beendeten Fehler schreiben möchten, geben Sie eine Fehlermeldungszeichenfolge, ein ErrorRecord-Objekt oder ein Exception-Objekt ein. Verwenden Sie die anderen Parameter zum Write-Error Auffüllen des Fehlerdatensatzes.

Nicht beendete Fehler schreiben einen Fehler in den Fehlerdatenstrom, beenden die Befehlsverarbeitung jedoch nicht. Wenn ein Fehler ohne Abbruch für ein einzelnes Element in einer Auflistung von Eingabeelementen deklariert wird, verarbeitet der Befehl weiterhin die anderen Elemente in der Auflistung.

Verwenden Sie das Throw Schlüsselwort, um einen Beendigungsfehler zu deklarieren. Weitere Informationen finden Sie unter about_Throw.

Beispiele

Beispiel 1: Schreiben eines Fehlers für das RegistryKey-Objekt

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

Mit diesem Befehl wird ein nicht beendeter Fehler deklariert, wenn das Get-ChildItem Cmdlet ein Microsoft.Win32.RegistryKey Objekt zurückgibt, z. B. die Objekte in den HKLM: Oder HKCU: Laufwerken des PowerShell-Registrierungsanbieters.

Beispiel 2: Schreiben einer Fehlermeldung in die Konsole

Write-Error "Access denied."

Mit diesem Befehl wird ein Fehler ohne Abbruch deklariert und ein Fehler des Typs „Zugriff verweigert“ geschrieben. Der Befehl verwendet den Parameter "Message ", um die Nachricht anzugeben, aber der optionale Name des Nachrichtenparameters wird weggelassen.

Beispiel 3: Schreiben eines Fehlers in die Konsole und Angeben der Kategorie

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

Mit diesem Befehl wird ein Fehler ohne Abbruch deklariert und eine Fehlerkategorie angegeben.

Beispiel 4: Schreiben eines Fehlers mithilfe eines Exception-Objekts

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

Dieser Befehl verwendet ein Exception-Objekt , um einen nicht beendeten Fehler zu deklarieren.

Der erste Befehl verwendet eine Hashtabelle, um das System.Exception-Objekt zu erstellen. Das Ausnahmeobjekt wird in der $E Variablen gespeichert. Mithilfe einer Hashtabelle können Sie ein beliebiges Objekt eines Typs erstellen, der über einen NULL-Konstruktor verfügt.

Der zweite Befehl verwendet das Write-Error Cmdlet, um einen nicht beendeten Fehler zu deklarieren. Der Wert des Exception-Parameters ist das Exception-Objekt in der $E Variablen.

Parameter

-Category

-CategoryActivity

-CategoryReason

-CategoryTargetName

-CategoryTargetType

-ErrorId

-ErrorRecord

-Exception

-Message

-RecommendedAction

-TargetObject

Eingaben

String

Sie können eine Zeichenfolge mit einer Fehlermeldung an dieses Cmdlet weiterleiten.

Ausgaben

None

Dieses Cmdlet gibt keine Ausgabe zurück. Er schreibt nur in den Fehlermeldungsstream.

Hinweise

Write-Error ändert nicht den Wert der $? automatischen Variablen, daher signalisiert sie keine Beendigungsfehlerbedingung. Verwenden Sie die $PSCmdlet.WriteError() -Methode, um einen Beendigungsfehler zu signalisieren.

Ähnliche Themen

• about_Automatic_Variables
• about_Output_Streams
• about_Redirection
• Write-Debug
• Write-Host
• Write-Output
• Write-Progress
• Write-Verbose
• Write-Warning