Connecting from Code
The CData ADO.NET Provider for SuiteCRM implements a standard DbConnection object in SuiteCRMConnection. You can also use the SuiteCRMConnectionStringBuilder 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 SuiteCRMConnection objects.
C#
using (SuiteCRMConnection connection =
new SuiteCRMConnection("URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;"))
{
connection.Open();
}
VB.NET
Using connection As New SuiteCRMConnection("URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;")
connection.Open
End Using
Using SuiteCRMConnectionStringBuilder
The following code example shows how to use an ADO.NET connection string builder to parse a connection string.
C#
SuiteCRMConnectionStringBuilder builder =
new SuiteCRMConnectionStringBuilder("URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;");
//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 = "URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;";
//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 SuiteCRMConnectionStringBuilder = New SuiteCRMConnectionStringBuilder("URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;")
'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 = URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;"
'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