FormsAuthenticationConfiguration.Credentials Property

Definition

Gets the FormsAuthenticationCredentials collection of user names and passwords.

public:
 property System::Web::Configuration::FormsAuthenticationCredentials ^ Credentials { System::Web::Configuration::FormsAuthenticationCredentials ^ get(); };
[System.Configuration.ConfigurationProperty("credentials")]
public System.Web.Configuration.FormsAuthenticationCredentials Credentials { get; }
member this.Credentials : System.Web.Configuration.FormsAuthenticationCredentials
Public ReadOnly Property Credentials As FormsAuthenticationCredentials

Property Value

A FormsAuthenticationCredentials collection that contains the user names and passwords.

Attributes

Examples

The following code example shows how to access the Credentials property. Refer to the code example in the FormsAuthenticationConfiguration class topic to learn how to get the section.

// Get the current Credentials.
FormsAuthenticationCredentials currentCredentials = 
    formsAuthentication.Credentials;

StringBuilder credentials = new StringBuilder();
// Get all the credentials.
for (System.Int32 i = 0; i < currentCredentials.Users.Count; i++)
{
    credentials.Append("Name: " + 
        currentCredentials.Users[i].Name + 
        " Password: " + 
        currentCredentials.Users[i].Password);
    credentials.Append(Environment.NewLine);
}
' Get the current Credentials.
  Dim currentCredentials _
  As FormsAuthenticationCredentials = _
  formsAuthentication.Credentials

Dim credentials As New StringBuilder()
' Get all the credentials.
Dim i As System.Int32
For i = 0 To currentCredentials.Users.Count - 1
      credentials.Append(("Name: " + _
      currentCredentials.Users(i).Name + _
      " Password: " + _
      currentCredentials.Users(i).Password))
   credentials.Append(Environment.NewLine)
  Next i

Remarks

The Credentials property gets the user names and passwords to use during forms-based authentication.

Note

When security is required, you should use alternative ways of storing the user names and passwords; for example, in a database store. If you decide to use this collection, you should use the provided encryption facility.

Applies to