SqlConnectionStringBuilder.IntegratedSecurity Property
Definition
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 Boolean value that indicates whether User ID and Password are specified in the connection (when false
) or whether the current Windows account credentials are used for authentication (when true
).
public:
property bool IntegratedSecurity { bool get(); void set(bool value); };
public bool IntegratedSecurity { get; set; }
member this.IntegratedSecurity : bool with get, set
Public Property IntegratedSecurity As Boolean
Property Value
The value of the IntegratedSecurity property, or false
if none has been supplied.
Examples
The following example converts an existing connection string from using SQL Server Authentication to using integrated security. The example does its work by removing the user name and password from the connection string and then setting the IntegratedSecurity property of the SqlConnectionStringBuilder object.
Note
This example includes a password to demonstrate how SqlConnectionStringBuilder works with connection strings. In your applications, we recommend that you use Windows Authentication. If you must use a password, do not include a hard-coded password in your application.
using System.Data.SqlClient;
class Program
{
static void Main()
{
try
{
string connectString =
"Data Source=(local);User ID=ab;Password=MyPassword;" +
"Initial Catalog=AdventureWorks";
SqlConnectionStringBuilder builder =
new SqlConnectionStringBuilder(connectString);
Console.WriteLine("Original: " + builder.ConnectionString);
// Use the Remove method
// in order to reset the user ID and password back to their
// default (empty string) values. Simply setting the
// associated property values to an empty string won't
// remove them from the connection string; you must
// call the Remove method.
builder.Remove("User ID");
builder.Remove("Password");
// Turn on integrated security:
builder.IntegratedSecurity = true;
Console.WriteLine("Modified: " + builder.ConnectionString);
using (SqlConnection connection =
new SqlConnection(builder.ConnectionString))
{
connection.Open();
// Now use the open connection.
Console.WriteLine("Database = " + connection.Database);
}
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
Console.WriteLine("Press any key to finish.");
Console.ReadLine();
}
}
Imports System.Data.SqlClient
Module Module1
Sub Main()
Try
Dim connectString As String = _
"Data Source=(local);User ID=ab;Password=MyPassword;" & _
"Initial Catalog=AdventureWorks"
Dim builder As New SqlConnectionStringBuilder(connectString)
Console.WriteLine("Original: " & builder.ConnectionString)
' Use the Remove method
' in order to reset the user ID and password back to their
' default (empty string) values. Simply setting the
' associated property values to an empty string won't
' remove them from the connection string; you must
' call the Remove method.
builder.Remove("User ID")
builder.Remove("Password")
' Turn on integrated security.
builder.IntegratedSecurity = True
Console.WriteLine("Modified: " & builder.ConnectionString)
Using connection As New SqlConnection(builder.ConnectionString)
connection.Open()
' Now use the open connection.
Console.WriteLine("Database = " & connection.Database)
End Using
Catch ex As Exception
Console.WriteLine(ex.Message)
End Try
Console.WriteLine("Press any key to finish.")
Console.ReadLine()
End Sub
End Module
Remarks
This property corresponds to the "Integrated Security" and "trusted_connection" keys within the connection string.