SqlConnectionStringBuilder.UserInstance Property

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v5.2.0

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.