State Property (SalesforceConnection)

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 SalesforceConnection object.
From Open to Closed, using either the Close method or the System.ComponentModel.Component.Dispose() method of the SalesforceConnection object.

Example

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

csharp

public void CreateSalesforceConnection()
{
  SalesforceConnection salesforceConnection = new SalesforceConnection();
  salesforceConnection.ConnectionString = 
      "Server=login.salesforce.com;User Id= [email protected];Password=mypassword;Security Token=qweASDzcx1234567890rtyui;";
  salesforceConnection.Open();
  MessageBox.Show("Connection State: " + salesforceConnection.State.ToString());
  salesforceConnection.Close();
}

Visual Basic

Public Sub CreateSalesforceConnection()
  Dim salesforceConnection As New SalesforceConnection()
  salesforceConnection.ConnectionString = _
      "Server=login.salesforce.com;User Id= [email protected];Password=mypassword;Security Token=qweASDzcx1234567890rtyui;"
  salesforceConnection.Open()
  MessageBox.Show("Connection State: " + salesforceConnection.State.ToString())
  salesforceConnection.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

SalesforceConnection Class
SalesforceConnection Members
ConnectionString Property

Send Feedback