Name
Err.Raise Method
Syntax
Err
.Raisenumber
,[source]
, [description]
, _ [[helpfile]
,helpcontext]
-
number
Use: Required
Data Subtype: Long integer
A numeric identifier of the particular error.
-
source
Use: Optional
Data Subtype: String
The name of the object or application responsible for generating the error.
-
description
Use: Optional
Data Subtype: String
A useful description of the error.
-
helpfile
Use: Optional
Data Subtype: String
The fully qualified path of a Microsoft Windows Help or HTML Help file containing help or reference material about the error.
-
helpcontext
Use: Optional
Data Subtype: Long
The context ID within
helpfile
.
Description
Generates a runtime error.
Rules at a Glance
To use the Raise method, you must specify an error number.
If you supply any of the
number
,source
,description
,helpfile
, andhelpcontext
arguments when you call the Err.Raise method, they are supplied as values to the Err object’s Number, Source, Description, HelpFile, and HelpContext properties, respectively. Refer to the entries for the individual properties for full descriptions of and rules for each property.
Programming Tips & Gotchas
The Raise method doesn’t reinitialize the Err object prior to assigning the values you pass in as arguments. This can mean that if you Raise an error against an Err object that hasn’t been cleared since the last error, any properties you don’t specify values for still contain the values from the last error.
As well as using Raise in a runtime scenario, you can put it to good ...
Get VBScript in a Nutshell now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.