Raise, méthode (objet Err)

Article
09/12/2008

Mise à jour : novembre 2007

Génère une erreur d'exécution ; peut être utilisée à la place de l'instruction Error.

Public Sub Raise( _
   ByVal Number As Integer, _
   Optional ByVal Source As Object = Nothing, _
   Optional ByVal Description As Object = Nothing, _
   Optional ByVal HelpFile As Object = Nothing, _
   Optional ByVal HelpContext As Object = Nothing _
)

Paramètres

Number
Requis. Entier Long qui identifie la nature de l'erreur. Les codes d'erreur Visual Basic doivent être compris entre 0 et 65 535 : les codes compris entre 0 et 512 sont réservés aux erreurs système ; ceux compris entre 513 et 65 535 peuvent être utilisés pour les erreurs définies par l'utilisateur. Lorsque vous définissez la propriété Number pour votre propre code d'erreur dans un module de classe, ajoutez le numéro de votre code d'erreur à la constante vbObjectError. Par exemple, pour générer le numéro d'erreur 513, assignez vbObjectError + 513 à la propriété Number.
Source
Facultatif. Expression String attribuant un nom à l'objet ou à l'application ayant généré l'erreur. Lorsque vous définissez cette propriété pour un objet, utilisez le formulaire classe.projet Si Source n'est pas spécifié, l'ID de processus du projet Visual Basic actuel est utilisé.
Description
Facultatif. Expression String décrivant l'erreur. Si aucune description n'est spécifiée, la valeur contenue dans la propriété Number est examinée. Si la description indiquée peut être mappée à un code d'erreur d'exécution Visual Basic, la chaîne retournée par la fonction Error est utilisée comme la propriété Description. En l'absence d'erreur Visual Basic correspondant à la propriété Number, le message "Erreur définie par l'application ou par l'objet" est utilisé.
HelpFile
Facultatif. Chemin d'accès complet au fichier contenant l'aide relative à cette erreur. Si aucun fichier d'aide n'est spécifié, Visual Basic utilise le lecteur, le chemin d'accès et le nom de fichier complets du fichier d'aide Visual Basic.
HelpContext
Facultatif. ID de contexte identifiant une rubrique contenue dans HelpFile qui fournit l'aide correspondant à l'erreur. S'il est omis, l'ID de contexte qui est utilisé est celui du fichier d'aide Visual Basic pour l'erreur correspondant à la propriété Number, s'il existe.

Exceptions

Type d'exception	Numéro de l'erreur	Condition
ArgumentException	5	Number est supérieur à 65 535.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion non structurée des erreurs. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreurs par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Tous les arguments Raise à l'exception de Number sont facultatifs. Si vous omettez les arguments facultatifs et si les paramètres de propriété de l'objet Err contiennent des valeurs qui n'ont pas été effacées, celles-ci servent de valeurs pour votre erreur.

Comme l'objet Err donne des informations plus riches que lorsque vous générez des erreurs avec l'instruction Error, Raise est utile pour générer des erreurs lors de l'écriture de modules de classe. Par exemple, avec la méthode Raise, la source ayant généré l'erreur peut être spécifiée dans la propriété Source, l'aide en ligne correspondant à l'erreur peut être référencée, etc.

Exemple

Cet exemple utilise la méthode Raise de l'objet Err pour générer une erreur à l'intérieur d'une fonction écrite en Visual Basic. La fonction appelante peut intercepter l'erreur et la signaler à l'utilisateur à l'aide d'un message.

Const WidthError As Integer = 1
Const WidthHelp As Object = 101

Sub TestWidth(ByVal width As Integer)
  If width > 1000 Then
      Err.Raise(vbObjectError + 512 + WidthError, "TestWidth", _
      "Width must be less than 1000.", "HelpFile.hlp", WidthHelp)
  End If
End Sub

Sub CallingProcedure()
  Try
    TestWidth(2000)
  Catch ex As Exception
    MsgBox(ex.Message)
  End Try
End Sub