MSSqlConnectionProvider.GetConnectionString(String, String, String, String) Method
Returns a connection string used to open a specified MS SQL database using provided login credentials.
Namespace: DevExpress.Xpo.DB
Assembly: DevExpress.Xpo.v18.2.dll
Declaration
public static string GetConnectionString(
string server,
string userId,
string password,
string database
)
Parameters
Name | Type | Description |
---|---|---|
server | String | A string that specifies the SQL server’s name. |
userId | String | A string that specifies a user name. |
password | String | A string that specifies a password. |
database | String | A string that specifies the database name. |
Returns
Type | Description |
---|---|
String | A string that specifies the connection string. |
Remarks
The value returned by this method can be used to initialize a Session’s connection string (for instance, via the Session.ConnectionString or XpoDefault.ConnectionString property).
Note
The string returned by the GetConnectionString method contains an extra parameter that identifies the database type to which a connection should be established, so it’s not fully compatible with the standard connection string format. When a Session receives this connection string, it removes this extra parameter and then passes the valid connection string to the database.
Example
The following code demonstrates how to connect to an MS SQL database. The MSSqlConnectionProvider.GetConnectionString method is called to construct a connection string to the database. It is then assigned to the default session via the Session.ConnectionString property.
using DevExpress.Xpo;
using DevExpress.Xpo.DB;
Session.DefaultSession.ConnectionString = MSSqlConnectionProvider.GetConnectionString(
"SERVER", "sa", "", "Northwind");