DataConnectionSupport.Open(Boolean) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Data.Framework

Assembly:: Microsoft.VisualStudio.Data.Framework.dll

Package:: Microsoft.VisualStudio.Data.Framework v17.10.40170

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Opens the specified data connection.

public:
 abstract bool Open(bool doPromptCheck);

public abstract bool Open (bool doPromptCheck);

abstract member Open : bool -> bool

Public MustOverride Function Open (doPromptCheck As Boolean) As Boolean

Parameters

doPromptCheck: 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.

Returns

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

Open(Boolean)

Applies to

Share via