SqlMembershipProvider.EnablePasswordRetrieval Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a value indicating whether the SQL Server membership provider is configured to allow users to retrieve their passwords.

Namespace:   System.Web.Security
Assembly:  System.Web (in System.Web.dll)

public override bool EnablePasswordRetrieval { get; }

Property Value

Type: System.Boolean

true if the membership provider supports password retrieval; otherwise, false. The default is false.

If the PasswordFormat property is set to Hashed, a user will not be able to retrieve his or her existing password from the database. The Hashed password format provides one-way encoding of password values. Passwords are hashed with a randomly generated salt value and compared to values stored in the database for authentication. Hashed values cannot be unencoded to retrieve the original password value.

If the PasswordFormat property is set to Hashed, and EnablePasswordRetrieval is set to true, a ProviderException is thrown when the provider is initialized.

The following code example shows the element in the system.web section of the Web.config file for an ASP.NET application. It specifies the application's SqlMembershipProvider instance and enables password retrieval.

<membership defaultProvider="SqlProvider" userIsOnlineTimeWindow="20">
    <add name="SqlProvider"
      applicationName="MyApplication" />

.NET Framework
Available since 2.0
Return to top