XpoDefault.GetConnectionProvider(String, AutoCreateOption, out IDisposable[]) Method

Creates an instance of a connection provider using the specified settings.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v18.2.dll

Declaration

C#

public static IDataStore GetConnectionProvider(
    string connectionString,
    AutoCreateOption defaultAutoCreateOption,
    out IDisposable[] objectsToDisposeOnDisconnect
)

VB.NET

Public Shared Function GetConnectionProvider(
    connectionString As String,
    defaultAutoCreateOption As AutoCreateOption,
    ByRef objectsToDisposeOnDisconnect As IDisposable()
) As IDataStore

Parameters

Name	Type	Description
connectionString	String	The connection string which is used to instantiate a connection provider.
defaultAutoCreateOption	AutoCreateOption	A AutoCreateOption enumeration value that specifies the action which is performed when a session is connected to a data store.
objectsToDisposeOnDisconnect	IDisposable[]	An array of IDisposable objects that must be disposed on disconnect from the datasource.

Returns

Type	Description
IDataStore	The created connection provider.

Remarks

If the value passed to the connectionString parameter equals null (Nothing in VB), the XpoDefault.ActiveConnectionString is used to instantiate the connection provider.

Example

The following code snippet shows how to create an instance of the SimpleDataLayer without first creating the data layer cache. The data layer is instantiated using the XpoDefault.ActiveConnectionString.

C#

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

//...

SimpleDataLayer dataLayer = new SimpleDataLayer(
    XpoDefault.GetConnectionProvider(AutoCreateOption.DatabaseAndSchema));

VB.NET

Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB

'...

Dim dataLayer As New SimpleDataLayer( _
XpoDefault.GetConnectionProvider(AutoCreateOption.DatabaseAndSchema)) 

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetConnectionProvider(String, AutoCreateOption, out IDisposable[]) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XPO_tutorial-2-relations-one-to-many-e4557/CS/XpoTutorial2/MyDataModelCode/ConnectionHelper.cs#L23

public static DevExpress.Xpo.DB.IDataStore GetConnectionProvider(DevExpress.Xpo.DB.AutoCreateOption autoCreateOption, out IDisposable[] objectsToDisposeOnDisconnect) {
    return XpoDefault.GetConnectionProvider(ConnectionString, autoCreateOption, out objectsToDisposeOnDisconnect);
}

XPO_tutorial-3-querying-data-e4559/CS/XpoTutorial3/MyDataModelCode/ConnectionHelper.cs#L23

public static DevExpress.Xpo.DB.IDataStore GetConnectionProvider(DevExpress.Xpo.DB.AutoCreateOption autoCreateOption, out IDisposable[] objectsToDisposeOnDisconnect) {
    return XpoDefault.GetConnectionProvider(ConnectionString, autoCreateOption, out objectsToDisposeOnDisconnect);
}

Create-a-Report-Bound-To-XPObjectSource/CS/Create a Report Bound to XPObjectSource/ORMDataModel1Code/ConnectionHelper.cs#L44

public static DevExpress.Xpo.DB.IDataStore GetConnectionProvider(DevExpress.Xpo.DB.AutoCreateOption autoCreateOption, out IDisposable[] objectsToDisposeOnDisconnect) {
    return XpoDefault.GetConnectionProvider(ConnectionString, autoCreateOption, out objectsToDisposeOnDisconnect);
}

VB.NET

XPO_tutorial-2-relations-one-to-many-e4557/VB/XpoTutorial2/MyDataModelCode/ConnectionHelper.vb#L26

Public Shared Function GetConnectionProvider(ByVal autoCreateOption As DevExpress.Xpo.DB.AutoCreateOption, <System.Runtime.InteropServices.Out()> ByRef objectsToDisposeOnDisconnect() As IDisposable) As DevExpress.Xpo.DB.IDataStore
    Return XpoDefault.GetConnectionProvider(ConnectionString, autoCreateOption, objectsToDisposeOnDisconnect)
End Function

XPO_tutorial-3-querying-data-e4559/VB/XpoTutorial3/MyDataModelCode/ConnectionHelper.vb#L27

Public Shared Function GetConnectionProvider(ByVal autoCreateOption As DevExpress.Xpo.DB.AutoCreateOption, <System.Runtime.InteropServices.Out()> ByRef objectsToDisposeOnDisconnect() As IDisposable) As DevExpress.Xpo.DB.IDataStore
    Return XpoDefault.GetConnectionProvider(ConnectionString, autoCreateOption, objectsToDisposeOnDisconnect)
End Function

Create-a-Report-Bound-To-XPObjectSource/VB/Create a Report Bound to XPObjectSource/ORMDataModel1Code/ConnectionHelper.vb#L48

Public Shared Function GetConnectionProvider(ByVal autoCreateOption As DevExpress.Xpo.DB.AutoCreateOption, <System.Runtime.InteropServices.Out()> ByRef objectsToDisposeOnDisconnect() As IDisposable) As DevExpress.Xpo.DB.IDataStore
    Return XpoDefault.GetConnectionProvider(ConnectionString, autoCreateOption, objectsToDisposeOnDisconnect)
End Function