Partager via

Write-Error

  • Référence
Module:
Microsoft.PowerShell.Utility

Écrit un objet dans le flux d’erreurs.

Syntaxe

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

L’applet de commande Write-Error déclare une erreur sans fin. Par défaut, les erreurs sont envoyées dans le flux d’erreurs au programme hôte à afficher, ainsi que la sortie.

Pour écrire une erreur sans fin, entrez une chaîne de message d’erreur, un objet ErrorRecord ou un objet Exception Exception. Utilisez les autres paramètres de Write-Error pour remplir l’enregistrement d’erreur.

Les erreurs sans fin écrivent une erreur dans le flux d’erreurs, mais elles n’arrêtent pas le traitement des commandes. Si une erreur de non-fin est déclarée sur un élément d’une collection d’éléments d’entrée, la commande continue de traiter les autres éléments de la collection.

Pour déclarer une erreur de fin, utilisez le mot clé Throw. Pour plus d’informations, consultez about_Throw.

Exemples

Exemple 1 : Écrire une erreur pour l’objet RegistryKey

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

Cette commande déclare une erreur de non-fin lorsque l’applet de commande Get-ChildItem retourne un objet Microsoft.Win32.RegistryKey, tel que les objets dans le HKLM: ou les lecteurs HKCU: du fournisseur de Registre PowerShell.

Exemple 2 : Écrire un message d’erreur dans la console

Write-Error "Access denied."

Cette commande déclare une erreur sans fin et écrit une erreur « Accès refusé ». La commande utilise le paramètre Message pour spécifier le message, mais omettez le nom de paramètre facultatif Message.

Exemple 3 : Écrire une erreur dans la console et spécifier la catégorie

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

Cette commande déclare une erreur sans fin et spécifie une catégorie d’erreur.

Exemple 4 : Écrire une erreur à l’aide d’un objet 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."

Cette commande utilise un objet Exception pour déclarer une erreur sans fin.

La première commande utilise une table de hachage pour créer l’objet System.Exception. Il enregistre l’objet d’exception dans la variable $E. Vous pouvez utiliser une table de hachage pour créer n’importe quel objet d’un type qui a un constructeur Null.

La deuxième commande utilise l’applet de commande Write-Error pour déclarer une erreur sans fin. La valeur du paramètre exception est l’objet Exception dans la variable .

Paramètres

-Category

Spécifie la catégorie de l’erreur. La valeur par défaut est NotSpecified. Les valeurs acceptables pour ce paramètre sont les suivantes :

  • NotSpecified
  • OpenError
  • CloseError
  • DeviceError
  • DeadlockDetected
  • InvalidArgument
  • InvalidData
  • InvalidOperation
  • InvalidResult
  • InvalidType
  • MetadataError
  • NotImplemented
  • Non installé
  • ObjectNotFound
  • OperationStopped
  • OperationTimeout
  • SyntaxError
  • ParserError
  • PermissionDenied
  • ResourceBusy
  • ResourceExists
  • ResourceUnavailable
  • ReadError
  • WriteError
  • FromStdErr
  • SecurityError
  • ProtocolError
  • ConnectionError
  • AuthenticationError
  • LimitsExceeded
  • QuotaExceededed
  • NotEnabled

Pour plus d’informations sur les catégories d’erreurs, consultez 'énumération ErrorCategory.

Type:ErrorCategory
Valeurs acceptées: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
Valeur par défaut:NotSpecified
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CategoryActivity

Spécifie l’action qui a provoqué l’erreur.

Type:String
Alias:Activity
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CategoryReason

Spécifie comment ou pourquoi l’activité a provoqué l’erreur.

Type:String
Alias:Reason
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CategoryTargetName

Spécifie le nom de l’objet en cours de traitement lorsque l’erreur s’est produite.

Type:String
Alias:TargetName
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CategoryTargetType

Spécifie le type de l’objet en cours de traitement lorsque l’erreur s’est produite.

Type:String
Alias:TargetType
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ErrorId

Spécifie une chaîne d’ID pour identifier l’erreur. La chaîne doit être unique à l’erreur.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ErrorRecord

Spécifie un objet d’enregistrement d’erreur qui représente l’erreur. Utilisez les propriétés de l’objet pour décrire l’erreur.

Pour créer un objet d’enregistrement d’erreur, utilisez l’applet de commande New-Object ou obtenez un objet d’enregistrement d’erreur à partir du tableau dans la variable automatique $Error.

Type:ErrorRecord
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Exception

Spécifie un objet d’exception qui représente l’erreur. Utilisez les propriétés de l’objet pour décrire l’erreur.

Pour créer un objet d’exception, utilisez une table de hachage ou utilisez l’applet de commande New-Object.

Type:Exception
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Message

Spécifie le texte du message de l’erreur. Si le texte inclut des espaces ou des caractères spéciaux, placez-le entre guillemets. Vous pouvez également diriger une chaîne de message vers Write-Error.

Type:String
Alias:Msg
Position:0
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-RecommendedAction

Spécifie l’action que l’utilisateur doit entreprendre pour résoudre ou empêcher l’erreur.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-TargetObject

Spécifie l’objet en cours de traitement lorsque l’erreur s’est produite. Entrez l’objet, une variable qui contient l’objet ou une commande qui obtient l’objet.

Type:Object
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

String

Vous pouvez diriger une chaîne contenant un message d’erreur vers cette applet de commande.

Sorties

None

Cette applet de commande ne retourne aucune sortie. Il écrit uniquement dans le flux de messages d’erreur.

Notes

Write-Error ne modifie pas la valeur de la variable automatique $?, par conséquent, elle ne signale pas de condition d’erreur de fin. Pour signaler une erreur de fin, utilisez la méthode $PSCmdlet.WriteError().