This documentation is archived and is not being maintained.

OleDbConnection.State Property

Gets the current state of the connection.

[Visual Basic]
Public Overridable ReadOnly Property State As ConnectionState  _
   Implements IDbConnection.State
[C#]
public virtual ConnectionState State {get;}
[C++]
public: __property virtual ConnectionState get_State();
[JScript]
public function get State() : ConnectionState;

Property Value

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

Implements

IDbConnection.State

Remarks

The allowed state changes are:

  • From Closed to Open, using the Open method of the connection object.
  • From Open to Closed, using either the Close method or the Dispose method of the connection object.
Note   Calling the State property increases application overhead because each call results in a call to the OLE DB DBPROP_CONNECTIONSTATUS property for an open connection.

Example

[Visual Basic, C#, C++] The following example creates an instance of a derived class, OleDbConnection, sets its ConnectionString, and displays its State.

[Visual Basic] 
Public Sub createOleDbConnection()
    Dim myConnection As New OleDbConnection()
    myConnection.ConnectionString = _
       "Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=Northwind;Integrated Security=SSPI;"
    myConnection.Open()
    MessageBox.Show("Connection State: " + myConnection.State)
    myConnection.Close()
End Sub

[C#] 
public void createOleDbConnection()
{
   OleDbConnection myConnection = new OleDbConnection();
   myConnection.ConnectionString = "Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=Northwind;Integrated Security=SSPI;";
   myConnection.Open();
   MessageBox.Show("Connection State: " + myConnection.State);
   myConnection.Close();
}

[C++] 
public:
 void createOleDbConnection()
 {
    OleDbConnection* myConnection = new OleDbConnection();
    myConnection->ConnectionString = S"Provider=SQLOLEDB;Data Source=localhost;Initial Catalog=Northwind;Integrated Security=SSPI;";
    myConnection->Open();
    MessageBox::Show(String::Format( S"Connection State: {0}", __box(myConnection->State)));
    myConnection->Close();
 }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

OleDbConnection Class | OleDbConnection Members | System.Data.OleDb Namespace

Show: