Connecting from Code
The CData ADO.NET Provider for ShipStation implements a standard DbConnection object in ShipStationConnection. You can also use the ShipStationConnectionStringBuilder to programmatically build, parse, and rebuild connection strings.
Creating Connection Objects
See Establishing a Connection for guides to defining the connection string and authenticating. Below is a typical invocation to create ShipStationConnection objects.
C#
using (ShipStationConnection connection =
new ShipStationConnection("APIKey='YourAPIKey';APISecret='YourAPISecret'"))
{
connection.Open();
}
VB.NET
Using connection As New ShipStationConnection("APIKey='YourAPIKey';APISecret='YourAPISecret'")
connection.Open
End Using
Using ShipStationConnectionStringBuilder
The following code example shows how to use an ADO.NET connection string builder to parse a connection string.
C#
ShipStationConnectionStringBuilder builder =
new ShipStationConnectionStringBuilder("APIKey='YourAPIKey';APISecret='YourAPISecret'");
//Pass the connection string builder an existing connection string, and you can get and set any of the elements as strongly typed properties.
builder.ConnectionString = "APIKey='YourAPIKey';APISecret='YourAPISecret'";
//Now that the connection string has been parsed,
// you can work with individual items:
builder.MyString = "new property";
builder.MyBoolean = true;
// You can refer to connection keys using strings,
// as well.
builder["Logfile"] = "test.log";
builder["Verbosity"] = 5;
VB.NET
Dim builder As ShipStationConnectionStringBuilder = New ShipStationConnectionStringBuilder("APIKey='YourAPIKey';APISecret='YourAPISecret'")
'Pass the connection string builder an existing connection string, and you can get and set any of the elements using strongly typed properties.
builder.ConnectionString = APIKey='YourAPIKey';APISecret='YourAPISecret'"
'Now that the connection string has been parsed,
' you can work with individual items:
builder.MyString = "new property"
builder.MyBoolean = True
' You can refer to connection keys using strings,
' as well.
builder("Logfile") = "test.log"
builder("Verbosity") = 5