Open Method (SugarConnection)

In This Topic

Syntax
Remarks
Example
Requirements
See Also

Opens a SugarCRM connection with the property settings specified by the ConnectionString.

Syntax

Visual Basic
C#

public override void Open()

'Declaration
 
Public Overrides Sub Open()

Remarks

The SugarConnection draws an open connection from the connection pool if one is available. Otherwise, it establishes a new connection to the data source.

Note: If the SugarConnection goes out of scope, the connection it represents does not close automatically. Therefore, you must explicitly close the connection by calling Close.

Opening an open connection does nothing.

Example

The following example creates a SugarConnection, opens it, displays some of its properties, and then closes the connection.

csharp

public void CreateSugarConnection(string myConnString)
{
  SugarConnection sugarConnection = new SugarConnection(myConnString);
  sugarConnection.Open();
  MessageBox.Show("ServerVersion: " + sugarConnection.ServerVersion
    + "\nState: " + sugarConnection.State.ToString());
  sugarConnection.Close();
}

Visual Basic

Public Sub CreateSugarConnection(myConnString As String)
  Dim sugarConnection As New SugarConnection(myConnString)
  sugarConnection.Open()
  MessageBox.Show("ServerVersion: " + sugarConnection.ServerVersion _
    + ControlChars.Cr + "State: " + sugarConnection.State.ToString())
  sugarConnection.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

SugarConnection Class
SugarConnection Members
Close Method

Send Feedback