Connecting from Code
The CData ADO.NET Provider for Microsoft SharePoint implements a standard DbConnection object in SharePointConnection. You can also use the SharePointConnectionStringBuilder 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 SharePointConnection objects.
C#
using (SharePointConnection connection =
new SharePointConnection("User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;"))
{
connection.Open();
}
VB.NET
Using connection As New SharePointConnection("User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;")
connection.Open
End Using
Using SharePointConnectionStringBuilder
The following code example shows how to use an ADO.NET connection string builder to parse a connection string.
C#
SharePointConnectionStringBuilder builder =
new SharePointConnectionStringBuilder("User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;");
//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 = "User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;";
//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 SharePointConnectionStringBuilder = New SharePointConnectionStringBuilder("User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;")
'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 = User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;"
'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