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

Creates a data store provider (an IDataStore instance).

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.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	A connection string.
defaultAutoCreateOption	AutoCreateOption	Specifies whether XPO can create a database or update its schema.
objectsToDisposeOnDisconnect	IDisposable[]	An array of IDisposable objects the data store provider creates internally.

Returns

Type	Description
IDataStore	A data store provider.

Remarks

If the application no longer needs a connection provider object, dispose each object on the objectsToDisposeonDisconnect array.

The GetConnectionProvider method uses the ActiveConnectionString property if the connectionString parameter value is null (Nothing in Visual Basic).

If the value passed to the connectionString parameter is a reference to Data Store Service (URL), the method returns a Data Store Service client.

The GetConnectionProvider method throws CannotFindAppropriateConnectionProviderException in the following situations:

A connection string does not contain the XpoProvider attribute and XPO cannot infer the provider name from other attributes.	To get a fully qualified connection string, use the GetConnectionString method of a corresponding connection provider.
A connection string references a Data Store Service and a target platform is .NET Core.	To connect a .NET Core project to a Data Store Service, create and configure DataStoreClientAsync or CachedDataStoreClient. For additional information, see WCF Client in .NET Core.

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#

winforms-reporting-create-report-bound-to-xpobjectsource/CS/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);
}

CriteriaOperatorsCheatSheet/CS/CriteriaOperatorCheatSheet/ConnectionHelper.cs#L51

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

VB.NET

winforms-reporting-create-report-bound-to-xpobjectsource/VB/ORMDataModel1Code/ConnectionHelper.vb#L44

Public 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