Conversion.ErrorToString Method (Int32)

 

Returns the error message that corresponds to a given error number.

Namespace:   Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public static string ErrorToString(
	int ErrorNumber
)

Parameters

ErrorNumber
Type: System.Int32

Optional. Any valid error number.

Return Value

Type: System.String

The error message that corresponds to a given error number.

Exception Condition
ArgumentException

ErrorNumber is out of range.

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.

The following code uses the ErrorToString function to display error messages that correspond to the specified error numbers.

Dim ErrorNumber As Integer
For ErrorNumber = 61 To 64   ' Loop through values 61 - 64.
    MsgBox(ErrorToString(ErrorNumber))   ' Display error names in message box.
Next ErrorNumber

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Return to top
Show: