Freigeben über

Write-Error

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Schreibt ein Objekt in den Fehlerdatenstrom.

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 cmdlet Write-Error deklariert einen nicht beendeten Fehler. Standardmäßig werden Fehler im Fehlerdatenstrom an das Hostprogramm gesendet, das angezeigt werden soll, zusammen mit der Ausgabe.

Um einen nicht beendeten Fehler zu schreiben, geben Sie eine Fehlermeldungszeichenfolge, ein ErrorRecord--Objekt oder ein Exception-Objekt ein. Verwenden Sie die anderen Parameter von Write-Error, um den Fehlerdatensatz aufzufüllen.

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

Verwenden Sie das schlüsselwort Throw, 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 cmdlet Get-ChildItem ein Microsoft.Win32.RegistryKey-Objekt zurückgibt, z. B. die Objekte im HKLM: oder HKCU: Laufwerken des PowerShell-Registrierungsanbieters.

Beispiel 2: Schreiben einer Fehlermeldung in die Konsole

Write-Error "Access denied."

Dieser Befehl deklariert einen nicht beendeten Fehler und schreibt einen Fehler "Zugriff verweigert". Der Befehl verwendet den parameter Message, um die Nachricht anzugeben, aber der optionale Message Parametername wird weggelassen.

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

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

Dieser Befehl deklariert einen nicht beendeten Fehler und gibt eine Fehlerkategorie an.

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. Es speichert das Ausnahmeobjekt in der $E Variablen. Sie können eine Hashtabelle verwenden, um ein beliebiges Objekt eines Typs zu erstellen, der über einen NULL-Konstruktor verfügt.

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

Parameter

-Category

Gibt die Kategorie des Fehlers an. Der Standardwert ist NotSpecified. Die zulässigen Werte für diesen Parameter sind:

  • NotSpecified
  • OpenError
  • CloseError
  • DeviceError
  • DeadlockDetected
  • InvalidArgument
  • InvalidData
  • InvalidOperation
  • InvalidResult
  • InvalidType
  • MetadataError
  • NotImplemented
  • NotInstalled
  • ObjectNotFound
  • OperationStopped
  • OperationTimeout
  • SyntaxFehler
  • ParserError
  • PermissionDenied
  • ResourceBusy
  • ResourceExists
  • ResourceUnavailable
  • ReadError
  • WriteError
  • FromStdErr
  • SecurityError
  • ProtocolError
  • ConnectionError
  • AuthenticationError
  • LimitsExceeded
  • QuotaExceeded
  • NotEnabled

Informationen zu den Fehlerkategorien finden Sie unter ErrorCategory Enumeration.

Typ:ErrorCategory
Zulässige Werte: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
Standardwert:NotSpecified
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CategoryActivity

Gibt die Aktion an, die den Fehler verursacht hat.

Typ:String
Aliase:Activity
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CategoryReason

Gibt an, wie oder warum die Aktivität den Fehler verursacht hat.

Typ:String
Aliase:Reason
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CategoryTargetName

Gibt den Namen des Objekts an, das beim Auftreten des Fehlers verarbeitet wurde.

Typ:String
Aliase:TargetName
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CategoryTargetType

Gibt den Typ des Objekts an, das beim Auftreten des Fehlers verarbeitet wurde.

Typ:String
Aliase:TargetType
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ErrorId

Gibt eine ID-Zeichenfolge an, um den Fehler zu identifizieren. Die Zeichenfolge sollte für den Fehler eindeutig sein.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ErrorRecord

Gibt ein Fehlerdatensatzobjekt an, das den Fehler darstellt. Verwenden Sie die Eigenschaften des Objekts, um den Fehler zu beschreiben.

Verwenden Sie zum Erstellen eines Fehlerdatensatzobjekts das cmdlet New-Object oder rufen Sie ein Fehlerdatensatzobjekt aus dem Array in der $Error automatischen Variablen ab.

Typ:ErrorRecord
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Exception

Gibt ein Ausnahmeobjekt an, das den Fehler darstellt. Verwenden Sie die Eigenschaften des Objekts, um den Fehler zu beschreiben.

Verwenden Sie zum Erstellen eines Ausnahmeobjekts eine Hashtabelle oder das cmdlet New-Object.

Typ:Exception
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Message

Gibt den Meldungstext des Fehlers an. Wenn der Text Leerzeichen oder Sonderzeichen enthält, schließen Sie ihn in Anführungszeichen ein. Sie können auch eine Nachrichtenzeichenfolge an Write-Errorübergeben.

Typ:String
Aliase:Msg
Position:0
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-RecommendedAction

Gibt die Aktion an, die der Benutzer ausführen soll, um den Fehler zu beheben oder zu verhindern.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-TargetObject

Gibt das Objekt an, das beim Auftreten des Fehlers verarbeitet wurde. Geben Sie das Objekt, eine Variable, die das Objekt enthält, oder einen Befehl ein, der das Objekt abruft.

Typ:Object
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

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 zum Signalisieren eines Beendigungsfehlers die $PSCmdlet.WriteError() Methode.