Conversion.ErrorToString Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Returns the error message that corresponds to a given error number.
Namespace: Microsoft.VisualBasic
Assembly: Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)
Syntax
'Declaration
Public Shared Function ErrorToString As String
public static string ErrorToString()
Return Value
Type: System.String
Returns the error message that corresponds to a given error number.
Remarks
The ErrorToString function examines the property settings of the Err object to identify the most recent run-time error. The return value of the ErrorToString function corresponds to the Description property of the Err object. If ErrorNumber is a valid error number but is not defined, ErrorToString returns the string "Application-defined or object-defined error." If ErrorNumber is not valid, an error occurs. If ErrorNumber is omitted, the message corresponding to the most recent run-time error is returned. If no run-time error has occurred or ErrorNumber is 0, ErrorToString returns a zero-length string ("").
In Visual Basic version 6.0 and earlier, this functionality was provided by the Error function.
Examples
The following code uses the ErrorToString function to display error messages that correspond to the specified error numbers.
Dim Msg = ""
Dim ErrorNumber As Integer
For ErrorNumber = 61 To 64 ' Loop through values 61 - 64.
Msg &= ErrorToString(ErrorNumber) & vbCrLf ' Display error names in message box.
Next ErrorNumber
Version Information
Silverlight
Supported in: 5, 4, 3
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.