This documentation is archived and is not being maintained.

OdbcError Class

Collects information relevant to a warning or error returned by the data source.


Namespace:  System.Data.Odbc
Assembly:  System.Data (in System.Data.dll)

public sealed class OdbcError

The OdbcError type exposes the following members.

Public propertyMessageGets a short description of the error.
Public propertyNativeErrorGets the data source-specific error information.
Public propertySourceGets the name of the driver that generated the error.
Public propertySQLStateGets the five-character error code that follows the ANSI SQL standard for the database.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringGets the complete text of the error message. (Overrides Object.ToString().)

This class is created by the OdbcDataAdapter whenever an error occurs. Each instance of OdbcError created by the OdbcDataAdapter is then managed by the OdbcErrorCollection class, which in turn is created by the OdbcException class.

If the severity of the error is too great, the server may close the OdbcConnection. However, the user can reopen the connection and continue.

The following example displays the properties of the OdbcError class.

		public void DisplayOdbcErrorCollection(OdbcException exception)
			for (int i = 0; i < exception.Errors.Count; i++)
				Console.WriteLine("Index #" + i + "\n" +
					"Message: " + exception.Errors[i].Message + "\n" +
					"Native: " + exception.Errors[i].NativeError.ToString() + "\n" +
					"Source: " + exception.Errors[i].Source + "\n" +
					"SQL: " + exception.Errors[i].SQLState + "\n");

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.