SqlConnection.Credential Property

  • Reference

Definition

Namespace:
Microsoft.Data.SqlClient
Assembly:
Microsoft.Data.SqlClient.dll
Package:
Microsoft.Data.SqlClient v1.0.19269.1
Package:
Microsoft.Data.SqlClient v1.1.4
Package:
Microsoft.Data.SqlClient v2.0.1
Package:
Microsoft.Data.SqlClient v2.1.4
Package:
Microsoft.Data.SqlClient v3.0.1
Package:
Microsoft.Data.SqlClient v3.1.0
Package:
Microsoft.Data.SqlClient v4.0.1
Package:
Microsoft.Data.SqlClient v4.1.0
Package:
Microsoft.Data.SqlClient v5.0.0
Package:
Microsoft.Data.SqlClient v5.1.0
Package:
Microsoft.Data.SqlClient v5.2.0

Gets or sets the SqlCredential object for this connection.

public:
 property Microsoft::Data::SqlClient::SqlCredential ^ Credential { Microsoft::Data::SqlClient::SqlCredential ^ get(); void set(Microsoft::Data::SqlClient::SqlCredential ^ value); };
[System.ComponentModel.Browsable(false)]
public Microsoft.Data.SqlClient.SqlCredential Credential { get; set; }
public Microsoft.Data.SqlClient.SqlCredential Credential { get; set; }
[<System.ComponentModel.Browsable(false)>]
member this.Credential : Microsoft.Data.SqlClient.SqlCredential with get, set
member this.Credential : Microsoft.Data.SqlClient.SqlCredential with get, set
Public Property Credential As SqlCredential

Property Value

SqlCredential

The SqlCredential object for this connection.

Attributes
BrowsableAttribute

Remarks

Persist Security Info = true is required to get the value of the SqlCredential object with Credential.

The default value of Credential is null.

An InvalidOperationException exception will be raised:

  • If Credential is set on an open connection.

  • If Credential is set when Integrated Security = true.

  • If Credential is set when the connection string uses Password.

  • If Credential is set when the connection string uses UserID.

Applies to