SqlException.ToString Method ()

.NET Framework (current version)

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns a string that represents the current SqlException object, and includes the client connection ID (for more information, see ClientConnectionId).

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

public override string ToString()

Return Value

Type: System.String

A string that represents the current SqlException object.String.

The following C# example shows how a connection attempt to a valid server but non-existent database causes a SqlException, which includes the client connection ID:

using System.Data.SqlClient;
using System;

public class A {
   public static void Main() {
      SqlConnection connection = new SqlConnection();
      connection.ConnectionString = "Data Source=a_valid_server;Initial Catalog=Northwinda;Integrated Security=true";
      try {
      catch (SqlException p) {
         Console.WriteLine("{0}", p.ClientConnectionId);
         Console.WriteLine("{0}", p.ToString());

The following Visual Basic sample is functionally equivalent to the previous (C#) sample:

Imports System.Data.SqlClient
Imports System

Module Module1

    Sub Main()
        Dim connection As New SqlConnection()
        connection.ConnectionString = "Data Source=a_valid_server;Initial Catalog=Northwinda;Integrated Security=true"
        Catch p As SqlException
            Console.WriteLine("{0}", p.ClientConnectionId)
            Console.WriteLine("{0}", p.ToString())
        End Try
    End Sub

End Module

.NET Framework
Available since 4.5
Return to top