Gestion des erreurs pour les applets de commande SharePoint Foundation

Dernière modification : jeudi 1 octobre 2009

S’applique à : SharePoint Foundation 2010

Vos applets de commande pour SharePoint Foundation doivent fournir une gestion des erreurs de base. Cela signifie que vous devez dresser la liste de toutes les conditions dans lesquelles une applet de commande peut générer une erreur et décrire le comportement attendu pour chaque condition. Vos applets de commande doivent nettoyer les modifications partielles en cas d’erreur et retourner un message d’erreur significatif, indiquant comment un administrateur système peut procéder à une récupération après une condition d’erreur. Vos applets de commande doivent être tout particulièrement capables de faire la distinction entre des erreurs irrécupérables et des erreurs récupérables. Une erreur irrécupérable est une erreur qui empêche Windows PowerShell de traiter une commande. Elle interrompt l’exécution d’un pipeline Windows PowerShell. Un erreur récupérable permet à Windows PowerShell de continuer à opérer sur l’objet d’entrée actuel ou sur les objets du pipeline entrants. De plus, elle offre une possibilité de récupération du système.

Gestions des erreurs des applets de commande pour SharePoint

Les applets de commande doivent être suffisamment résistantes pour gérer des valeurs de propriété non valides. En cas d’erreur irrécupérable, une applet de commande Get doit générer une erreur irrécupérable (si elle ne peut pas se connecter à la base de données spécifiée, par exemple), traiter un objet ayant des propriétés non valides comme une erreur récupérable et écrire l’objet dans le pipeline de sortie.

Les applets de commande doivent signaler toutes les erreurs récupérables à l’aide de la méthode WriteError(Exception, ErrorCategory, Object). Pour les erreurs irrécupérables, elles doivent en revanche générer une exception localisée.

Les erreurs récupérables et irrécupérables doivent utiliser des chaînes d’erreur localisées et les paramètres régionaux du thread lors du signalement des erreurs à l’aide de la méthode WriteError(Exception, ErrorCategory, Object).

Notes

N’utilisez pas directement les API de rapport d’erreurs Windows PowerShell. Ayez plutôt recours aux API SharePoint Foundation pour Windows PowerShell qui se trouvent dans l’espace de noms Microsoft.SharePoint.PowerShell. Vous assurez ainsi la compatibilité entre les applets de commande qui opèrent dans les déploiements de SharePoint. Les API SharePoint implémentent les fonctionnalités des API Windows PowerShell natives et exécutent des tâches supplémentaires, comme écrire les données d’échec dans les fichiers journaux.

Voir aussi

Concepts

Directives de développement pour les applets de commande SharePoint Foundation

Concepts clés pour l’écriture d’applets de commande pour SharePoint Management Shell