SqlConnectionStringBuilder.UserInstance Property

Reference

Definition

Namespace:: System.Data.SqlClient

Assembly:: System.Data.SqlClient.dll

Assembly:: System.Data.dll

Package:: System.Data.SqlClient v4.9.0

Source:: System.Data.SqlClient.notsupported.cs

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.

Gets or sets a value that indicates whether to redirect the connection from the default SQL Server Express instance to a runtime-initiated instance running under the account of the caller.

public:
 property bool UserInstance { bool get(); void set(bool value); };

public bool UserInstance { get; set; }

member this.UserInstance : bool with get, set

Public Property UserInstance As Boolean

Property Value

Boolean

The value of the UserInstance property, or False if none has been supplied.

Exceptions

ArgumentNullException

To set the value to null, use Value.

Remarks

This property corresponds to the "User Instance" key within the connection string.

Note

This feature is available only with the SQL Server Express Edition. For more information on user instances, see SQL Server Express User Instances.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, 6 (package-provided), 7 (package-provided), 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0 (package-provided)

Share via