AccessConnectionProvider.GetConnectionString(String, String, String) Method

Returns a connection string to the specified Microsoft Access database using the specified 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 database,
    string userId,
    string password
)

VB.NET

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

Parameters

Name	Type	Description
database	String	A string that specifies the path and name of the database to connect to.
userId	String	A string that specifies the user’s name. This is used to initialize the “User ID” field of the connection string.
password	String	A string that specifies the password. This is used to initialize the “Password” field of the connection string.

Returns

Type	Description
String	A connection string.

Remarks

The connection string returned by this method can be used to initialize a Session’s connection string (for instance, via the Session.ConnectionString or XpoDefault.ConnectionString property).

The database parameter specifies the name of the database. If the full path is omitted it is assumed that the database resides in the same folder as the application’s executable file.

This method sets the connection string’s “User ID” and “Password” fields to the specified values.

To open Microsoft Access 2007 databases, use the AccessConnectionProvider.GetConnectionStringACE method.

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 Microsoft Access database. The AccessConnectionProvider.GetConnectionString method is called to construct a connection string to the database. It’s then assigned to the XpoDefault.ConnectionString property.

When a connection is about to be established to a database, a session object obtains the connection string from the XpoDefault.ConnectionString property (unless another connection string is supplied directly to the session). This is then used to connect to the database.

C#

using DevExpress.Xpo;
using DevExpress.Xpo.DB;

XpoDefault.ConnectionString = AccessConnectionProvider.GetConnectionString(
    @"c:\Data\nwind.mdb");

VB.NET

Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB

XpoDefault.ConnectionString = AccessConnectionProvider.GetConnectionString( _
    "c:\Data\nwind.mdb")