BigcommerceConnection Constructor(String)

In This Topic

Syntax
Remarks
Example
Requirements
See Also

Initializes a new instance of the BigcommerceConnection class when given a string containing the connection string.

Syntax

Visual Basic
C#

public BigcommerceConnection( 
   string connectionString
)

'Declaration
 
Public Function New( _
   ByVal connectionString As String _
)

Parameters

connectionString: The connection used to connect to BigCommerce.

Remarks

When a new instance of BigcommerceConnection is created, the read/write properties are set to the following initial values unless they are specifically set using their associated keywords in the ConnectionString property.

Example

The following example creates and opens a BigcommerceConnection.

csharp

public void CreateBigcommerceConnection()
{
  string myConnString = 
      "Server=https://bigcommerce-store.mybigcommerce.com/api/v2/;User Id=User;Authentication Token=qweASDzcx1234567890rtyuiqweASDzcx1234567;";
  BigcommerceConnection bigcommerceConnection = new BigcommerceConnection(myConnString);
  bigcommerceConnection.Open();
  //Do something
  bigcommerceConnection.Close();
}

Visual Basic

Public Sub CreateBigcommerceConnection()
  Dim myConnString As String = _
      "Server=https://bigcommerce-store.mybigcommerce.com/api/v2/;User Id=User;Authentication Token=qweASDzcx1234567890rtyuiqweASDzcx1234567;"
  Dim bigcommerceConnection As New BigcommerceConnection(myConnString)
  bigcommerceConnection.Open()
  'Do something
  bigcommerceConnection.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

BigcommerceConnection Class
BigcommerceConnection Members
Overload List
ConnectionString Property

Send Feedback