DataConnectionSupport.Open Method

Article
10/03/2012

Opens the specified data connection.

Namespace: Microsoft.VisualStudio.Data.Framework
Assembly: Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.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 this 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 box (or have their own prompting mechanism) should ignore this parameter and always assume a value of false.

Return Value

Type: System.Boolean
true if the connection opened successfully and does not require a prompt; 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 false only when a provider has implemented the IVsDataConnectionPromptDialog interface.

Implements

IVsDataConnectionSupport.Open(Boolean)

Remarks

Notes to Inheritors

The derived class should override this method.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via