SqlErrorCollection 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 all errors generated by the .NET Framework Data Provider for SQL Server. This class cannot be inherited.

public ref class SqlErrorCollection sealed : System::Collections::ICollection

[System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")]
public sealed class SqlErrorCollection : System.Collections.ICollection

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

Public NotInheritable Class SqlErrorCollection
Implements ICollection

Inheritance

Object

SqlErrorCollection

Attributes

ObsoleteAttribute

Implements

ICollection IEnumerable

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 SqlException to collect instances of the SqlError class. SqlErrorCollection always contains at least one instance of the SqlError class.

Properties

Count	Gets the number of errors in the collection.
Item[Int32]	Gets the error at the specified index.

Methods

CopyTo(Array, Int32)	Copies the elements of the SqlErrorCollection collection into an Array, starting at the specified index.
CopyTo(SqlError[], Int32)	Copies the elements of the SqlErrorCollection collection into a SqlErrorCollection, starting at the specified index.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	Returns an enumerator that iterates through the SqlErrorCollection.
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()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

ICollection.IsSynchronized	For a description of this member, see IsSynchronized.
ICollection.SyncRoot	For a description of this member, see SyncRoot.

Extension Methods

See also

• SqlError
• SqlException
• ADO.NET Overview