VBScript Reference Manual for InduSoft Web Studio

More documents

Recommendations

Info

VBScript Reference Manual InduSoft Web Studio Property HelpFile Function: Sets or returns a fully qualified path to a Help File Usage: Err.HelpFile [= contextID] Arguments contextID Optional. Fully qualified path to the Help file Remarks: If a Help file is specified in HelpFile, it is automatically called when the user clicks the Help button (or presses the F1 key) in the error message dialog box. If the HelpContext property contains a valid context ID for the specified file, that topic is automatically displayed. If no HelpFile is specified, the VBScript Help file is displayed. Example On Error Resume Next Err.Raise 11 ‘Divide by 0 error Err.HelpFile = “myHelpFile.hlp” Err.HelpContext = usercontextID If Err.Number 0 Then MsgBox “Press F1 for help” & vbCrLf & “Error: “ &Err.Description _ & Error.HelpFile & Err.HelpContext End If Property Number Function: Returns or sets a numeric value specifying an error. Number is the Err object's default property Usage: Err. Number [= errornumber] Arguments errornumber An integer representing a VBScript error number or an SCODE error value Remarks: When returning a user-defined error from an Automation object, set Err.Number by adding the number you selected as an error code to the constant vbObjectError. Example On Error Resume Next Err.Raise 11 ‘Divide by 0 error Err.HelpFile = “myHelpFile.hlp” Err.HelpContext = usercontextID If Err.Number 0 Then MsgBox “Press F1 for help” & vbCrLf & “Error: “ &Err.Description _ & Error.HelpFile & Err.HelpContext End If Property Source Function: Returns or sets the name of the object or application that originally generated the error. Usage: Err.Source [= stringexpression] Arguments stringexpression A string expression representing the application that generated the error Remarks: The Source property specifies a string expression that is usually the class name or programmatic ID of the object that caused the error. Use Source to provide your users with information when your code is unable to handle an error generated in an accessed object. For example, if you access Microsoft Excel and it generates a Division by zero error, Microsoft Excel sets Err.Number to its error code for that error and sets Source to Excel.Application. Note that if the error is generated in another object called by Microsoft Excel, Excel intercepts the error and sets Err.Number to its own code for Division by zero. However, it leaves the other Err object (including Source) as set by the object that generated the error. Source always contains the name of the object that originally generated the error — your code can try to handle the error according to the error documentation of the object you accessed. If your error handler fails, you can use the Err object information to describe the error to your user, using Source 200 InduSoft, Ltd.
InduSoft Web Studio VBScript Reference Manual and the other Err to inform the user which object originally caused the error, its description of the error, and so forth. When generating an error from code, Source is your application's programmatic ID. Example On Error Resume Next Err.Raise 8 ‘User defined error Err.Description = “Invalid input” Err.Source = “MyApplication” MsgBox “Error Type = “ &Err.Description & “ generated in “ & Err.Source Method Clear Function: Clears all property settings in the Err object Usage: Err.Clear Arguments: none Remarks: Use Clear to explicitly clear the Err object after an error has been handled. This is necessary, for example, when you use deferred error handling with On Error Resume Next. VBScript calls the Clear method automatically whenever any of the following statements is executed: • On Error Resume Next • Exit Sub • Exit Function Method Raise Function: Generates a run-time error Usage: Err.Raise(number, source, description, helpfile, helpcontext) Arguments: number A Long integer subtype that identifies the nature of the error. VBScript errors (both VBScript-defined and user-defined errors) are in the range 0–65535. source A string expression naming the object or application that originally generated the error. When setting this property for an Automation object, use the form project.class. If nothing is specified, the programmatic ID of the current VBScript project is used. description A string expression describing the error. If unspecified, the value in number is examined. If it can be mapped to a VBScript run-time error code, a string provided by VBScript is used as description. If there is no VBScript error corresponding to number, a generic error message is used. helpfile The fully qualified path to the Help file in which help on this error can be found. If unspecified, VBScript uses the fully qualified drive, path, and file name of the VBScript Help file. helpcontext The context ID identifying a topic within helpfile that provides help for the error. If omitted, the VBScript Help file context ID for the error corresponding to the number property is used, if it exists. Remarks: All the arguments are optional except number. If you use Raise, however, without specifying some arguments, and the property settings of the Err object contain values that have not been cleared, those values become the values for your error. When setting the number property to your own error code in an Automation object, you add your error code number to the constant vbObjectError. For example, to generate the error number 1050, assign vbObjectError + 1050 to the number property. Example On Error Resume Next Dim Msg InduSoft, Ltd. 201
Page 1 and 2:
VBScript Reference Manual for InduS
Page 3 and 4:
InduSoft Web Studio VBScript Refere
Page 5 and 6:
Page 7 and 8:
Page 9 and 10:
Page 11 and 12:
Page 13 and 14:
Page 15 and 16:
Page 17 and 18:
Page 19 and 20:
Page 21 and 22:
Page 23 and 24:
Page 25 and 26:
Page 27 and 28:
Page 29 and 30:
Page 31 and 32:
Page 33 and 34:
Page 35 and 36:
Page 37 and 38:
Page 39 and 40:
Page 41:
Page 44 and 45:
VBScript Reference Manual InduSoft
Page 46 and 47:
Page 48 and 49:
Page 50 and 51:
Page 52 and 53:
Page 54 and 55:
Page 56 and 57:
Page 58 and 59:
Page 60 and 61:
Page 62 and 63:
Page 64 and 65:
Page 66 and 67:
Page 68 and 69:
Page 70 and 71:
Page 72 and 73:
Page 74 and 75:
Page 76 and 77:
Page 78 and 79:
Page 80 and 81:
Page 82 and 83:
Page 84 and 85:
Page 86 and 87:
Page 88 and 89:
Page 90 and 91:
Page 92 and 93:
Page 94 and 95:
Page 96 and 97:
Page 98 and 99:
Page 100 and 101:
Page 102 and 103:
Page 104 and 105:
Page 106 and 107:
Page 108 and 109:
Page 110 and 111:
Page 112 and 113:
Page 114 and 115:
Page 116 and 117:
Page 118 and 119:
Page 120:
Page 123 and 124:
Page 125 and 126:
Page 127 and 128:
Page 129 and 130:
Page 131 and 132:
Page 133 and 134:
Page 135 and 136:
Page 137 and 138:
Page 139 and 140:
Page 141 and 142:
Page 143 and 144:
Page 145 and 146:
Page 147 and 148:
Page 149 and 150: InduSoft Web Studio VBScript Refere
Page 199: InduSoft Web Studio VBScript Refere
Page 251 and 252:
Page 253 and 254:
Page 255:
show all

VBScript Reference Manual for InduSoft Web Studio

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?