Share via


DataConnectionSupport.Open Method

Opens the specified connection.

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

Syntax

'Declaration
Public MustOverride Function Open ( _
    doPromptCheck As Boolean _
) As Boolean
public abstract bool Open(
    bool doPromptCheck
)
public:
virtual bool Open(
    bool doPromptCheck
) abstract
abstract Open : 
        doPromptCheck:bool -> bool
public abstract function Open(
    doPromptCheck : boolean
) : boolean

Parameters

  • doPromptCheck
    Type: System.Boolean

    Indicates whether the call to the Open method should return false for specific errors that relate to missing connection information, as opposed to simply throwing an error in all cases of failure. Data providers that do not implement a prompt dialog (or have their own prompting mechanism) should ignore this parameter, and always assume a value of false.

Return Value

Type: System.Boolean
Returns true if the connection was opened successfully and does not require a prompt.
Returns false if the connection is missing required connection information and a prompt should be displayed to obtain the missing information from the user. You should return this value only when a data provider has also implemented the DataConnectionPromptDialog class.

Remarks

Any exceptions that occur indicate a provider-specific error occurred when opening the connection.

.NET Framework Security

See Also

Reference

DataConnectionSupport Class

Microsoft.VisualStudio.Data Namespace