Close Method

OdbcConnection.Close Method

Note: This namespace, class, or member is supported only in version 1.1 of the .NET Framework.

Closes the connection to the data source. This is the preferred method of closing any open connection.

[Visual Basic]
Public Overridable Sub Close() Implements IDbConnection.Close
[C#]
public virtual void Close();
[C++]
public: virtual void Close();
[JScript]
public function Close();

Implements

IDbConnection.Close

Remarks

The Close method rolls back any pending transactions. It then releases the connection to the connection pool, or closes the connection if connection pooling is disabled. If Close is called while handling a StateChange event, no additional StateChange events are fired.

An application can call Close more than one time without generating an exception.

Note   When you use the .NET Framework Data Provider for ODBC, you do not need to enable connection pooling because the ODBC Driver Manager manages this automatically. For more information about enabling and disabling connection pooling, see the Microsoft Open Database Connectivity (ODBC) documentation.
CAUTION   Do not call Close or Dispose on a Connection, a DataReader, or any other managed object in the Finalize method of your class. In a finalizer, you should only release unmanaged resources that your class owns directly. If your class does not own any unmanaged resources, do not include a Finalize method in your class definition. For more information, see Programming for Garbage Collection.

Example

[Visual Basic, C#, C++] The following example creates an OdbcConnection, opens it, displays some of its properties, then closes the connection.

[Visual Basic] 
Public Sub CreateOdbcConnection(myConnString As String)
    Dim myConnection As New OdbcConnection(myConnString)
    myConnection.Open()
    MessageBox.Show("ServerVersion: " + myConnection.ServerVersion _
       + ControlChars.Cr + "State: " + myConnection.State.ToString())
    myConnection.Close()
End Sub

[C#] 
public void CreateOdbcConnection(string myConnString) 
{
   OdbcConnection myConnection = new OdbcConnection(myConnString);
   myConnection.Open();
   MessageBox.Show("ServerVersion: " + myConnection.ServerVersion
      + "\nState: " + myConnection.State.ToString());
   myConnection.Close();
}

[C++] 
public:
    void CreateOdbcConnection(String* myConnString)
    {
        OdbcConnection* myConnection = new OdbcConnection(myConnString);
        myConnection->Open();
        MessageBox::Show(String::Concat(S"ServerVersion: ", myConnection->ServerVersion,
            S"\nState: ", __box(myConnection->State)->ToString()));
        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

OdbcConnection Class | OdbcConnection Members | System.Data.Odbc Namespace | Open

Show:
© 2016 Microsoft