State Property (SqlConnection)

In This Topic

Gets the current state of the connection.

Syntax

Visual Basic
C#

'Declaration
 
Public Shadows Property State As ConnectionState

public new ConnectionState State {get; set;}

Property Value

A bitwise combination of the System.Data.ConnectionState values. The default value is Closed.

Remarks

The allowed state changes are:

From Closed to Open, using the Open method of the SqlConnection object.
From Open to Closed, using either the Close method or the System.ComponentModel.Component.Dispose() method of the SqlConnection object.

Example

The following example creates an instance of a derived class, SqlConnection, sets its ConnectionString, and displays its State.

csharp

public void CreateSqlConnection()
{
  SqlConnection myConnection = new SqlConnection();
  myConnection.ConnectionString = 
      "User Id=sa;Server=localhost;Initial Catalog=Test;";
  myConnection.Open();
  MessageBox.Show("Connection State: " + myConnection.State.ToString());
  myConnection.Close();
}

Visual Basic

Public Sub CreateSqlConnection()
  Dim myConnection As New SqlConnection()
  myConnection.ConnectionString = _
      "User Id=sa;Server=localhost;Initial Catalog=Test;"
  myConnection.Open()
  MessageBox.Show("Connection State: " + myConnection.State.ToString())
  myConnection.Close()
End Sub

Requirements

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

Reference

SqlConnection Class
SqlConnection Members
ConnectionString Property

Send Feedback