Partager via


IVsDataConnection.GetLockedProviderObject Method (Int32)

Retrieves the underlying data provider after locking the current data connection.

Namespace:  Microsoft.VisualStudio.Data.Services
Assembly:  Microsoft.VisualStudio.Data.Services (in Microsoft.VisualStudio.Data.Services.dll)

Syntax

'Declaration
Function GetLockedProviderObject ( _
    lockTimeout As Integer _
) As Object
Object GetLockedProviderObject(
    int lockTimeout
)
Object^ GetLockedProviderObject(
    int lockTimeout
)
abstract GetLockedProviderObject : 
        lockTimeout:int -> Object
function GetLockedProviderObject(
    lockTimeout : int
) : Object

Parameters

  • lockTimeout
    Type: System.Int32

    The amount of time, in seconds, to wait for the data connection to lock before returning.

Return Value

Type: System.Object
The underlying data provider object for the current data connection, or nulla null reference (Nothing in Visual Basic) if the data connection could not be locked within the specified time-out period.

Remarks

A client can use this method when they are knowledgeable about the underlying data provider and want to make calls directly to its API, either for performance reasons or because there is functionality that DDEX does not natively support.

An example of a provider object would be an IDbConnection instance for an ADO.NET provider, or an XmlDocument for an XML file.

.NET Framework Security

See Also

Reference

IVsDataConnection Interface

GetLockedProviderObject Overload

Microsoft.VisualStudio.Data.Services Namespace