MSSqlConnectionProvider.GetConnectionString(String, Int32, String, String, String) Method

Returns a connection string used to open a specified Microsoft SQL database using provided login credentials.

Namespace: DevExpress.Xpo.DB

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public static string GetConnectionString(
    string server,
    int port,
    string userId,
    string password,
    string database
)

VB.NET

Public Shared Function GetConnectionString(
    server As String,
    port As Integer,
    userId As String,
    password As String,
    database As String
) As String

Parameters

Name	Type	Description
server	String	A string that specifies the SQL server’s name.
port	Int32	An integer that specifies the server’s port number.
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 connection string.

Remarks

You can use this method’s return value to initialize a Session’s connection string (for instance, via the Session.ConnectionString or XpoDefault.ConnectionString property).

Note

The GetConnectionString method’s return value 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.