SqlError Class

Definition

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Package:

System.Data.SqlClient v4.9.0

Source:

System.Data.SqlClient.notsupported.cs

Caution

Use the Microsoft.Data.SqlClient package instead.

Collects information relevant to a warning or error returned by SQL Server.

public ref class SqlError sealed

[System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")]
public sealed class SqlError

[<System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")>]
type SqlError = class

Public NotInheritable Class SqlError

Inheritance

Object

SqlError

Attributes

ObsoleteAttribute

Examples

The following example displays each SqlError within the SqlErrorCollection collection.

public static void ShowSqlException(string connectionString)
{
    string queryString = "EXECUTE NonExistantStoredProcedure";

    using (SqlConnection connection = new SqlConnection(connectionString))
    {
        SqlCommand command = new SqlCommand(queryString, connection);
        try
        {
            command.Connection.Open();
            command.ExecuteNonQuery();
        }
        catch (SqlException ex)
        {
            DisplaySqlErrors(ex);
        }
    }
}

private static void DisplaySqlErrors(SqlException exception)
{
    for (int i = 0; i < exception.Errors.Count; i++)
    {
        Console.WriteLine("Index #" + i + "\n" +
            "Error: " + exception.Errors[i].ToString() + "\n");
    }
    Console.ReadLine();
}

Public Sub ShowSqlException(ByVal connectionString As String)
    Dim queryString As String = "EXECUTE NonExistantStoredProcedure"

    Using connection As New SqlConnection(connectionString)
        Dim command As New SqlCommand(queryString, connection)

        Try
            command.Connection.Open()
            command.ExecuteNonQuery()

        Catch ex As SqlException
            DisplaySqlErrors(ex)
        End Try
    End Using
End Sub

Private Sub DisplaySqlErrors(ByVal exception As SqlException)
    Dim i As Integer

    For i = 0 To exception.Errors.Count - 1
        Console.WriteLine("Index #" & i & ControlChars.NewLine & _
            "Error: " & exception.Errors(i).ToString() & ControlChars.NewLine)
    Next i
    Console.ReadLine()
End Sub

Remarks

This class is created by the .NET Framework Data Provider for SQL Server when an error occurs. An instance of SqlError is created and managed by the SqlErrorCollection, which in turn is created by the SqlException class.

Messages with a severity level of 10 or less are informational and indicate problems caused by mistakes in information that a user has entered. Severity levels from 11 through 16 are generated by the user, and can be corrected by the user. Severity levels from 17 through 25 indicate software or hardware errors. When a level 17, 18, or 19 error occurs, you can continue working, although you might not be able to execute a particular statement.

The SqlConnection remains open when the severity level is 19 or less. When the severity level is 20 or greater, the server usually closes the SqlConnection. However, the user can reopen the connection and continue. In both cases, a SqlException is generated by the method executing the command.

For more information about errors generated by SQL Server, see Database Engine Errors. For more information about severity levels, see Database Engine Error Severities.

Properties

Class	Gets the severity level of the error returned from SQL Server.
LineNumber	Gets the line number within the Transact-SQL command batch or stored procedure that contains the error.
Message	Gets the text describing the error.
Number	Gets a number that identifies the type of error.
Procedure	Gets the name of the stored procedure or remote procedure call (RPC) that generated the error.
Server	Gets the name of the instance of SQL Server that generated the error.
Source	Gets the name of the provider that generated the error.
State	Gets the unique state code for the error.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Gets the complete text of the error message.

See also

• SqlErrorCollection
• SqlException
• ADO.NET Overview